install_handlers

Defines action handlers. It can also configure new action handlers and modify the definition of existing handlers. Syntax install_handlers [-u=user-id {-p=password | -pf=password-file} -g=group-name] -f= {install | create | modify | delete | listall} -id=handler-ID [-funcname=function-name] [-libname=library name] [-functype=1 | 2] [-execmode=1 | 2 -desc=handler-description] [-retrycount=retry-count] [-retryinterval=retry-interval-in-minutes] [-exectime=time-of-the-day-in-24-hour-format] -override=true | false [-h] 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. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. 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. -f Specifies the mode in which the utility must execute. The mode must be one of the following: install create modify delete listall -id= Specifies the handler ID. -funcname Specifies the name of the library function. Use this argument when the -functype argument is set to 1. -libname Specify the name of the library containing the –funcname API. This is optional. If not specified, the following order of libraries is used: libuser_exits libsub_mgr libepm libsa -functype Specifies whether the handler is a library function or a stand-alone executable. The value for this argument must be one of the following: 1 Library function 2 Stand-alone executable -execmode Specifies the handler's execution mode. The value for this argument must be one of the following: 1 Executes the handler in the calling process. 2 Executes the handler as a separate process. -desc Specifies the handler description. -override Specifies if the handler execution time can be overridden. The value for this argument must be one of the following: true Allows override. false Disables override. -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 None. Examples To install the default action handlers, enter the following command on a single line: Copy install_handlers -f=install To create an action handler with the specified attribute values to set the execution time for the handler to 6.00 p.m., enter the following command on a single line: Note If no library name is specified, the default libraries listed previously are searched. Copy install_handlers -f=create -id=MyActionHandler -funcname=Myfunc -functype=1 -execmode=1 exectime=1800 To create an action handler with specified attribute values, an execution time set for 6.00 PM, and run from the specified libmdo library, enter the following command on a single line: Copy install_handlers -f=create -id=MyActionHandler -funcname=Myfunc       -functype=1  -execmode=1  exectime=1800 -libname=libmdo To set the retry count value to 5 for the MyActionHandler action handler, enter the following command on a single line: Copy install_handlers -f=modify -id=MyActionHandler -retryCount=5 To delete the MyActionHandler action handler, enter the following command on a single line: Copy install_handlers -f=delete -ID=MyActionHandler To list all the action handlers defined in the database, enter the following command on a single line: Copy install_handlers -f=listall Related Topics Workflow Designer on Rich Client