Creating an External AutoFill Keyword Set On-Ramp - EIS Workflow Messaging - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external - OnBase/EIS-Workflow-Messaging/Foundation-24.1/EIS-Workflow-Messaging/Configuration/On-Ramps/External-AutoFill-Keyword-Set-On-Ramps/Creating-an-External-AutoFill-Keyword-Set-On-Ramp - 2024-03-25

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

The process of creating an on-ramp for an External AutoFill Keyword Set creates the following configuration objects:

  • An on-ramp that handles two-way communication (sending and receiving messages) between OnBase and an external data source.

  • A Workflow system event that processes the on-ramp's communication in Workflow.

  • A message item type that defines the structure of the message items containing Keyword Value data.

To create an External AutoFill Keyword Set on-ramp:

  1. Connect to the appropriate repository in OnBase Studio.
  2. Right-click the HIS On-Ramp node in the Integration Services tab of the Repositories pane, then select New | External AutoFill Keyword On-Ramp. The Create On-Ramp wizard is displayed.
    Note:

    The Select AutoFill Keyword Set list includes only AutoFill Keyword Sets that have been configured to use an external data source.

  3. Select the AutoFill Keyword Set to use with the on-ramp and click Next. The On-Ramp Details page is displayed.
    All fields are automatically populated with values based on the name of the AutoFill Keyword Set.
  4. If you do not want to use the populated values, modify any of the following fields:

    Field

    Description

    On-Ramp Name

    The name of the on-ramp.

    By default, this value is the name of the AutoFill Keyword Set.

    Workflow System Event Name

    The name of the Workflow system event to be created with the on-ramp.

    By default, this value is the name of the AutoFill Keyword Set prefixed with SYSEvent_.

    Message Item Type Name

    The name of the message item type to be created with the on-ramp.

    By default, this value is the name of the AutoFill Keyword Set prefixed with AutofillKeyset_.

    XML Compatible Name (follows XML validation rules)

    An XML-compatible name for the message item type to be created with the on-ramp.

    By default, this value is an XML-compatible version of the name of the AutoFill Keyword Set prefixed with AutofillKeyset_.

    Any characters from the original AutoFill Keyword Set name that are not allowed by XML are automatically converted to allowable characters.
  5. Click Next. The User Groups page is displayed.
  6. Select a User Group from the drop-down list and click Add to give that User Group permission to access to the message item type to be created with the on-ramp.
    To remove a configured User Group from the list, select the User Group from the list and click Remove.
  7. Click Next. The summary page is displayed.
  8. Review the summary and click Finish.