Publication Service - Configuration Tab

The Configuration tab contains the Configuration, Life Cycle, Input File, Transport, and RV/JMS panels. Go over the listed fields in each panel.

Configuration

The Configuration panel contains the following fields:
Field Description
Name The name of Publication Service. The name is unique among all publishers in 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 Publication Service.
Transfer Mode Determines the operation mode for Publication Service. The available options are Record Transfer and Simple File Transfer.

Life Cycle

The Life Cycle panel contains the following fields:
Field Description
Preserve Undelivered Determines whether an undelivered JMS message is preserved in the system queue.
Delta Publishing Mode Only supports the Timer polling method. When Delta Publishing mode is enabled, Publication Service checks the input file on a preconfigured timer interval, and copies any new data to a work file in the WIP directory, and then processes and publishes the new data.
Life Cycle Specifies if Publication Service operates continuously (Repeating) or just one time (Once-only). The Once-only option means to start, process the files, and then exit.
Note: If more than one service is defined for the adapter configuration, you cannot select Once-Only for the first service.
Polling Method Specifies how Publication Service is triggered to start processing the files When you select Repeating from the Life Cycle list. Publication Service can be triggered using a timer or a message. The Timer method of triggering is available for both transport types.

Triggering Publication Service using a message depends on the transport type.

If the transport type is TIBCO Rendezvous, a TIBCO Rendezvous message can be used to trigger Publication Service. If the transport type is JMS, a JMS message sent on a topic can be used to trigger Publication Service.

Polling Interval (seconds) Specifies the amount of time in seconds until the next file scan is repeated. This is available when selecting Timer from the Polling Method list.
Polling Subject Specifies the subject or topic name on which the TIBCO Rendezvous message or the JMS message is sent to trigger Publication Service.

If the transport type is TIBCO Rendezvous, the name of this field is Polling Subject. If the transport type is JMS, the name of this field is Polling Destination.

Input File

The Input File panel contains the following fields:
Field Description
Input Directory Publication Service searches and processes the files in this directory, and then publishes the files.

This directory can be different from the directories specified for the Working Directory and Completion Directory fields. The input, working, and completion directories can have an absolute path name or a relative path name. When a relative path name is used, it is relative to the starting directory of the runtime adapter.

Note: On Unix, the processing directories such as the input, working, done or output directories are specified on the same file system. Only the input directory is scanned for files that match the criteria. It is not recursively traversed.
Recognition Method Specifies the mechanism for finding the desired input file(s). The following options are available:
  • By file name

    Processes the file that exactly matches the value given in the File Name field.

  • By Wildcard via ICU Regular Expressions

    Processes the file that matches the ICU regular expression specified in the File Name field.

  • By prefix + extension

    Processes the files that match the criteria that you have defined in the File Prefix and File Extension fields.

  • By trigger

    Processes the files that match the criteria that you have defined in the File Prefix, File Extension, and Trigger File Extension fields.

    When selecting the By trigger option, the adapter processes the input files only after they are ready. Without this, the adapter might process the files in the input directory before files are created, written, or closed by the third-party applications. The trigger file recognition method helps to avoid this situation. With the trigger recognition method, the adapter only processes the input files after the trigger files are created.

Note: The filename or file prefix cannot contain path information.
File Name This field is available in the following cases:
  • When you select By file name from the Recognition Method list.

    In this case, the adapter processes the file that matches exactly the value given in this field.

  • When you select By Wildcard via ICU Regular Expressions from the Recognition Method list.
    In this case, you can use ICU regular expressions in the File Name field. The following list describes two examples of using ICU regular expressions:
    • Prepare the following files in the input directory: text0.txt, text1.txt,..., to text10.txt.

      If the input filename is text\d\.txt, the input files named from text0.txt, text1.txt,..., to text9.txt are published.

    • Prepare the following files in the input directory: A6.0.0.txt, A6.1.0.txt, A6.2.0.txt, A6.8.0.txt, A6.0.0.log, and A6.1.0.log.

      If the input filename is A6\.[01]\.0\.(txt|log), the input files named A6.0.0.txt, A6.1.0.txt, A6.0.0.log, and A6.1.0.log are published.

    Note: Wildcard is different from regular expressions and is not supported. For example, *.txt must be specified as .*\.txt in the regular expressions format.
File Prefix This prefix is used to locate the input file in the input directory. Any file matching the specified criteria is processed. To activate the file prefix, select By prefix + extension or By trigger from the Recognition Method list.
File Extension This field is available only when you select By prefix + extension or By trigger from the Recognition Method list.
Trigger File Extension This field is available only when you select By trigger from the Recognition Method list.

Transport

The Transport panel contains the following fields:
Field Description
Session Reference Every adapter configuration has one or more sessions. Sessions encapsulate connections to TIBCO Rendezvous and other messaging sources. The session object shown in this field is initially supplied by the adapter, depending on the selected quality of service selected. You can change the session by clicking the button.
Endpoint Reference The default value is #producer.PublicationServiceEndpoint. 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 message subject.
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. It is available only for Record Transfer mode.

  • XML Message

    The XML Message wire format conforms to specifically constructed and fully compliant XML Schema (XSD) based on the existing definition of the ActiveEnterprise schema.

Note: This field is only enabled in Record Transfer mode. In Record Transfer mode, you can select ActiveEnterprise Message or XML Message for the Rendezvous transport type.

In 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 this default dynamic destination, make sure 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 only enabled in Record Transfer mode. In Record Transfer mode, you can only select XML Message for the JMS transport type.
Delivery Mode For Publication Service, a message is marked as persistent or non-persistent.
  • Persistent

    A message marked as persistent is available to a JMS client even if the JMS server goes down.

  • Non-Persistent

    A message marked as non-persistent is unavailable to a JMS client if the JMS server goes down.

Messages with persistent delivery mode are always written to persistent storage, except when they are published to a topic that has no durable subscribers. When a topic has no durable subscribers, no subscribers requests to resend messages when a server fails. In this case, you do not have to save messages, thus improving performance because disk I/O is not required.