URL

The Service will use the entered URL when running. The URL input field can also be parameterized using {} notation. (This can be useful for instance in cases where organizational information is provided through a URL and where the information provided is based on organizational number. By adding the organizational number as a parameter {orgnr} in the URL, you can look up organizational information with an organizational number entered by a respondent.)

Method

Compose integration provides the following methods: GET, PUT, POST, DELETE. Note: For GET requests – based on the HTTP standard – using a request body is not supported.

Create

Pressing the Create button, creates a new request variable. When you have entered a name and pressed OK, the variable will appear in the list of variables. When a Request Variable has been created it is possible to enter a transformation script by pressing the Transformation script button for each variable. Note: The variable name can't e.g. start with a capital letter, contain white-space characters and must have a length of 1 to 40 characters.

Delete 

Request variables can be deleted by selecting the variable you wish to delete, then pressing Delete.

Modify

When a request variable is selected you may press Modify to view/edit the variable properties. See table below.

Name

This is a unique name of the request variable that will be accessible to the request script. 

Type

This can be either Data type variable type, File based data type variable, Form answer based or Option source variable. If you wish to send File information, e.g. file uploaded to a form, please select the File based data type variable. For more information about methods available for file data type validation script, check out https://composetogo.atlassian.net/wiki/spaces/CNGD/pages/1835174.

Validation

Choose a validation from the dropdown (except for Form answer based type variables). The validations differ based on chosen type.

Calculated

A request variable can be transformed through calculation. If Calculation is chosen it is mandatory to add a transformation script. For normal variables, it is not possible to use a transformation script based on other variables. You therefore have to use a calculated variable if you need to include other variables in your transformation script. Note: A calculated variable can only reference non-calculated variables in their transformation script.

Data format

Choose between XML, JSON and Binary to disclaim the format/language of the data model you’re retrieving information from.

Create

Pressing the Create button, creates a new response variable. When you have entered a name and pressed OK, the variable will appear in the list of variables. Note: The variable name can't e.g. start with a capital letter, contain white-space characters and must have a length of 1 to 40 characters.

Delete 

Created integration response variables can be deleted by selecting the variable you wish to delete, then pressing Delete.

Modify

When an request variable is selected you may press Modify to view/edit the variable properties. See table below.

Name

Unique name of the response variable that will be accessible to the generation script. 

Type

 This can be either Data type variable or Option source variable. Option source response variables are exclusively for populating options. For all other scenarios data type variables would be used (data type builder validations, form population etc).

Validation

This can be String, Integer, Decimal or Date. Changes in the data type have to correspond with the form question connected to the input variable.

Create 

Create a new request header.

Name

Enter a name for the request header. 

Value

If your integration integrates toward a private API or any register where authentication is necessary, this field will need to contain the authentication key.

Delete 

Remove a request header. 

Script

Enter the preferred script used for request variables.

Syntax highlight

Select the syntax highlight corresponding with the script you wish to enter. Your choices for syntax highlighting is Groovy, JSON, HTML, XML, Plain Text and YAML.

Validate

The script may be validated, to search for errors in the script. Script validation will give you feedback on whether the script passed or failed. An error message will help you find the errors, if your script failed. These errors need to be corrected to version the integration.

Name

Selected name will be displayed here

Type

Selected data type will be displayed here.

Expression

For each response variable you need to specify a XPath expression. Pay attention to the data types and that the XPath expression should not return an XML node, but a value.

Transformation

The response value can be transformed with a script in the script window accessible through the Transformation button. The response value is referred to as value. The script is influenced by whether there is an XPath expression or not. If not, value represents the entire XML response that we get from calling the URL. Otherwise value represents the specific part of the document which the expression maps to. Note: If the expression is left empty it would be possible to write a complicated script to do whatever you want and return the desired value from transformation scripts.