Subscription Service - Configuration Tab

The Configuration tab contains the Configuration, Output Setting, Transport, and RV/JMS panels. Check the listed fields in each panel.

Configuration

The Configuration panel contains the following fields:
Field Description
Name The name of Subscription Service. The name is unique among other subscribers assigned to the adapter configuration. The name only contains alphanumeric characters, including the underscore (_), and has 80 characters at most. The name cannot contain any space character, or use module properties.
Description (Optional) A short description for Subscription Service.
Transfer Mode This option determines the operation mode for Publication Service. The available options are Record Transfer and Simple File Transfer.

Output Setting

The Output Setting panel contains the following fields:
Field Description
Wip Creation Mode The creation mode of the file in the working directory. This option is unavailable when you select Simple File Transfer mode. Subscription Service uses the working directory to create the file. Based on the semantics of Wip Creation mode options, the file is moved to the output directory with the following options:
  • Append messages to file, close on Timer

    Received messages are appended to a file created in the working directory. The file is closed and moved to the output directory on receiving the timer event specified in the Elapsed field. And then a new file is created in the working directory.

  • Append messages to file, close on rvMessage

    Received messages are appended to the file created in the working directory. The file is closed and moved to the output directory on receiving a TIBCO Rendezvous message on the subject specified in the Closing Subscriber field. And then a new file is created in the working directory.

  • Append messages to file, close on jmsMessage

    Received messages are appended to the file created in the working directory. The file is closed and moved to the output directory on receiving a JMS message. And then a new file is created in the working directory.

  • Append messages to file, close on Business Document Lot End

    Closes the working file of Subscription Service when the LotEnd field is set to true and a business document is received. And then a new file is created in the output directory. You can use this option when transferring files. For more information, see the transferReader and transferWriter example in TIBCO ActiveMatrix Adapter for Files for Unix/Win Examples.

  • One message per file

    Each received message is written to a file and then moved to the output directory.

Output Creation Mode Two options are available:
  • Overwrite (always create new file)

    Overwrites the file when moving a file from the working directory to the output directory.

  • Append (if same file name exists)

    Appends the text that is received from Publication Service to the file in the output directory when moving a file from the working directory to the output directory.

File Name The name of the output file that is to be created. This field is available only when you select From Configuration in the File Name Selection list.
Note: The filename cannot contain path information.
File Name Selection With Record Transfer mode, only the From Configuration option is available. You have to specify a name in the File Name field. Subscription Service uses the name that you specify in the File Name field as the output filename.

With Simple File Transfer mode, you can select From Configuration or From Message. When you select From Message, Subscription Service uses the same filename that is available in the message as the output filename.

Close file after time elapsed (minutes) The amount of time before the file is closed in the working directory. You can type a specific time in this field or use a module property. This field is available only when you select Append messages to file, Close on timer in the Wip Creation Mode list.
Message Time Out (minutes) This field is available only if you select Append messages to file, close on Timer in the Wip Creation Mode list. It specifies the time to wait for incoming messages. After a message is received, the next message must be received within the timeout that you have specified, or Subscription Service closes the work-in-progress file and transfers it to the output directory. The default value 0 indicates no timeout.
Closing Subscriber This field is available only if you select Append messages to file, close on rvMessage or Append messages to file, close on jmsMessage in the Wip Creation Mode list. The subscriber used to receive and signify the output file is closed.

Transport

The Transport panel contains the following fields:
Field Description
Session Reference Every adapter configuration has one or more sessions. Sessions encapsulate stateful connections to TIBCO Rendezvous and other messaging sources. The session object shown in this field is initially supplied by the adapter, depending on the quality of service selected. You can change the session by clicking the button.
Endpoint Reference The default value is #consumer.SubscriptionServiceEndpoint. You cannot change the value. When you delete related services, the endpoint reference is also deleted.

For more information about endpoint reference objects, see TIBCO Designer Palette Reference.

RV

The RV panel is displayed when you select TIBCO Rendezvous session in the Session Reference field in the Transport panel. The RV panel contains the following fields:
Field Description
Subject The name of the message subject.

By default, a service uses a message subject that is generated using the Domain and Deployment module properties, the adapter acronym, the adapter configuration name, and the service name. If you use the default subject, ensure that the values for Domain and Deployment are not empty. You can type a TIBCO Rendezvous subject name different from the default.

Wire Format Publishers and subscribers can only send and receive data if they agree on a specific wire format. When sending a message, select one of the following options:
  • ActiveEnterprise Message

    Control information for validation is sent in the message. If no control information is included, an exception is returned to the subscriber. ActiveEnterprise standard wire format provides class information and packing rules for the TIBCO ActiveMatrix Adapter SDK set of data types. In this format, ActiveEnterprise components can perform extra validation on messages sent or received. This option is unavailable for Simple File Transfer mode of the adapter. It is available only for Record Transfer mode.

  • XML Message

    It is a text message which contains XML data that is validated against an XSD. This option is available only for Record Transfer mode.

Note: This field is available only with Record Transfer mode. With Record Transfer mode, you can select ActiveEnterprise Message or XML Message for the Rendezvous transport type.

With Simple File Transfer mode, this field is read-only. By default, it is ActiveEnterprise Message for the Rendezvous transport type, and XML Message for the JMS transport type.

JMS

The JMS panel is displayed when you select JMS session in the Session Reference field in the Transport panel. The JMS panel contains the following fields:
Field Description
Destination By default, a service uses a dynamic destination that is generated using the Domain and Deployment module properties, the adapter acronym, the adapter configuration name, and the service name. If you use the default dynamic destination, ensure that the values for Domain and Deployment are not empty. You can override the default dynamic destination by specifying the static destination in this field. The static destination must be defined on the JMS server before it can be used by the runtime adapter.
Wire Format Publishers and subscribers can only send and receive data if they agree on a specific wire format.
Note: This field is available only with Record Transfer mode. With Record Transfer mode, you can only select XML Message for the JMS transport type.
Delivery Mode For Subscription Service, a message is marked as durable or nondurable.
  • Durable

    A durable service is registered with the JMS server. Messages sent to a durable service are held by the JMS server until they are received by the service. If Subscription Service crashes, messages are received when the service resumes.

  • Non-Durable

    Messages sent to a nondurable service are not held by the JMS server. If Subscription Service crashes, messages which arrived on the JMS server are not received when the service resumes.

The semantics for these fields are more complex than the explanation given here. For more information, see the TIBCO Enterprise Message Service documentation.