Adding a Schema to a REST Off-Ramp - EIS Workflow Messaging - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external - OnBase/EIS-Workflow-Messaging/Foundation-24.1/EIS-Workflow-Messaging/Configuration/Off-Ramps/REST-Off-Ramps/Editing-a-REST-Off-Ramp/General-Tab/Adding-a-Schema-to-a-REST-Off-Ramp - 2024-03-25

EIS Workflow Messaging
Platform
OnBase
Product
EIS Workflow Messaging
Release
Foundation 24.1
License

After you have created a REST off-ramp, you can add a message schema to the off-ramp from the General tab in the Properties pane. A message schema determines the structure of request or response messages communicated through the off-ramp.

You can add a schema in XSD or JSON format. Because the messages stored and processed in OnBase are in XML format, any JSON schemas are converted to XSD format.

To add a schema to an off-ramp:

  1. Select the off-ramp from the Integration Services tab of the Repositories pane.
  2. Select the General tab in the Properties pane.
  3. In the Schemas section, click Add. The Add Schema dialog box is displayed.
  4. Select one of the following formats from the Message Format drop-down list:

    • Select XML and browse to the location of the XSD file containing the message schema.

    • Select JSON and browse to the location of the JSON file containing the message schema. You must also enter the Root Node for a JSON schema. The Root Node value is limited to 249 or fewer characters.

  5. Click OK. The schema is added to the off-ramp.
  6. To view the schema for confirmation, select the schema and click the View XSD or View JSON button, depending on the schema format. For JSON schemas, you can view the original JSON format or the converted XSD format.