Creating a Message Type - EIS Message Broker - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Premier - Standard - external - Standard - Premier

EIS Message Broker

EIS Message Broker
Foundation 23.1

Message Types control how messages are serialized and sent to the third-party application, such as which Keyword Types or WorkView Attributes are included in the generated message. To configure a message type, follow these steps:

  1. Open the OnBase Studio application and connect to the appropriate repository.
  2. Open the Integration Services tab and click the Message Broker Type button in the ribbon. The Create New Message Type: Project Details dialog is displayed.
  3. Perform one of the following actions:
    • Select an existing Project from the Project drop-down list

    • Create a new project using the following fields:

      • Name: Enter the friendly name for the Project. This value must be unique. This is the name that will be displayed when selecting the Project from the Project drop-down list.

      • Target namespace for the message types: Enter the namespace for the new project. This namespace is used to uniquely identify messages with the appropriate message type. This value must be unique. For example:

  4. Click Next. The Message Type Details dialog is displayed.
  5. Enter the following values for your Message Types:
    • Name: Enter the name of the Message Type. The specified name will be used to display the Message Type within OnBase Studio.

    • XML Compatible Name (follows XML validation rules): Enter the XML-compatible name for the Message Type. This name cannot be identical to an existing XML Compatible Name used by another Message Type.

    • OnBase Object Type: Select the type of OnBase object used to generate the message.

    • Message Format: Select the format to be used when the message is serialized.


      If HIS Workflow XML Messaging is selected as the OnBase Object Type, only the XML message format is available.

    • Type Code: Enter the Type Code for the Message Type. This must be a unique value. This code is used by the line-of-business application to subscribe to the desired Message Type.

  6. Click Next. Depending on the OnBase Object Type you have selected, you may be required to specify additional information. See the appropriate subsection for the operation you selected to continue configuration: