Defining a Subscriber
To define a subscriber:
In the Configuration tab, click Subscribers in the navigation tree. The Subscribers overview screen displays.
Click New to create a new subscriber.
Subscriber Configuration Parameters
Enter a code (up to 15 characters) that identifies the external system or application.
Enter a description (up to 35 characters).
Identify any domain this subscriber requires (for version eB2.1 and higher source applications only).
Identify any entity this subscriber requires (for version eB2.1 and higher source applications only).
Specify whether to suspend the subscriber on one or more of the following errors: sending error, SOAP error, and application error.
Message Sender does not send messages to suspended subscribers and suspended subscribers can be resumed later through the UI or a batch process script.
You can configure e-mail alerts to be sent on calculation and database errors. See QXO E-mail Alerts
Choose a sending option to be used when sending messages.
Send Immediately. Send the document to the subscriber immediately. This is the default if there are no delivery schedules defined.
Use Delivery Schedule. Send the document to the subscriber using a defined delivery schedule.
This drop-down list displays only when the Use Delivery Schedule option is selected. The default delivery schedule displays as selected in the Delivery Schedules summary screen. Choose a different delivery schedule if required. See QXO Delivery Schedules
Choose the method used to send messages.
File Directory Service: In this method, outbound QDocs are placed in a directory for the subscribing application to read. Specify a target directory. Selecting this option causes the subscriber Type to default to External Application.
Web Service: In this method, outbound QDocs are delivered to a URL where the subscriber is set up to listen for incoming documents. Specify a target URL. Selecting this option causes the subscriber Type to default to External Application.
For the fields specific to a Web Service subscriber, see Figure 2.22
and the field descriptions following it.
QXtend Web Service: In this method, users can connect to QAD QXtend without needing to know the full URL of the Web service. Selecting this option causes the subscriber Type to default to QAD QXtend.
The QXtend Web Service method also denotes communication that is carried free of charge.
For details about QAD QXtend licensing, see Licensing
For the fields specific to a QXtend Web Service subscriber, see Figure 2.24
and the field descriptions following it.
QAD Alerts: The system sends messages through the QAD Alerts Event Publishing Web service. For details, see User Guide: QAD Alerts.
QAD BPM: Use this method if you are configuring QAD BPM as the subscriber. The QAD BPM subscriber sets up the communication channel between QXO and QAD BPM and publishes business events and data to the QAD BPM server. For information about BPM, see the QAD BPM documentation.
Specify the type for the subscriber. The options on this dropdown represent the valid applications that have been registered with QXI. For details about the communication method/subscriber type combinations that permit the use of free messaging, see Free Use of QXO and QXI
Note: If the communication method is File Directory Service or Web Service, the default type is External Application. If the method is QXtend Web Service, the default type is QAD QXtend.
Specify the version of the XML syntax to use for the subscriber. The options are QDoc 1.1, QDoc 1.0, or Other. Selecting the Other option requires the SOAP action—as well as SOAP envelope and header—to be configured.
Indicate whether the subscriber only accepts the latest revision of a document or incremental updates of a document. This option is typically used when multiple QDocs exist for the same rowid or OID that has been updated multiple times, and only the latest QDoc is required.
Note: Allow Superseded option is not available for the subscribers with the Communication Method set to QAD BPM.
Yes. The subscriber only accepts the final revision of a document. Setting the Allow Superseded option to Yes means messages containing errors that were not sent and were superseded are marked as such. These superseded messages cannot be resubmitted.
No. The subscriber only accepts incremental updates of a document. Setting the Allow Superseded option to No means that when messages containing errors are superseded, further updates cannot be sent until the errors in the message have been fixed and are set to the HOLD status until the previous message is successfully sent or deleted. If there are two messages with the same rowid or OID for the same subscriber, messages are sent in a single thread in order to prevent the most recent document from being sent to the database first. All errors in the message must be fixed before further updates can be sent—or the QDoc can simply be deleted.
For File Directory Service, Web Service, and QAD BPM, specify whether QXtend requires acknowledgement of message processing results from the subscriber.
Yes. When a subscriber message is successfully delivered to the subscriber, the status of the subscriber message is set to WAITACK (waiting for acknowledgement). After the subscriber message is processed, the subscriber sends acknowledgement to QXtend and the suscriber message status is updated accordingly to DLV, APPERR, or WRN.
No. No acknowledgement is required. The message status is indicated as DLV when the message has been successfully delivered and will not be updated even though there is an error or a warning when the message is processed by the subscriber.
For file directory service, specify the location on the file system where outbound QDocs for this subscriber should be placed. If a full path is not specified, QDocs are placed in the current working directory.
For the file directory service, designate the file extension of QDocs for filedrop subscribers; for example, you can specify .req as the QDoc file extension so that QDocs can be directly dropped into a queue to be processed by Queue Manager.
Web Service URL Subscriber Entry (XML Syntax is QDoc 1.1)
For Web service, specify the URL where outbound QDocs for this subscriber are sent. This URL must be set up as a Web service.
Specify the response parser the subscriber uses to parse QDoc information. Response parser is a Progress class that you can define to parse information for your subscriber application. For information on developing your custom response parser, see Response Parser
Enter a number of seconds for QXO to wait for a response from the subscriber. If no response is received in that time period, an error is raised for the QDoc in QXO.
Specify which version of HTTP to use when making the Web Service call. Web services require SOAP headers on all incoming communications in order to validate the sender and destination. QXO supports HTTP versions 1.0 or 1.1. QAD recommends that you use HTTP 1.1.
Specify the receiver associated with this subscriber. A receiver is a named QAD Enterprise Applications instance. This field is required if XML syntax version 1.1 or 1.0 is selected.
Optionally, specify a domain in the receiver. Domains exist in the QAD Enterprise Applications databases for versions eB2.1 and above. This field displays only when XML syntax version 1.1 or 1.0 is selected.
Optionally, specify an entity in the receiver. Entities exist in the QAD Enterprise Applications databases for versions eB2.1 and above. This field displays only when XML syntax version 1.1 or 1.0 is selected.
Select this option to indicate whether QDocs sent to this subscriber should be scoped as single transactions. This field displays only when XML syntax version 1.1 or 1.0 is selected. For details see here
Specify a user name for logging in to QAD Enterprise Applications. If a user name is not provided, no user name information is entered into the context section of the QDoc. This field displays only when XML syntax version 1.1 or 1.0 is selected.
Specify a password for logging in to QAD Enterprise Applications. Any password entered into this field is masked. This field displays only when either the XML syntax version 1.1 or 1.0 is selected. This field is disabled if the User Name field is blank.
Note: For security, any user name and password login credentials specified here are masked as asterisk characters (*) when returned in the QXI response document.
Specify whether you want to encode the password for the subscriber.
Email Data Owner
Select this check box to indicate e-mail should be sent to the owner of the data when a message raises an exception. Typically this check box is used in a data synchronization scenario when data in one domain may not exist in the target domain. You must select this check box to display the Message Status options.
This field is disabled if the Active check box in the Email Configuration Parameters screen is not selected; for details, see Configuring E-mail Settings
Select the processing result that will trigger the
e-mail to be sent. (Message Status is available only when the Email Data Owner check box is selected.)
Web Service URL Subscriber Entry (XML Syntax is Other)
Include SOAP Action
If using the XML Syntax option of Other, select this option to include the SOAP action specified in the SOAP Action field. This option must be selected if the subscriber is for a QXI instance.
If using the XML Syntax of Other with a SOAP action, enter a SOAP action, if required. Leave this field blank if the subscriber is a QXI instance.
The SOAP envelope element is the root element of a SOAP message and allows QDocs to be sent to Web services that accept or poll for XML documents. When the message is sent, the &2 element of the SOAP envelope is substituted for the profile message. This option displays only when the Other option is selected on the XML Syntax drop-down. Use the default that displays in the text box.
Copy the SOAP header from a valid QDoc directed to this subscriber and paste it in here. The SOAP header provides sender and destination details. This option displays only when the Other option is selected on the XML Syntax drop-down.
If you require a specific user-defined SOAP header for a specific Web service requirement, enter that header here.
Specify the username and password for socket-level authentification by external Web service subscribers.
When communication method is Web Service and XML syntax is Other, this field is not used.
QXtend Web Service Host Subscriber Entry
If you select QXtend Web Service as the communication method, the Configuration Parameters window contains the following additional fields:
Specify the hostname of the Tomcat server that hosts the Web service.
Specify the port number where the Web service is available.
Specify the name of the Web service used to connect to QXtend Inbound.
Select the field to use Secure Socket Protocol https encryption on messages to and from the Tomcat server.
Note: If SSL is selected, then Tomcat Host must include domain name of the host.
Identify the profiles used to format QDocs for this subscriber by clicking on Register Profiles. A standard lookup displays, listing available profiles and those currently assigned. Use the Add and Remove buttons to move selected profiles from one list to the other.
If you want to restrict this subscriber to receiving data from one or more given source applications, click Register Src Apps. Add the source applications this subscriber should receive data from. When none are specified, the subscriber can receive from all valid source applications.
Click Save to save and exit the Configuration Parameters screen. The new subscriber displays in the overview screen.
Note: Profiles assigned to a subscriber are listed under the subscriber in the left-hand navigation menu.
If the subscriber is new, you can click Force Publish in the Subscriber overview screen to force the publication of a QDoc for every record associated with a profile or set of profiles. Force Publish queries every record in the source application that fits the filter criteria of each selected profile and creates an event for them.
You can also click Generate Schema to generate the XML schemas for every profile registered to this subscriber.