Add a message destination

Procedure

  1. Open the Messaging editor.
  2. Select a message environment configuration.
  3. Above the left pane list of message destinations, click Add Destination .
  4. Fill in the following required fields.

    ID

    The destination ID as an integer value. The valid range for custom destination IDs is 0 through 63, inclusive. Guidewire reserves all other destination IDs for built-in destinations such as the email transport destination. Studio marks these internal values with a gray background, indicating that they are not editable. Studio also marks valid entries with a white background and invalid entries with a red background.

    Name

    Required. The name to use for the messaging destination.

    Transport Plugin

    Required. The name of the MessageTransport plugin implementation that knows how to send messages for the messaging destination. A destination must define a message transport plugin that sends a Message object over a physical or abstract transport. For example, the plugin might do one of the following.

    • Submit the message to a message queue.
    • Call a remote web service API and get an immediate response that the system handled the message.
    • Implement a proprietary protocol that is specific to a remote system.

    Each messaging destination must specify its own unique implementation of a MessageTransport plugin. A particular MessageTransport plugin cannot be assigned to multiple destinations.

    Note: A messaging plugin must be registered in the plugin registry maintained by the Plugin editor. The plugin is subsequently referenced in the Messaging editor when configuring a messaging destination.