Creating/Integrating/Triggering the data profile

Source structure of the data profile


  • Select the document type "JSON".

  • Select the Input Agent "Manual upload".


When you create the data profile, its source structure must be basically the same as the source structure of the form profile (same hierarchical structure). It must contain the same node that has the data profile assigned (here " order" ), but not all fields and all subnodes must be used. However, the names of the used fields and subnodes must be identical (case-sensitive) . Suffixes " #xxx" are ignored, so " order_number#2" , for example, would also be a valid node name.


images/download/attachments/137300231/14-version-1-modificationdate-1733119268278-api-v2.png


The data coming from the form first ends up in the form profile (as a JSON file), i.e. in our " order" node and everything below it. This data is forwarded 1:1 to the data profile (also as a JSON file).

Target structure of the data profile


In the target structure of the data profile, the same rules apply as described for the source structure. However, there are two small differences . The node containing the data must always be named " data" and must have the value " 1" in node attribute " Maximum" .


images/download/attachments/137300231/15-version-1-modificationdate-1733119268280-api-v2.png


The data of the target structure of the data profile ends up back in the form profile (as a JSON file) in our order node and everything below it and thus ultimately in the form page. So in the end, the whole mechanism is just the exchange of the JSON data of a certain node. This is the reason, the identical hierarchical structure and the identical names of the fields and nodes are necessary.


  • Select the Integration Unit "ExtendedJsonCreationUnit". You can use the default settings.

  • Create a Response of type "Custom Class" with class "PassBackDataResponse" and set the content to "Output of IU". This class returns the data to the form profile.

  • Set the data profile active and save it. Only this way it can be selected in the form profile later and return data!

Including data profile in form profile and triggering


  • The data profile must be assigned to a source structure node (here order) in the form profile via attribute "Data profile" . The data profile can only be selected if it is active and correctly built (→ see examples).

  • There are two ways to start a data profile in the form (→ see examples).

    • Via a source structure field whose attribute "Portal control" has the value "_submitButton_". The field is then converted into a send button in the form.

    • Via a source structure field whose attribute "Data event" has one of the values "On change", "Initial" or "Initial & on change". You can set the input delay in the "Portal" Input Agent, which determines how fast the entered value is transferred.

Incoming and outgoing data


During the development phase it can be interesting to see which data really goes into the data profile and back to the form profile 'under the hood'. You have the following options to view this data in the Control Center (→ see examples).


  • You can see the JSON input data in the job created for the data profile if you activate the trace messages in phase 1 of the profile logging for the data profile .

  • If you want to view the JSON output data sent back from the data profile to the form profile, you can create an additional Response of type "File" with set checkbox "Is backup of target data" in the data profile. Set the content to "Output of IU".