Open topic with navigation

Subscriptions

Subscriptions determine how notifications on topics are delivered. Click on the Subscriptions tab to open the table view of subscriptions. You will see a list of subscriptions each associated with a set of topics as noted by the "Topics Subscribed To" column.

Creating a Subscription

To create a subscription and associate it with topics, click on the New button.

1. Provide a name for the subscription.
2. Assign relevant topics to this subscription for which notifications will be delivered. Use the item-selector box in the Assigned Topics section to move topics from the left-window into the right-window. Click on Add All >> to assign all topics to the subscription or click on select topics and click on Add > to assign specific topics to the subscription.
3. Select a protocol. (See below for descriptions)
4. Protocol-specific fields will appear in the Parameters section. Complete these fields.
5. Click OK.

Protocols

The following are brief descriptions of the available subscription protocols. For more information, see the FME Server Reference Manual.

Apple Push Notification

The Apple Push subscriber is a notification subscriber that allows message delivery to an Apple iOS device, such as an iPhone or iPad. The subscriber pushes messages from FME Server to an iOS app installed on the target iOS device by means of a cloud service—the Apple Push Notification Service.

Email

The email protocol allows users to have notifications delivered to an email address or several email addresses. Below is a description of the fields that must be completed by users adding new subscriptions of this type:

• SMTP Server – Mail exchanger server host name or IP address used for sending email.
• SMTP Server Port – Mail exchanger TCP port used for sending email.
• SMTP Account – If the SMTP server requires authentication, this is the user name.
• SMTP Password – If the SMTP server requires authentication, this is the user password.
• SMTP Connection Security- The encryption mechanism used for the connection, if any.
• Email To – Corresponds to the To field in standard email messages.
• Email CC – Corresponds to the CC field in standard email messages.
• Email From – Corresponds to the From field in standard email messages, if users reply to the notification email message it will be directed to this email address.
• Email Subject – Corresponds to the Subject field in standard email messages.
• Email Format - The format of the email, either plain text or HTML.
• Email Content Template – The message body to use for delivery. This is a template that allows the use of various tags that are replaced with dynamic information before delivery. When the message is provided by an FME Server web service, such as the Data Download or Job Submitter service, the following tags are supported:

• {StatusMessage} – The status message of the transformation job that completed.
• {id} – The transformation job’s ID.
• {urlPrefix} – Prefix of the URL used to download any job transformation result files.
• {ResultRootDir} – Root directory fragment part of the URL used to download any job transformation result files.
• {@getFilename(@zip(OutputLocation))} – Retrieves the filename fragment part of the URL used to download any job transformation result files. The result files are compiled into a zip file.

FTP

The FTP subscriber receives notifications and uploads files to specified FTP hosts. Below is a description of the fields that must be completed by users adding new subscriptions of this type:

• Host: The FTP host name.
• Port: The FTP port number.
• Username: The FTP user name for authentication.
• Password: The FTP user password for authentication.
• Encryption: The encryption type, depending on the FTP server connection requirements. Options are None, FTPS and FTPES encryption protocols.
• Transfer Type: The transfer method. "Auto" means the FTP subscription will guess the file type of the file being transferred. "ASCII" and "Binary" are available options when the file type is known.
• Destination Path: The destination path to upload the file. File paths must use forward slashes (/) or escaped backslashes (\\).
• Source Path: The path to the source file to upload. File paths must use forward slashes (/) or escaped backslashes (\\). Template macros are supported for this field (see below).
• Zip Source: "Yes" means the source file should be zipped for delivery. "No" means the source file should not be zipped.

Google Cloud Messaging

The Google Cloud Messaging subscriber is a notification subscriber that allows message delivery to a Google Android device, such as a Samsung Galaxy S3. The subscriber pushes messages from FME Server to an Android app installed on the target Android device by means of a cloud service—the Google Cloud Messaging (GCM) service.

JMS

The Java Message System (JMS) subscriber communicates with JMS-compliant message brokers, such as IBM WebSphere MQ.

Logger

The logger protocol allows users to have notifications delivered to the FME Server notifications log file.

• Log Level – Determines how detailed the notification message appears in the log file.

  • Low – The log message provides confirmation that a notification message is received.

  • Normal – The log message provides confirmation that a notification message is received and topic name details.

  • High – The log message provides confirmation that a notification message is received, topic name details and all notification content.

Push

The push protocol allows users to have notifications posted to a target URL on the Internet. The result is posted to the URL using an HTTP POST. Below is a description of the fields that must be completed by users adding new subscriptions of this type:

• Target URL – The target URL on the Internet (or in your intranet) to which notifications on the associated topics are delivered to via HTTP POST.
• HTTP Authentication User – If the target URL requires HTTP authentication, this is the user name to use.
• HTTP Authentication Password – If the target URL requires HTTP authentication, this is the user password to use.

Modifying an Existing Subscription

To modify an existing subscription, click on the subscription entry in the table. A dialog similar to the one used to add new subscriptions will appear populated with the properties of the selected subscriptions. Make changes as needed and click OK.

Removing a Subscription

To remove an existing subscription select the subscription row from the table and click Remove.

Safe Software Inc. www.safe.com