To each document record, add the data fields which values must be exchanged. For external file-based documents, set up the fields in line with naming in the file.

For JSON documents, fields are always of type string, to enable type conversions.

This topic explains how to add record fields to a JSON document.

If fields are already initialized for the document, selected for the record, or copied to the record, you can review and complete the setup for these fields. To do so, skip step 6.


Standard procedure

1. Click Connectivity studio Integration Design.
2. Click the Documents tab.
3. In the list, find and select the desired JSON document.
4. Click Edit.
5. In the Records section, in the Record list, find and select the desired record.
6. On the Fields tab, click New.
7. As a field name, enter a free-definable name. Usually, this is the name used in the external file.
  In the Field name field, type a value.
 

Note: The value of this field cannot have spaces.

8. As a record table, enter a free-definable name. Usually, this is the name used in the external file.
The value, as entered in the Field name field, is the default value. You can change this value.
  In the Record table field field, type a value.
 

Note: The value of this field cannot have spaces.

9. Indicate if the field is a key field for the record.
  Select the Key field check box.
10. Indicate if the field is mandatory to be filled. If on processing the document, the field has no value and Mandatory is set to:
- Yes, an error is given, and the document is not processed.
- Warning, a warning message is given, but the document is processed.
- No, the document is processed.
  In the Mandatory field, select an option.
11. Set the field length carefully. Make sure, the number of characters is sufficient to contain the value. If you set the length too short, you will use value characters.
  In the Length field, enter a number.
12. Select the data type of the field to define the way the data is handled on read or write.
  In the Field type field, select an option.
13. On write, if the field has no value, the field is not written to the JSON file. So, there's no reference to the field in the file at all.
  Select the Skip empty check box.
14. If the maximum number of objects in an array is known, you can add several fields that each refer to a different object in the same array. You add the same number of fields as the number of objects in the array. For the document record field, the:
- Record table field refers to the array. So, enter the array name.
- Field name must refer to a specific object in the array. So, enter the array name and between brackets the object index number. Example: Contacts[1].
- Select the Array check box.
  Select the Array check box.
15. Sub-task: Set external references for record.
  15.1 In the Line details section, set the external references for the record.
You can indicate which of the records fields contains the unique ID of the record in the external database. In this way, you link the external ID to the record ID.
  In the External reference field, enter or select a value.
 

Note: Usually, you only use this for an ODBC connection with CRM or if you use web services.

  15.2 You can indicate which of the records fields contains the revision of the record in the external database. In this way, you find and link the latest revision to the record ID.
  In the Revision field field, enter or select a value.
 

Note: You can only use this field in combination with the External reference field.

16. Close the page.
Related to Notes

Set up JSON document

 

Provide feedback