install_event_types

Note This utility and the define_auditdefs utility are deprecated and will be removed in a future version. Beginning in Teamcenter 10, the formerly available create parameter used with the -f argument is obsolete, and therefore you can no longer create event types using this utility. Use the Business Modeler IDE to create custom event types. For more information, see BMIDE for Data Model Design. Defines which event and object types can be subscribed to and/or audited. This utility also adds event types to an object type. Syntax install_event_types [-u=user-id {-p=password | -pf=password-file} -g=group] -f=function {install | add | remove | modify | listValidEvents | listEventtypes | text-file-name} [-overwrite] [-eventtype=eventTypeId] [-imantype=imanTypeName] [-imanclass=imanClassName] [-remove] [-audit] [-noaudit] [-subscribe] [-nosubscribe] [-h] Arguments -u Specifies the user ID. This must be a user with DBA 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 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 executes. The mode must be one of the following: install Installs standard event types and event type mappings. add Adds the event type to the specified imantype and imanclass. remove Removes event types or event type mappings. modify Modifies event type mapping. listValidEvents Lists valid event types for the specified imanclass and imantype. listEventtypes Lists all the event types in the database. text-file-name Specifies the file name used to create event type mappings, modify event type mappings, or delete event types and event type mappings. -overwrite Overwrites existing definitions, if any, during installation. Valid only with the -f=install and -f=input-file arguments. -eventtype Specifies the event type ID when creating or deleting event types or event type mappings. -imantype Specifies the imantype name when creating or deleting event types or event type mappings or when listing valid event types for that particular imantype. -imanclass Specifies the imanclass name when creating event type mappings, deleting event type mappings, or listing valid event types for that particular imanclass. -remove Use with the -f=file-name option to perform the remove operation (remove event types and event type mapping) on the file data. -audit Specifies that the event type can be audited. Valid only with the -f=modify argument. -noaudit Specifies that the event type cannot be audited. Valid only with the -f=modify argument. -subscribe Specifies that the event type can be subscribed to. Valid only with the -f=modify argument. -nosubscribe Specifies that the event type cannot be subscribed to. Valid only with the -f=modify argument. -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 When deleting event types and event type mappings using a file, all event type mappings for the event type must be deleted prior to deleting event type itself. For more information, see the example for using the -f=file-name -remove option, below. Examples Note Adding a custom event type requires implementing a CUSTOM_event_handler. To install the default event types and event type mapping definitions, enter the following command on a single line: Copy install_event_types -f=install -overwrite The -override switch causes the install to overwrite any existing definitions. To add the MyEventType event type as a valid event type for the Teamcenter type Item, enter the following command on a single line: Copy install_event_types -f=add -imantype=Item -imanclass=Item -eventtype=MyEventType To remove the MyEventType event type from the Teamcenter type Item, enter the following command on a single line: Copy install_event_types -f=remove -imantype=Item -imanclass=Item -eventtype=MyEventType Note Users cannot remove Teamcenter internal event types. To set the MyEventType event type as subscribable but not auditable for the Teamcenter type Item, enter the following command on a single line: Copy install_event_types -f=modify -imantype=Item -imanclass=Item -eventtype=MyEventType -audit -nosubscribe To list all valid event types for the Teamcenter type Item, enter the following command on a single line: Copy install_event_types -f=listValidEvents -imantype=Item -imanclass=Item To list all event types defined in the database, enter the following command on a single line: Copy install_event_types -f=listEventtypes To read the specified file, define new event types to install, (each line with an event type name) and defines event type mappings (each line with an event type mapping) in the following format: Copy iman_type_name, iman_class_name, event_type_name, subscribable_flag, auditable_flag install_event_types -f=C:\temp\my_event_types.txt -overwrite In the C:\temp\my_event_types.txt: Copy my_event_type_1 my_event_type_2 EngChange,Item,my_event_type_1,true,true EngChange,Item,my_event_type_2,true,false EngChange Revision,ItemRevision,my_event_type_1,true,true EngChange Revision,ItemRevision,my_event_type_2,true,false To read the specified file, delete event type mappings, (each line with an event type mapping) and delete event types (each line with an event type name) in the formats shown, enter the following command on a single line: Copy install_event_types -f=C:\temp\my_event_types.txt -remove Format to delete event type mapping Copy iman_type_name, iman_class_name, event_type_name Format to delete event type Copy event_type_name The my_event_types.txt file contains the following: Copy EngChange,Item,my_event_type_1 EngChange,Item,my_event_type_2 EngChange Revision,ItemRevision,my_event_type_1 EngChange Revision,ItemRevision,my_event_type_2 my_event_type_1 my_event_type_2 To delete the MyEventType event type, enter the following command on a single line: Copy install_event_types -f=remove -eventtype=MyEventType To set display names for event types: Open the user_property_names.xml file. This file is located in the TC_ROOT\lang\textserver\en_US directory. Add the keys for the event names as follows: Copy Event Name 1 Event Name 2 Stop the pool manager. Delete the Teamcenter shared memory files. The shared memory files are typically located in the temporary files location. For example, in Windows, the shared files are located in the C:\Temp\P_folder number directory. Restart the pool manager.