reportOnly | java.lang.Boolean Optional. Indicates whether the service changes the document types and webMethods messaging triggers and returns a summary of the changes or if the service returns only a summary without making any changes. Set to: true to return a summary of the document types and webMethods messaging trigger that the service would successfully and unsuccessfully update, including the errors and warnings that would be encountered. The service does not modify any document types and triggers. This is the default. false to update the publishable document types and webMethods messaging triggers, synchronize the publishable document types with the messaging provider, and return a summary of the changes. |
backupPackages | java.lang.Boolean Optional. Indicates whether the service creates a package archive for each package affected by this service prior to making any updates to the publishable document types and webMethods messaging trigger. Set to: true to create an archive for each package that contains a publishable document type or webMethods messaging trigger that will be updated by this service. The archive will be named packageName.zip_timeStamp and placed in the following directory: and will be located in the following directory: Integration Server_directory \instances\instance_name\replicate\archive. This is the default. false to skip creating an archive of each affected package before making updates. Important: Software AG recommends that you set backupPackages to true when reportOnly is set to false if you have not taken other measures to back up the packages containing the publishable document types and triggers to be migrated prior to executing the pub.utils.messaging:migrateDocTypesTriggersToUM service. After the service executes successfully, restoring from a backup file is the only way to revert a change made by the service. |
packageNames | String List Optional. Name of the packages containing the publishable document types that you want to migrate. Integration Server also migrates any webMethods messaging triggers in packages that reference publishable document types contained in the specified packages. The packageNames and documentTypesNames input parameters are mutually exclusive. If you specify a value for both parameters, the service fails with an exception. If you do not specify a value for either, the service updates publishable document types and webMethods messaging triggers in all packages that do not start with the letters “wm” in any case combination. |
documentType Names | String List Optional. Fully qualified names of the publishable document types that you want to update. The packageNames and documentTypeNames input parameters are mutually exclusive. If you specify a value for both parameters, the service fails with an exception. If you do not specify a value for either, the service updates publishable document types and webMethods messaging triggers in all packages that do not start with the letters “wm” in any case combination. |
newConnection Alias | String Optional. Name of the Universal Messaging (UM) connection alias to assign to the publishable document types. Any webMethods messaging trigger that subscribe to updated publishable document types will use this alias to receive published documents. You must specify a newConnectionAlias to update any publishable document types that currently specify the Broker connection alias or are publishable locally only. If you do not specify a newConnectionAlias, the service skips these publishable document types. If the default connection alias is the Broker connection alias and you do not specify a newConnectionAlias, the service skips any publishable document types that use the default connection alias. However, if you change the default connection alias to be Universal Messaging connection alias and then execute the pub.utils.messaging:migrateDocTypesTriggersToUM service, the service migrates any publishable document types that use the default messaging connection alias as well as any triggers that subscribe to those publishable document types. If a publishable document types already specifies a Universal Messaging connection alias, you do not need to specify a newConnectionAlias. However, you can use the service to change the Universal Messaging connection alias used by one or more publishable document types. |
affectedPackages | Document Conditional. An IData containing key=value pairs that identify the packages impacted by the migration and the name of the archive created for the package. The service returns an archive name only if reportOnly is set to false and backupPackages is set to true. The archive will be named packageName.zip_timeStamp and will be located in the following directory: Integration Server_directory \instances\instance_name\replicate\archive. The service returns affectedPackages only if the service finds at least one publishable document type or webMethods messaging trigger to update. | |
failedPackages | Document List Conditional. List of the packages that could not be archived. If Integration Server cannot create a package archive for any of the affected packages, the service ends with an error and nothing is migrated. The service attempts to archive a package only when backupPackages is set to true. The service returns the failedPackages parameter only if one of the following occurs: The backupPackages input parameter is set to true and an error prevented the service from archiving at least one package. A package listed in the packageNames input parameter did not contain any publishable document types or webMethods messaging triggers to update. | |
Key | Description | |
package | String Name of the package that the service could not archive because of an error. | |
errors | String Text of the error message that caused package archiving to fail. | |
updatedDocument Types | Document List Conditional. List of the publishable document types updated by the service. The service returns the updatedDocumentTypes parameter only if the service updated one or more publishable document types. | |
Key | Description | |
package | String Name of the package containing the updated publishable document type. | |
name | String Fully qualified name of the updated publishable document type. | |
skippedDocument Types | Document List Conditional. List of the publishable document types that were not updated because there were no changes to make. Some reasons the service might skip a publishable document type include, but are not limited to: The publishable document type already uses the messaging connection alias specified in newConnectionAlias and the encoding type for the publishable document type is already set to protocol buffers. The publishable document type uses a Broker connection alias and a Universal Messaging connection alias was not specified in newConnectionAlias. Values were not specified for either the packageNames or the documentTypeNames input parameters and Integration Server found publishable document types in packages whose names started with the letters “wm” in any case combination The service returns the skippedDocumentTypes parameter only if the service skipped updating one or more publishable document types. | |
Key | Description | |
package | String Name of the package containing the skipped publishable document type. | |
name | String Fully qualified name of the skipped publishable document type. | |
reason | String Message indicating why the service did not update the publishable document type. | |
failedDocument Types | Document List Conditional. List of the publishable document types that the service could not update because of an error. The service returns the failedDocumentTypes parameter only if there were one or more publishable document types that the service could not update because of an error. | |
Key | Description | |
package | String Name of the package containing the publishable document type that the service could not update because of an error. | |
name | String Name of the publishable document type that the service could not update because of an error. | |
errors | String Text of the error message that prevented the service from updating the publishable document type. | |
providerSync Results | Document List Conditional. Results of synchronizing the updated publishable document types with the messaging provider. The service only produces this output parameter when reportOnly is set to false and the service updated at least one publishable document type. | |
Key | Description | |
successfuPDTs | String List Fully qualified names of the publishable document types that the service synchronized successfully with the messaging provider. | |
unsuccessful PDTs | String List Fully qualified names of the publishable document types that the service did not synchronize successfully with the messaging provider. | |
errors | Document List List of any errors that occurred during document type synchronization. | |
warnings | Document List List of any warnings that occurred during document type synchronization | |
updatedTriggers | Document List Conditional. List of the webMethods messaging triggers updated without warnings by the service. When warnings do not occur when updating the trigger, it indicates that Integration Server migrated the entire contents of the Filter field to the Provider Filter (UM) field for all the conditions in the trigger. The service returns the updatedTriggers parameter only if the service updated at least one trigger without warnings. | |
Key | Description | |
package | String Name of the package containing the updated webMethods messaging trigger. | |
name | String Fully qualified name of the updated webMethods messaging trigger. | |
reason | String Identifies any filters that were converted. For a trigger that was updated without warnings, reason displays the contents of the Filter field prior to migration of the trigger filter, the contents of the Provider Filter (UM) field after migration of the trigger filter, and an indication that the filter was converted successfully. | |
updatedTriggers WithWarning | Document List Conditional. List of the webMethods messaging triggers updated but with warnings. Warnings indicate that the service could not migrate the entire contents of the Filter field to the Provider Filter (UM) field for all the conditions in the trigger. Integration Server might have migrated some expressions in the trigger conditions, but not the entire filter. When a trigger is updated with warnings, the service keeps the original filter in the Filter field and places the filter expressions that were migrated in the Provider Filter (UM) field The service returns the updatedTriggersWithWarning parameter only if the service updated at least one trigger for which a warning occurred. | |
Key | Description | |
package | String Name of the package containing the updated webMethods messaging trigger. | |
name | String Fully qualified name of the updated webMethods messaging trigger. | |
reason | String Identifies any filters that were converted. For a trigger that was updated with warnings, reason displays the expressions in the Filter field that were migrated, the converted expression in the Provider Filter (UM) , and an indication that the filter was converted successfully. | |
warning | String Warning message indicating why the complete original filter in the Filter field could not be migrated to the Provider Filter (UM) field. | |
skippedTriggers | Document List Conditional. List of the webMethods messaging triggers that the service did not update because no changes were needed. The service returns the skippedTriggers parameter only if the service skipped updating at least one trigger. | |
Key | Description | |
package | String Name of the package containing the skipped webMethods messaging trigger. | |
name | String Fully qualified name of the skipped webMethods messaging trigger. | |
reason | String Message indicating why the service did not make any updates for the webMethods messaging trigger. For example, if the trigger conditions did not contain any filters, the reason will be “Trigger did not contain any filters.” | |
failedTriggers | Document List Conditional. List of the webMethods messaging triggers that the service could not update because of an error. The service returns the failedTriggers parameter only if at least one trigger failed migration. | |
Key | Description | |
package | String Name of the package containing the webMethods messaging trigger that the service could not update because of an error. | |
name | String Name of the webMethods messaging trigger that the service could not update because of an error. | |
errors | String Text of the error message that prevented the service from updating the webMethods messaging trigger |