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

EIS Message Broker

Platform
OnBase
Product
EIS Message Broker
Release
Foundation 23.1
License
Standard
Premier

You can edit Message Types that already exist within OnBase Studio. To do so, follow these steps:

  1. Expand a web project by clicking on the arrow to the left of the project's name in the Repositories pane.
    A list of available Message Types is displayed.
  2. Select the Message Type you want to edit.
    • If desired, you can modify the name of the Message Type. To do so, follow these steps:

      1. Right-click on the name of the Message Type within the Repositories panel.

      2. Select the Rename option.

      3. Modify the name of the Message Type as desired, then press the Enter key.

        Information about the selected Message Type is displayed in the Properties pane.

    • If desired, modify the following options:

      General

      Description

      XML Compatible Name

      Enter the root node of the xml message in this field. This name must be XML-compatible.

      Message Type Code

      Enter a unique identifier for the message type in this field. This value is used by the LOB system to request messages of this message type.

      CAUTION:

      This setting must be unique across all messages types used by your OnBase system.

      Selected _

      This read-only field displays the OnBase Object Type used by the selected Message Type (for example, a Document Type or WorkView class).

      Message Format

      This option controls the format the message is sent in. The following values are available:

      Xml: select this option to send the message in XML.

      Json: select this option to send the message in JSON.

      Note:

      If you change the message format to JSON, any configured values specific to XML format (such as the values in the Send, Receive, and Mappings tabs) are deleted.

      View Message Schema

      Click this button to generate and display the XSD.

      The XSD Message Schema controls how the selected message is structured and formatted when sent to the LOB system.

      Note:

      This option is only displayed when the Xml option is selected.

    • If desired, you can modify the fields used by your Message Type by clicking Edit. After doing so, the Edit Fields dialog box is displayed.

      1. Deselect the Include option to remove a field from the selected Message Type.

        Tip:

        You can select and deselect the Include/Exclude all option to select or deselect all available fields.

      2. Select the Required option for any fields you want to be required for your Message Type. If any Required fields are not present on a message, that message cannot be published.

      3. All available fields will automatically have an XML-compatible name generated. You can change this name if desired by selecting a field and then modifying the Edit Canonical Name field and clicking Set.

        The value entered in this field will be truncated to 120 characters when saved to the database.

        Note:

        All canonical names must be unique. You cannot modify a field to use the same canonical name that is used by another field.

      4. Click Apply to save your changes.

  3. Select the Send Pipeline tab to configure any required transformation or enrichment of the XML message to be sent. This tab is organized following the flow of a message through Message Broker. All steps in the message pipeline are optional. The message flows through the pipeline and can be modified at each step; this includes an XSLT transformation preceded and followed by optional Unity Script enrichment.
    XSLT transformation is used to modify the structure of the XML message, such as converting from the OnBase default schema to an LOB specific schema.
    Unity Scripts can also be used to modify the structure of the XML message, but they are mainly used to modify the data itself (such as by converting OnBase Keyword Values to values the LOB accepts).
    If desired, modify the following options:

    Send Pipeline Option

    Description

    Pre-transformation enrichment

    Select a Unity Script from the Unity Script drop-down list in order to execute the selected Unity Script every time a message is published before the message is transformed. Only Unity Scripts created using the IEISMessageBrokerEnrichmentScript type are available for selection.

    The Unity Script takes the message as the input parameter for the script. After the Unity Script has been executed, the message is saved to the OnBase database.

    Note:

    This option is only displayed when the Xml option is selected.

    Transformation

    The Transformation options control how the Message Broker transforms messages to be sent to the LOB application.

    XSD: Enter the XSD format that sent messages should be formatted as for retrieval by the LOB system. If an XSD format is used, you must also enter the XSLT format into the XSLT field.

    • Browse: Select this button to browse to the desired XSD file.

      Note:

      The selected XSD is not saved to the database or used by the message type until the repository has been saved.

    • View: Select this button to view the XSD currently stored in the database.

    • Reset: Select this button to clear the selected XSD.

    • Delete: Select this button to delete the saved XSD from the repository.

    XSLT: Enter the XSLT format that controls the transformation from the OnBase schema to the XSD schema. If an XSLT format is used, you must also enter the XSD format into the XSD field.

    • Browse: Select this button to browse to the desired XSLT file.

      Note:

      The selected XSLT is not saved to the database or used by the message type until the repository has been saved.

    • View: Select this button to view the XSLT currently stored in the database.

    • Reset: Select this button to clear the selected XSLT.

    • Delete: Select this button to delete the saved XSLT from the repository.

    Note:

    These options are only displayed when the Xml option is selected.

    Post-transformation enrichment

    Select a Unity Script from the Unity Script drop-down list in order to execute the selected Unity Script every time a message is published after the message is transformed. Only Unity Scripts created using the IEISMessageBrokerEnrichmentScript type are available for selection.

    The Unity Script takes the message as the input parameter for the script. After the Unity Script has been executed, the message is saved to the OnBase database.

    Note:

    This option is only displayed when the Xml option is selected.

  4. Select the Receive Pipeline tab to configure any required transformation or enrichment of the XML message received from the LOB application. This tab is organized following the flow of the reply message through Message Broker. All steps in the message pipeline are optional, but the LOB XSD must be configured if mapping is required. The LOB XSD specifies the structure of the XML in the reply message that the LOB will send back to the Message Broker. The message flows through the pipeline and can be modified at each step; this includes an XSLT transformation preceded and followed by optional Unity Script enrichment.
    XSLT transformation is used to modify the structure of the XML, such as by converting from the LOB schema to a custom schema.
    Unity Scripts can also be used to modify the structure of the XML, but they are mainly used to modify the data itself (such as by converting LOB values to OnBase Keyword Values or WorkView attributes that OnBase accepts).
    If desired, modify the following options:

    Receive Pipeline Option

    Description

    LOB message format

    LOB XSD: Enter the XSD used by the LOB application to generate response messages if no transformation is required.

    Browse: Select this button to browse to the desired XSD file.

    Note:

    The selected XSD is not saved to the database or used by the message type until the repository has been saved.

    • View: Select this button to view the XSD currently stored in the database.

    • Reset: Select this button to clear the selected XSD.

    • Delete: Select this button to delete the saved XSD from the repository.

    Note:

    These options are only displayed when the Xml option is selected.

    Note:

    If you must delete or change the XSD file, you must also recreate any configured mappings.

    Pre-transformation enrichment

    Select a Unity Script from the Unity Script drop-down list in order to execute the selected Unity Script every time a response is received from the LOB system before the message is transformed. Only Unity Scripts created using the IEISMessageBrokerEnrichmentScript type are available for selection.

    The Unity Script takes the response message as the input parameter for the script. After the Unity Script has been executed, the response message is saved to the OnBase database.

    Note:

    This option is only displayed when the Xml option is selected.

    Transformation

    The Transformation options control how the Message Broker transforms messages received from the LOB application.

    XSLT: Enter the XSLT format that controls the transformation from the OnBase schema to the XSLT schema. If an XSLT format is used, you must also enter the XSD format into the XSD field.

    • Browse: Select this button to browse to the desired XSLT file.

      Note:

      The selected XSLT is not saved to the database or used by the message type until the repository has been saved.

    • View: Select this button to view the XSLT currently stored in the database.

    • Reset: Select this button to clear the selected XSLT.

    • Delete: Select this button to delete the saved XSLT from the repository.

    Transformed XSD: Enter the XSD format that received messages should be formatted as after being retrieved by OnBase. If an XSD format is used, you must also enter the XSLT format into the XSLT field.

    • Browse: Select this button to browse to the desired XSD file.

      Note:

      The selected XSD is not saved to the database or used by the message type until the repository has been saved.

    • View: Select this button to view the XSD currently stored in the database.

    • Reset: Select this button to clear the selected XSD.

    • Delete: Select this button to delete the saved XSD from the repository.

    Note:

    These options are only displayed when the Xml option is selected.

    Note:

    If you must delete or change the configured XSD or XSLT file, you must also recreate any configured mappings.

    Post-transformation enrichment

    Select a Unity Script from the Unity Script drop-down list in order to execute the selected Unity Script every time a response is received from the LOB system after the message is transformed. Only Unity Scripts created using the IEISMessageBrokerEnrichmentScript type are available for selection.

    The Unity Script takes the response message as the input parameter for the script. After the Unity Script has been executed, the response message is saved to the OnBase database.

    Note:

    This option is only displayed when the Xml option is selected.

  5. Select the Receive as Message Item tab to configure an XML message item type to be used as the response format for this message type.

    Receive as Message Item Option

    Description

    Response Message Item Type

    Select a configured XML message item type to be used as the response type for the message type from the Response Message Item Type drop-down list.

    Note:

    Only XML message item type formats are available for selection.

  6. Select the Mappings tab to map elements to OnBase objects. Mappings allow for the creation of a set of rules for copying data in a reply message from the LOB to the OnBase object in Workflow, including document Keyword Types and WorkView attributes. The Receive Format of the map is determined by the last XSD format specified in the Receive Pipeline tab's pipeline: either the LOB XSD or the Transformed XSD.
    1. Click Add. The Mapping dialog box is displayed.
    2. Enter a name for the map in the Map Name field.
    3. Select an element from the XSD file.
    4. Select one of the following options:
      • None: select this option if you do not want to map the selected element to any OnBase object. This option is selected by default.

      • Property: select this option to map the selected value to a Workflow property from the persistent property bag. Type the name of the desired property in the available field.

      • Keyword: select this option to map the selected value to an OnBase Keyword Type. Select the desired Keyword Type from the available drop-down list.

      • WorkView: select this option to map the selected value to a WorkView attribute. Select the desired attribute from the available drop-down list.

      Note:

      Elements in WorkView-based message types can only be mapped to attributes belonging to the message type's primary WorkView class.

    5. Click Map. The selected XSD element is mapped to the selected OnBase object.
    6. Once you have finished mapping all desired elements, click OK.
  7. Select the User Groups tab to configure the OnBase User Groups that should have permission to dequeue messages of the selected message type.
    To add or remove User Groups, follow these steps:
    1. Click Add. The User Groups dialogue is displayed.
    2. Select all User Groups to be added to the message type, and deselect all User Groups that should not have permission to dequeue messages of this message type.
    3. Click OK.
  8. Select the Advanced tab to configure whether or not a Message Type should be deactivated.

    Advanced Options

    Description

    System

    Select the Deactivate option to deactivate the selected message type. Once the message type is deactivated, subscribers will be prevented from dequeuing messages of the selected message type. Subscribers will still be able to respond to messages they've already dequeued, and new messages of the selected message type can still be published.

    Message types should be deactivated whenever you need to make changes to that message type. After deactivating the message type, use the administration console to ensure that there are no more messages of that message type in progress before making changes.

  9. Once you have made all required changes to a message type, click the Save button in the Repository section of the ribbon to save your changes.