Note: The SharePoint Online App needs an input parameter to generate your documents.
In dox42, input parameters allow you to specify one or more parameters before generating a document. In simple terms, this means that you create a query that is to be displayed before the document generation starts. This query helps you to control or customise the document generation process. It is mainly used to filter data, specify formats, or provide dynamic content at runtime.
For example, you could configure an input parameter called EnterID so that users can enter the ID of the training participant whose information should be included in the generated document.
In some cases, input parameters can also influence the structure of the data returned by an external service. Then, they control not only which data is retrieved but also how the external service provides that data to dox42.
Principles of input parameters
An input parameter mostly refers to a specific data source and is set up within the data map in the Data Map Designer.
A data map can contain several input parameters, relating to either a single data source or several.
The value of an input parameter can be provided by another data field, free text, or a JSON request body, depending on the data source.
An input parameter’s syntax varies depending on the data source.
You can configure an input parameter in the dox42 Add-In. An example is found in the sample template in your SharePoint App package folder SP_app_template.
Prerequisites
Steps overview
Add an input parameter to your data map and configure it.
In Microsoft Word, Excel or PowerPoint, go to the dox42 ribbon and select Data Map.
dox42 ribbon
The Data Map Designer window opens.
Data Map Designer window
Select Input Parameter.
Configure an input parameter and give it a name (e.g.
ItemID).
Input Parameter window
For testing your documents easier with the dox42 Word Add-In, enter a Default Value for example:
[ {"id": "1"}, {"id":"2"}]
Add an XML/JSON data source to your data map and configure it.
See also
Add an XML/JSON data source and call it JSON, for example. The JSON data source parses the ID, which is important for the SharePoint Online App:
Select Insert Data Field and select your created input parameter:
ItemID.
Adding a new XML/JSON data source
Go to the Initialisation & Fields tab.
In the Element text field, enter
ID.In the Table from the Read dropdown, select the Content entry.
In the Table in the Data Field Name text field, enter
ID.
XML/JSON Data Source window
Add a SharePoint data source to your data map and configure it.
See also
Add a SharePoint data source.
Adding a new SharePoint data source
Go to the Select Fields tab.
Select the Query button.
Configure the Query for your SharePoint data source.
SharePoint Query configuration
In the Filter Field, filter the ID with your previously created JSON.ID data field.
Use the provided template to test if everything is set up correctly after you have entered your Entra ID information and the site links in the Excel connection file.
Result
You have created an input parameter and configured an XML/JSON data source as well as a SharePoint data source. You can now generate your documents locally from within the add-in.
Next steps
Proceed with Integrating dox42 into SharePoint Online if you want to connect SharePoint Online to dox42 and want to generate your documents directly from SharePoint Online.