migrate_wf_handlers

Transforms the name and/or arguments of workflow handlers from one format to another. Task templates may have one or more workflow handlers associated with them. This utility transforms the handlers associated with templates that are active, as well as template versions that are obsolete but that are still referenced by uncompleted workflow processes or jobs. This utility uses an XML mapping file to migrate handlers and their arguments. The mapping file top-level nodes define an action (rule or transform) to perform, such as Replace, Remove, or Update, on the individual handler specified within them. Note If you are migrating (as opposed to upgrading) workflows from one Teamcenter environment to another, import the workflows before you run this utility. Syntax migrate_wf_handlers [-u=user-id {-p=password | -pf=password-file} -g=group-name] [-report=report-file-name [-dryrun] [-listonly] [-templates=template-to-migrate, ...] [-templates_file=path-and-name-of-csv-file] [-mapping_file=path-and-name-of-xml-mapping-file] [-v] [-h] Arguments Entries in parentheses are accepted abbreviations for arguments. -u Specifies the user ID. This is a user with Teamcenter administration privileges. Note If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are authenticated externally through SSO rather than being authenticated against the Teamcenter database. If you do not supply these arguments, the utility attempts to join an existing SSO session. If no session is found, you are prompted to enter a user ID and password. -p Specifies the user's password. If used without a value or if neither the -pf nor the -p argument is used, the system displays an error and asks for a username and password interactively. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. If used without a value or if neither the -pf nor the -p argument is used, the system displays an error and asks for a username and password interactively. For more information about managing password files, see Manage password files. This argument is mutually exclusive with the -p argument. -g Specifies the group associated with the user. If used without a value, the user's default group is assumed. -report Specifies the output file. If this argument is not specified, the output is written to the standard output. -dryrun Runs the command without making any changes. Actions that would have been performed are displayed instead. -listonly Lists the handlers and arguments it would have migrated, but makes no changes. -templates Limits the migration of handlers to ones owned by the specified templates. If you use more than one template name, separate them with a comma. If a template name has spaces in it, quotes are required around the name. Mutually exclusive with the -templates_file argument. -templates_file Limits the migration of handlers to ones owned by the templates specified in the named file. The file contains a comma-delimited list of one or more template names. Mutually exclusive with the -templates argument. -mapping_file Specifies the path and file name of the XML mapping file containing transforms or rules with the old and new names for handlers and arguments. The mapping file provided by Siemens Digital Industries Software to convert handler names and arguments from versions prior to Teamcenter 10.1 is TC_DATA\wf_handler_migration.xml. -v Displays verbose output and its use is recommended if you are running this utility manually. If this argument is not specified, nothing is displayed when the utility is run. -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. Files As specified in Log files produced by Teamcenter. Restrictions After replacing one handler with two or more new handlers using the Replace rule in the map file, the new handlers are not available for further processing during the same run of the utility in subsequent mapping file elements. However, the handlers would be available for processing when you run the utility again. The Replace rule cannot replace an action handler with a rule handler and vice versa. Examples The following example does not migrate handlers, it only performs a dry run in verbose mode, with the output information sent to the standard output. The TC_DATA variable is specified for Windows systems. Because -u and -p are not specified, the user's operating system credentials are used. Copy migrate_wf_handlers -v -dryrun -mapping_file= %TC_DATA%\wf_handler_migration.xml The following example migrates the handlers using the tcadmin user with verbose output to the standard output. The TC_DATA variable is specified for Linux systems. Copy migrate_wf_handlers -v -u=tcadmin -p=password -mapping_file= $TC_DATA/wf_handler_migration.xml The following example migrates the handlers using the tcadmin user and a password file with verbose output to the specified report file (rpt_file): Copy migrate_wf_handlers -v -u=tcadmin -pf=pswd_file -report=rpt_file -mapping_file=./map.xml The following example migrates in silent mode only the handlers used by the specified workflow template: Copy migrate_wf_handlers -templates="Authorization WF Template" -mapping_file=D:\Temp\MyMigrationMappingFile.xml Related Topics Workflow Designer on Rich Client