Subscription group fields

A subscription group establishes the relationship between the application and adapter, and is the key entity for message distribution.

  • Subscription Name: Identifier or name of the subscription group.
  • Division: Transportation Manager division code.
  • Application Name: Name of the application configured in the Applications list.
  • Description: Description of the application name.
  • Adapter Name: Name of the adapter configured in the Adapters list.
  • Initialization String: Initialization parameters passed to the adapter. These differ depending on the adapter being used. However, in all cases, the following rules apply:
    • All names use forward slashes (/) only.
    • All names are case sensitive.
    • All names start with ./EN_OUT/. This places all files or folders under the TM folder, $TM_HOME/EN_OUT/).
    • The /EN_OUT subtree must have adapter and subscription specific folders or files.

      • For example:

      • Flat File adapter: The path to the file directory where the XML files are written; for example, /EN_OUT/FLATFILE.
      • EDI Email adapter: For EDI, the path to the file directory where the XML files are written; for example, /EN_OUT/EDI. (For Email, leave the initialization parameter blank).
      • CIS Flat File adapter: The path to the file directory where the XML files are written; for example, /EN_OUT/CIS.

      Note: When configuring multiple NEN adapters, ensure that each NEN adapter is configured to use different file directories.

  • Carriers: Specific list of carriers that need to receive event notifications.

    • Note: If specified, notifications will only be sent to these carriers.

  • Exclude Carriers: Selecting this check box will allow event notifications to be sent to all carriers except for those specified in the Carriers field.
  • Exclude Confidential Information: Excludes the selected confidential information from event notifications. Based on the Notify Event Notification (NEN) adapter setting the NotifyEventNotificationConfidentialAttributes-XXXX.xml is generated in the \\TMBUILD\properties\cisnen\ folder. Where XXXX is the name of the adapter. This xml file contains confidentiality information and is filtered from the event xml files based on the following settings of the subscription group:
    • All: Attributes included in the following tags will be filtered from the event xml files:

      • <confidentialityType name="FIN" id="2">

      <confidentialityType name="CONTRACT" id="3">

      <confidentialityType name="SHIPMENT" id="4">

      <confidentialityType name="SHIPMENT_AND_FIN" id="10">

    • Financial: Attributes included in the following tags will be filtered from the event xml files:

      • <confidentialityType name="FIN" id="2">

      <confidentialityType name="SHIPMENT_AND_FIN" id="10">

    • Financial and Contractual: Attributes included in the following tags will be filtered from the event xml files:

      • <confidentialityType name="FIN" id="2

      <confidentialityType name="CONTRACT" id="3">

    • None: None of the attributes are filtered from the event xml files.
    • Shipment Contents: Attributes included in the following tags will be filtered from the event xml files:

      • <confidentialityType name="SHIPMENT" id="4">

      <confidentialityType name="SHIPMENT_AND_FIN" id="10">

      Note: Confidentiality filtering works only for CIS Flat File adapter.

  • Transform Message: Specifies whether the even notification server converts the date/time values to the destination timezone in the event notification output. When unselected, the date and time values will not be converted and remain in the default application timezone.

    For example:

    When Transform Message is unselected, dates and/or times in the message sent out are equal to the values generated by the TM Event Notification Server.

    When Transform Message is selected:

    • For dates or times that are expressed in the system time for the TM instance, the date or time is adjusted by the SystemTimeZoneOffset. For example, if a date or time is 2011-10-15T12:00 and the SystemTimeZoneOffset is -5.00, the date or time in the formatted messages is 2011-10-15T17:00.
    • For dates or times that are expressed in the context of a specific shipping location, the date or time is adjusted by both the SystemTimeZoneOffset and the location's offset (for example, OriginShippingLocationTimeZoneOffset). For example, if a date or time is 2011-10-16T08:00, the SystemTimeZoneOffset is -5.00, and the OriginShippingLocationTimeZoneOffset is -3.00, the date or time in the formatted messages is 2011-10-16T16:00

  • Message Destination: Name of the configured Queue/Topic of the messaging system to which an event notification will be delivered. This field is applicable only when the Application Configuration Settings are configured with necessary JMS details.

    The support format of the Topic and and Queue values for this field are as shown in the below example:

    For Topics:

    topic_xyz

    Note: A topic value must begin with a prefix "topic_". Where "xyz" refers to Topic value. A maximum of 160 characters are allowed.

    For Queues, below is the supported format:

    xyz

    Note: Where "xyz" refers to a Queue value. A maximum of 160 characters are allowed.

  • Generate File: Indicates whether the output file is created under the folder specified in the Initialization String field when an event notification is generated.