Service profile for DigEplan markup data pull

The service profile is used to call the DigEplan API.

To create a service profile in Operations and Regulations, select System > Service > Create Service Profile.

See the Infor Operations and Regulations Agency Personalization Administration Guide for complete instructions.

Create the service profile

When you create your service profile, specify these values in the fields at the top of the Create Service Profile page:

  • Service Profile Name: Specify a name for the service profile, such as DigEplanMarkups.
  • Format: Select Json.
  • Host Address: Specify your DigEplan API endpoint URL.
  • Request Method: Select Post.
  • Time Out: Specify the timeout period for the service profile, such as 30 seconds.
  • Enabled: Select this check box to enable the service profile.

Authentication headers

When you create your service profile, add three headers to the Headers grid in the Create Service Profile page.

First header:

  • Name: X-PAT-TOKEN
  • Value: Your DigEplan PAT token

Second header:

  • Name: X-CUSTOMER-NAME
  • Value: Your DigEplan customer name

Thrird header:

  • Name: X-PRODUCT-NAME
  • Value: Your DigEplan product name

Request body

In the Contents section of the Create Service Profile page, paste this JSON:

{
  "folderIds": ["{{folderId}}"],
  "correctionsRequired": false,
  "includeDeleted": false,
  "includeResponses": false
}
Note: The {{folderId}} is a template variable that will be replaced by the formula at runtime.

Response mapping

In the Response Mapping grid on the Create Service Profile page, specify the response mappings for the service profile.

A response mapping takes either a hard-coded value or a property from the response to the API request and maps it to a destination. The destination is not any particular property in Operations and Regulations, it is simply the name that you want to use for this value when processing the response.

Use JSONPath syntax for the source. Adjust the source paths to match your DigEplan custom field names. The destination names are used in the formula to retrieve the values.

This table shows some sample response mappings:

Source Destination
$.items[1].custom.AreaUsageType AreaUsageType
$.items[1].custom.AreaUsageTaxCalc AreaUsageTaxCalc
$.items[1].custom.AreaUsageTax AreaUsageTax