Creating an output configuration (ReturnAction)

Create an output configuration to control the way documents are created and processed. For instance, specify

• how dox42 should be called,

• in which file format your document(s) should be generated,

• where your document(s) should be stored.

Follow these instructions if you want to generate a single document and display a preview of the generated document directly on your Business Central client.

Note

If you want to generate multiple documents in bulk and save them to a specific location, see Create an output configuration (QueryString).

Prerequisites

• You have the dox42 Administrator role in Business Central (to set the role, go to the cogwheel at the top right of Business Central, select the My settings menu and then the dox42 Administrator role).

Steps

1. Log in to your D365 BC account.

2. In the Activities section, select the Output Configurations tile.

   

   The dox42 Output Configurations dialog opens.

3. Select the New button to add a new output configuration.

   

   The dox42 Output Configuration Card dialog opens.

   

4. Enter a descriptive Code name, e.g. “PREVIEW”, and a suitable Description for your new output configuration in the respective text fields.

5. From the Output Action dropdown menu, select the Output Action type that meets your needs. In order to generate a single document and display a preview of the generated document directly on your Business Central client, select the Return type (Return Action).

   Note

   • Business Central Online offers the following Output Actions:

     • Return

     • QueryString

     • Group

   • If you want to generate any other output, select the Query String type. In combination with the Service Designer, the Query String type allows you to create any output you want. See Create an output configuration (QueryString).

   • For information on other Output Actions, see the corresponding dox42 Server or dox42 Online documentation.

6. Enter a File Name and Folder Name for the output configuration. The names are composed by placeholders with the following meaning. Additional placeholders may be passed by other apps.

   Placeholders for File Name and Folder Name

   • %sysfilename%: Internal document specific filename, depending on the base record (formerly %5)

   • %ext%: The file extension (formerly %1)

   • %tsmin%: Timestamp with an accuracy of minutes in the format yyyyMMdd_hhmm (formerly %2)

   • %tssec%: Timestamp with an accuracy of seconds in the format yyyyMMdd_hhmmss (formerly %3)

   • %tsmil%: Timestamp with an accuracy of milliseconds in the format yyyyMMdd_hhmmssttt (formerly %4)

   • %userid%: The code of the current user

   • %company%: The name of the current company

7. From the File Extension dropdown menu, select the output format, e.g. PDF.

8. Use the arrow button at the top to exit the window.

Result

You have set up a new output configuration.

Next step

Relate a document to an output configuration