Reference Data

Application Integration - Software AG Hosted Environment : Integration Cloud : Develop : Reference Data

Reference Data

Reference data is data that defines the set of permissible values to be used by other data fields. It is a collection of key-value pairs, which can be used to determine the value of a data field based on the value of another data field. For example, the value of a status field in an Application can be “Canceled” and that needs to be interpreted as “CN” in another Application.

Integration Cloud allows you to upload Reference Data from a text file containing tabular data separated by a character, for example, a comma, semicolon, and so on. The uploaded file should not have an empty column heading or space in the first row, and the first row cannot be empty.

Note:

Users who have the required access privileges under Settings > Access Profiles > Administrative Permissions > Functional Controls > Reference Data can create, update, or delete a Reference Data.

The Reference Data block appears under Services in the Orchestrated Integration workspace, only after you have created a Reference Data. See Reference Data Signature for information on the Input and Output parameters. The Reference Data is also available in Point-to-Point Integrations while transforming data. You can access the uploaded Reference Data in Orchestrated Integrations as a list of documents by using the Reference Data block and providing an appropriate name. You can filter the documents returned into the pipeline by the Reference Data block.

Note:

See this video on how to upload Reference Data, access the uploaded Reference Data in an Orchestrated Integration, and view the input and output parameters.

To add or edit a Reference Data

1. From the Integration Cloud navigation bar, click Develop > Reference Data. The Reference Data screen appears.

2. To edit an existing Reference Data, select a Reference Data from the Reference Data screen and click Edit.

3. To create a new Reference Data, from the Reference Data screen, click Add New Reference Data.

4. Provide a name and description of your Reference Data. Required fields are marked with an asterisk on the screen.

5. Click Browse and select the file. Only a text file having tabular data is supported. The maximum file size you can upload is 1 MB. Further, the file should not have an empty column heading or space in the first row and the first row cannot be empty. This is because the first row of data is read as column headings.

6. Click Next to define and preview the Reference Data. Select the field separator and the text qualifier.

7. Determine the encoding of the Reference Data file and from the File Encoding drop down list, select the same encoding. Click Load Preview to preview the data. If you select an incorrect encoding, garbage characters will appear in the preview pane.

8. Click Next to review the Reference Data, and then click Finish to create the Reference Data.

The new Reference Data appears in the Reference Data page.

Note:

The Reference Data block will appear under Services only after you have created a Reference Data and the Reference Data service will be available while creating an Orchestrated Integration. The Reference Data is also available in Point-to-Point Integrations while transforming data. If a Reference Data is used by an Integration, you will not be able to delete the Reference Data.