Adding dox42 template configurations to Microsoft Dynamics CRM or D365 CE

There are two options for adding template server configurations to Microsoft Dynamics CRM or D365 CE.

Option 1: Adding a dox42 template configuration via the dox42 model driven app

Steps

1. Open your D365 CE or Dynamics CRM.

2. Select dox42 Template Configurations.

3. Enter a value in the Name text field depending on your integration scenario:

   • When using integration option 1: the name of the template configuration has to match the name you will use in the Power Apps button command.

   • When using integration option 2 (dox42 pop-up):  the name you put here, is the name that will be displayed for this template in the dox42 pop-up.

4. Select the New button.
   

5. Choose a service from the Service dropdown.

6. Enter a value in the Template Url text field.
   The template location is build out of the service connection (Template base url) and the Template Url of the template configuration. These two values are concatenated. If you are generating Excel spreadsheets, please specify the path of the data map.

7. From the Http Method menu, choose which method your dox42 call should use:

   • POST: If you generate a document from a list with several IDs or when using the dox42 pop-up and a Requestbody as input parameter.

   • Auto: ensures that whenever you pass a list of Ids, the request method will be POST, otherwise GET is used automatically.

   • GET

8. From the Operation menu, choose which operation your dox42 call should use:

   • Generate Document: for Word templates.

   • Generate Slides: for PowerPoint templates.

   • Generate SpreadSheet: for Excel templates.

9. In the Additional Query String text field enter your defined query string for your dox42 Output actions.

   Example: If you want to return your document as PDF, the Additonal Query string looks like this: ReturnAction.Format=pdf.

   Note

   Find all dox42 parameters in the dox42 Server documentation.

   For more information on attaching documents as an annotation to an entity, see Output Action CRMOutputAction.

   Use the dox42 Server Designer for an easy set-up of the query string.

10. When working with the dox42 integration option 2 (dox42  pop-up):

    1. From the Primary entity, choose in which entity the template should be displayed.

    2. From the Language menu, choose the template’s language.

       Note

       The Language parameter serves as a categorizer for your dox42 pop-up. If you select English here, then this template configuration will be shown when you select EN in the popup, if you selected DE it will be shown alongside all DE templates in your popup. You can add further languages within the dox42 D365 CE | Dataverse solution (Advanced Settings > solutions> dox42 client libraries > languages).

    3. From the Output types menu, choose one or more document types for the output.

       Note

       If you use the “Output Types” to dynamically choose the format the document should be generated as from your pop-up, you will need to specify your input parameter in your dox42 template as RequestBody and include format as one parameter (See Setting up the RequestBody input parameter for the dox42 pop-up web resource). In this case, the additional query string needs to have dynamic values for the format. Example: ReturnAction.Format=<%parameters.format%>

    4. and other formats.

       

11. Select the Save button.

Result

You have added a dox42 template configuration via the dox42 model driven app.

Option 2: Adding a dox42 template configuration via the dox42 custom entities (for Dynamics CRM on-prem)

Steps

1. Open your D365 CE or Dynamics CRM.

2. Go to Settings > Extensions.

3. Select the dox42 Template Configuration entity.

   

   The Active dox42 Template Configuration page opens.

4. Select the New button.

   

5. Enter a value in the Name text field depending on your integration scenario:

   • When using integration option 1: the name of the template configuration has to match the name you will use in the ribbon workbench button command action.

   • When using integration option 2 (dox42 pop-up):  the name you put here, is the name that will be displayed for this template in the dox42 pop-up.

6. Choose a service from the Service menu.

7. Enter a value in the Template Url text field.
   The template location is build out of the service connection (Template base url) and the Template Url of the template configuration. These two values are concatenated. If you are generating Excel spreadsheets, please specify the path of the data map.

8. From the Http Method menu, choose which method your dox42 call should use:

   • POST: If you generate a document from a list with several IDs or when using the dox42 pop-up and a RequestBody as input parameter.

   • Auto: ensures that whenever you pass a list of Ids, the request method will be POST, otherwise GET is used automatically.

   • GET

9. From the Operation menu, choose which operation your dox42 call should use:

   • Generate Document: for Word templates.

   • Generate Slides: for PowerPoint templates.

   • Generate SpreadSheet: for Excel templates.

10. In the Additional Query String text field enter your defined query string for your dox42 Output actions.

11. Example:If you want to return your document as PDF, the Additonal Query string looks like this: ReturnAction.Format=pdf

    Note

    Find all dox42 parameters in the dox42 Server documentation.

    For more information on attaching documents as an annotation to an entity, see Output Action CRMOutputAction.

    Use the dox42 Server Designer for an easy set-up of the query string.

    

12. When working with the dox42 integration option 2 (pop-up):

    1. Enter the primary entity.

    2. Select a language

    3. and other parameters.

13. Select the Save button.

Result

You have added a dox42 template configuration via the dox42 custom entities.