Editing a Project - 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 projects that already exist within OnBase Studio. To do so, follow these steps:

  1. Open OnBase Studio and connect to a repository.
  2. Select the Integration Services tab from within the Repositories panel. Existing projects are displayed beneath the search bar.
    Tip:

    You can limit the list of projects displayed by entering search criteria within the Find field and pressing Enter.

  3. Expand the EIS Message Broker node.
  4. Select the web project you want to edit.
    • If desired, you can modify the name of the project. To do so, follow these steps:

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

      2. Select the Rename option.

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

        Information about the selected project is displayed in the Properties pane on the right side of the window.

    • If desired, modify the following options:

    General

    Description

    Target namespace for message types

    Modify this field to change the namespace for the project. For example:

    http://9secondfoods.com/PurchaseOrder

    All message types under the selected project use the specified namespace.

    Deactivate all

    When this option is selected, all message types under this project are deactivated. When all message types are deactivated, subscribers will be prevented from dequeuing messages. Subscribers will still be able to respond to messages they've already dequeued, and new messages 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.

    Error Handling

    Description

    Retry Options

    The Retry Options control how OnBase reports system errors encountered during operation of the Message Broker. This type of error can occur when the intended consumer of a message is unavailable, such as when a destination ERP system is offline for maintenance.

    Retry Count: Enter the number of times Workflow should attempt to resend the message after a system error is encountered. If the specified number of tries is reached without successfully sending the message, the message becomes locked in OnBase and requires an administrator's attention to resolve.

    Timeout: Enter the number of minutes Workflow should wait before attempting to resend the message after a system error is encountered. No message consumer will be able to attempt to retrieve the message again until the timeout period has expired and Workflow resends the message.

    Report Error

    The Report Error options control how OnBase reports faults encountered during operation of the Message Broker. Faults can be generated from the response to a dequeued message or by the Application Server's background process monitoring the Message Broker. The following options are available:

    None: when this option is selected, errors are not reported.

    Run Unity Script: select this option to execute a Unity Script on the returned error. Only Unity Scripts created using the IEISMessageBrokerOnMessageFaultScript type are available for selection.

    Create an Error Document: select this option to save the generated error report in a specific Document Type. The error report is saved into the selected Document Type as a text file. The selected Document Type may have the Exception Reason and Description system Keyword Types assigned to it.

    Send Queue Monitoring Options

    The Send Queue Monitoring Options control when OnBase generates a fault after a timeout is reached. The following options are available:

    Unsent Message Timeout: Enter the number of minutes after which OnBase will generate a fault if no subscriber has attempted to retrieve a message.

    Inprogress Message Timeout: Enter the number of minutes after which OnBase will generate a fault if a message has been in progress.

    Pending Complete Message Timeout: Enter the number of minutes after which OnBase will generate a fault if a message has not been completed by Workflow.

    Maintenance

    Description

    Archive Record

    The Archive Record options control when messages are archived in the database. Archiving messages improves the performance of the database.

    After Success: Select this option to immediately archive a message after the message is completed.

    Days After Success: Select this option to archive messages a specified number of days after the message is completed. Enter a number into the available field to configure the number of days to wait before archiving the message.

    Delete Message Content

    The Delete Message Content options control if and when to delete the actual content of the message and the response. Even if message content is deleted, a record is maintained in the database that includes basic information about the message, such as the date and time that the message was sent.

    Never: Select this option to leave message content undeleted in the database.

    After Success: Select this option to delete the message content from a message after OnBase has retrieved a response from the LOB system.

    Days After Success: Select this option to delete the message content from a message after a specified number of days. Enter a number into the available field to configure the number of days to wait before deleting the message.

    Purge Record

    The Purge Record options control if and when to purge archived messages from the database. Only archived messages can be purged. When a message is purged, the content of the message is deleted along with the record of the message.

    Never: Select this option to leave all archived messages in the database.

    Days After Success: Select this option to purge archived messages from the database after a specified number of days. Enter a number into the available field to configure the number of days to wait before deleting the message.