pub.publish:syncToProvider
WmPublic. Synchronizes one or more publishable document types with their associated provider definition by pushing the publishable document types to the associated message provider.
Input Parameters
documentTypes | String List Fully qualified names of the publishable document types to synchronize with their associated provider definition. |
Output Parameters
successfulPDTs | String List Conditional. Fully qualified names of the publishable document types that Integration Server updated successfully on the provider. The service only produces this output parameter if one or more publishable document types updated successfully. |
unsuccessfulPDTs | String List Conditional. Fully qualified names of the publishable document types that Integration Server did not update successfully on the provider. The service only produces this output parameter if one or more publishable document types did not update successfully. |
errors | Document List Conditional. Lists any errors that occurred during document type synchronization. |
warnings | Document List Conditional. Lists any warnings that occurred during document type synchronization. |
Usage Notes
You can use pub.publish:syncToProvider as a start up service for a package to avoid using Software AG Designer to synchronize document types.
The Connection alias name property for a document type specifies the messaging connection alias assigned to the document type which indicates the provider to which a document type will be pushed.
If the documentTypes parameter contains document types that are not publishable or do not exist, Integration Server lists the errors in the errors parameter.
The pub.publish:syncToProvider service replaces pub.publish:syncToBroker, which has been deprecated.
For a publishable document type that uses protocol buffers as the encoding type, the
pub.publish:syncToProvider synchronizes the existing protocol buffer descriptor with
Universal Messaging. If you want
Integration Server to create an updated protocol buffer definition for the document type, compile the updated definition into an updated protocol buffer descriptor, and synchronize the updated descriptor with
Universal Messaging, use the
pub.utils.messaging:syncDocTypesToUM service.