ada_util

Provides an alternate procedure to the user interface-based setting of security classification/clearance and license information so it can be called from scripts. This utility, which supports batch mode processing using an input file, supports the following authorized data access (ADA) modes: newlicense modlicense addlicense removelicense adduser removeuser addgroup removegroup setclassification setclearance To perform debugging, you must: Copy set env variable DEBUG=ON set DEBUG_FILE_NAME=debug-file For more information about ADA licenses, see Teamcenter Security documentation.. puid The ada_util utility supports using an object's puid instead of the item_id Syntax ada_util [-u=user-id {-p=password | -pf=password-file} g=group] [-m=mode] [-h] Arguments -u Specifies the user ID. This is a user with Teamcenter administration privileges or another user with IP Admin or ITAR Admin privilege according to the classification/clearance or license type involved in the operation. 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. -m Specifies the mode, which can be one or more of the following: newlicense modlicense addlicense removelicense adduser removeuser addgroup removegroup setclassification setclearance newlicense mode Creates a license with given ID using the -license_id and -type argument with the optional -date expiration date, the optional -reason reason, the optional -lock_date lock date, and the optional -qualifying_cfr string. The -qualifying_cfr argument is applicable only to ITAR licenses. To use the newlicense mode, enter the following: newlicense Command line options: -license_id=license-id [-date=expiration-date] [-reason=reason] [-type=[itar|ip|exclude] [-lock_date=lock-date] [-qualifying_cfr=string] [-category=string] [-citizenships=citizenship-list] [-cfg=configuration_file] [-o=output_file] [-report_file=report_file.report] -v File options: [-filename=input_data_file.txt] [-cfg=configuration_file] [-o=output_file] [-r=repeat_file.rep] [-report_file=report_file.report] -v modlicense mode Modifies a license identified using the -license_id argument to have a new expiration date specified using the -date argument, a new lock date specified using the -lock_date argument, and new qualifying Code of Federal Regulation (CFR) information specified for licenses of ITAR type using the -qualifying_cfr argument. To use the modlicense mode, enter the following: modlicense Command line options: -license_id=license-id [-date=expiration-date] [-lock_date=lock-date] [-qualifying_cfr=string] [-category=string] [-citizenships=citizenship-list] [-filename=input_data_file.txt] [-cfg=configuration_file] [-o=output_file] [-report_file=report_file.report] -v File options: [-filename=input_data_file.txt] [-cfg=configuration_file] [-o=output_file] [-r=repeat_file.rep] [-report_file=report_file.report] -v addlicense mode Adds the license identified using the -license_id argument to the object specified by -Item_id, -RevID, -Object-Type, and -Object-Name arguments. Additionally, qualifying paragraph information can be supplied using the -ead_paragraph argument. To use the addlicense mode, enter the following: addlicense Command line options: -license_id=license-id [-ead_paragraph=string] -Item_id=item [-RevID=revision [-Object-Type=object-type -Object-Name=object-name]] or -key="item_id=item[,property=property value,property=property value, …]" [-cfg=configuration_file] [-o=output_file] [-report_file=report_file.report] -v File options: [-filename=input_data_file.txt] [-cfg=configuration_file] [-o=output_file] [-r=repeat_file.rep] [-report_file=report_file.report] -v removelicense mode Removes (detaches) a license. To use the removelicense mode, enter the following: removelicense Command line options: -Item_id=item [-RevID=revision [-Object-Type=object-type -Object-Name=object-name]] or -key="item_id=item[,property=property value,property=property value, …]" -license_id=license-id [-cfg=configuration_file] [-o=output_file] [-report_file=report_file.report] -v File options: [-filename=input_data_file.txt] [-cfg=configuration_file] [-o=output_file] [-r=repeat_file.rep] [-report_file=report_file.report] -v adduser mode Adds the user identified using the -userid argument to the license identified by the -license_id argument. To use the adduser mode, enter the following: adduser Command line options: -license_id=license-id -userid=user-id [-cfg=configuration_file] [-o=output_file] [-report_file=report_file.report] -v File options: [-filename=input_data_file.txt] [-cfg=configuration_file] [-o=output_file] [-r=repeat_file.rep] [-report_file=report_file.report] -v removeuser mode Removes (detaches) the user. To use the removeuser mode, enter the following: removeuser Command line options: -license_id=license-id -userid=user-id [-cfg=configuration_file] [-o=output_file] [-report_file=report_file.report] -v File options: [-filename=input_data_file.txt] [-cfg=configuration_file] [-o=output_file] [-r=repeat_file.rep] [-report_file=report_file.report] -v addgroup mode Adds the group identified using the -groupid argument to the license identified by the -license_id argument. To use the addgroup mode, enter the following: addgroup Command line options: -license_id=license-id -groupid=group-id [-cfg=configuration_file] [-o=output_file] [-report_file=report_file.report] -v File options: [-filename=input_data_file.txt] [-cfg=configuration_file] [-o=output_file] [-r=repeat_file.rep] [-report_file=report_file.report] -v removegroup mode Removes (detaches) the group. To use the removegroup mode, enter the following: removegroup Command line options: -license_id=license-id -groupid=group-id [-cfg=configuration_file] [-o=output_file] [-report_file=report_file.report] -v File options: [-filename=input_data_file.txt] [-cfg=configuration_file] [-o=output_file] [-r=repeat_file.rep] [-report_file=report_file.report] -v setclassification mode Sets a classification for a given workspace object as specified by the -classification, -Item_id, -RevID, -Object-Type, -Object-Name, and -type arguments. To use the setclassification mode, enter the following: setclassification Command line options: -classification=classification [-ead_paragraph=string] -Item_id=item [-RevID=revision [-Object-Type=object-type -Object-Name=object-name]] or -key="item_id=item[,property=property value,property=property value, …]" -type=[itar|ip] [-cfg=configuration_file] [-o=output_file] [-report_file=report_file.report] -v File options: [-filename=input_data_file.txt] [-cfg=configuration_file] [-o=output_file] [-r=repeat_file.rep] [-report_file=report_file.report] -v setclearance mode Sets a clearance level for a given user specified by the -clearance, -userid, and -type arguments. To use the setclearance mode, enter the following: setclearance Command line options: -clearanceclearance-level -userid=user-id -type=[itar|ip] [-cfg=configuration_file] [-o=output_file] [-report_file=report_file.report] -v File options: [-filename=input_data_file.txt] [-cfg=configuration_file] [-o=output_file] [-r=repeat_file.rep] [-report_file=report_file.report] -v -key Specifies the multiple file keys (MFK) needed to identify the item. Example: To apply the license001 license to the 123456 Design: ada_util -u=user -p=pass -g=group -m=addlicense -license_id=license001 -key="item_id=123456,object_type=Design" -category Specifies the category type (a string of 128 bytes) for an ADA license. This argument can only be used with the newlicense or modlicense modes. -cfg Specifies the configuration_file that is the file path and name of the configuration file. -citizenships Specifies the user citizenships for an ADA license. Each citizenship is a two-letter country code from ISO 3166. Multiple citizenships are separated by a comma delimiter, such as: Copy -citizenships=US,GB -classification Specifies a classification according to context. -clearance Specifies a clearance according to context. -date Specifies a date for use in newlicense and modlicense modes. The default date format is defined as numericday-abbreviatedmonth-numericyear hours:minutes. hours are in 24-hour format. For example, 11-dec-2006 15:20. The month names and default date format may change with locale. -ead_paragraph Specifies the authorizing paragraph information (a string of 80 characters) recorded on the workspace object specified by -Item_id, -RevID, -Object-Type, and -Object-Name arguments, while attaching an ITAR_License object identified by the -license_id argument. -filename Specifies the input_file that is the file path and name of the input file. -h Displays help for this utility. -Item_id Specifies the item to use in finding an object. See the description for the -Object-Name argument. -license_id Specifies a unique license ID for use with the newlicense, addlicense, and modlicense modes. -lock_date Enables authorized users to freeze or unfreeze the license specified by the -license_id argument on the specified date. This argument can only be used with the newlicense or modlicense modes. -o Specifies the output_file that is the file path and name of the output log file. If not supplied, the default filename is input_data_file.log and will be located in the same directory as the input_data_file. -Object-Name Specifies an object to which the various ADA operations apply. The value should be the object name, for example, a dataset name. This argument is required. This argument also requires the -Item_id, -RevID, and -Object-Type arguments to provide a basis for finding the object; first, uniquely identifying the item (-Item_id), second, identifying the specific revision of that item (-RevID), and third, filtering objects attached to the item revision based on object type and name (-Object-Type). If you specify only the -Item_id argument, the object is the item. If you specify the -Item_id and -RevID arguments, the object is the revision. If you specify the -Item_id, -RevID, and -Object-Type arguments, the object is that named with the type on the item revision. See setclassification and addlicense modes. -Object-Type Specifies the object type to filter specification attachments of the given item/revision when finding an object. See the description for the -Object-Name argument. -qualifying_cfr Specifies the information for the In Accordance With attribute (a string of 80 characters) for the ITAR_License object identified by the -license_id argument. This argument can only be used in with the newlicense or modlicense modes. -r Specifies the repeat file with the extension .rep that contains a copy of any data lines that caused an error. This file is overwritten on subsequent run. -reason Specifies a string when using the newlicense mode. -report_file Specifies the report file name with the extension .report. This option turns off all create and update options effectively just writing a report of objects found and not found in the specified report file. -RevID Specifies the revision within a given item to use in finding an object. See the description for the -Object-Name argument. -type Specifies the license type as itar (International Traffic in Arms Regulations), ip (intellectual property), or exclude (exclude license) to exclude certain users who are not allowed to see the data. If -type is set to itar, the setclassification mode applies to gov_classification and the setclearance mode applies to gov_clearance. If -type is set to ip, the setclassification mode applies to ip_classification and the setclearance mode applies to ip_clearance. The default value is ip. -userid Specifies a user for the setclearance and adduser modes. This argument should not be confused with the login user argument, -u. -v Turns on verbose mode to get detailed output about the additional propagation relations being processed. If -report_file is specified, this option is ignored. Environment As specified in Setting up a Teamcenter command-line environment. Files As specified in Log files produced by Teamcenter. Restrictions None. Examples Command-line examples: Create new licenses using the newlicense mode with a different delimiter: Copy ada_util -u=user -p=pass -g=dba -m=newlicense -filename=TC_21910_004_newlicense_datafile.txt The contents of the TC_21910_004_newlicense_datafile.txt shown below allows the use of the pipe character (|) in the entries (TC|21910_ITAR_1). Copy !$license_id$reason$type$citizenships TC|21910_ITAR_1$To_Manage_Control_Over_Location$itar$US,JP,AL,AS TC|21910_ITAR_2$To_Manage_Control_Over_Location$itar$US,JP,AL,AS TC|21910_ITAR_3$To_Manage_Control_Over_Location$itar$US,JP,AL,AS TC|21910_ITAR_4$To_Manage_Control_Over_Location$itar$US,JP,AL,AS TC|21910_IP_4$To_Manage_Control_Over_Location$ip$US,JP To set a classification of secret on the 1234/A UG master dataset attached to the item 1234 revision A: Copy ada_util -u=user -p=pass -g=group -m=setclassification -classification=secret -Item_id=1234 -RevID=A -Object-Type="UG Master" -Object-Name=1234/A -type=ip To set an IP clearance level of secret for the user2 user: Copy ada_util -u=user -p=pass -g=group m=setclearance -clearance=secret -userid=user2 -type=ip To create a new ITAR license license001 with an expiration date of 11 December 2018 at 15:20: Copy ada_util -u=user -p=pass -g=group -m=newlicense -license_id=license001 -date="11-dec-2018 15:20" -type=itar To create the ITAR_license001 ITAR license with a category of Category A: Copy ada_util -u=user -p=pass -g=group -m=newlicense -license_id=ITAR_license001 -category="Category A" To create a new ITAR_license01 with an allowed citizenship for Great Britain: Copy ada_util -u=user -p=password -g=group -m=newlicense -license_id=ITAR_license01 -type=itar -citizenships=GB To add user2 user to the license001 license: Copy ada_util -u=user -p=pass -g=group -m=adduser -license_id=license001 -userid=user2 To apply the license001 license to the 1234/A dataset attached to item 1234 revision A: Copy ada_util -u=user -p=pass -g=group -m=addlicense -license_id=license001 -Item_id=1234 -RevID=A -ObjectType="UG Master" -ObjectName=1234/A To apply the license001 license to the 1234/A dataset attached to item 1234 revision A without specifying the -RevID,-ObjectType, and -Object-Name options: Copy ada_util -u=user -p=pass -g=group -m=addlicense -license_id=license001 -Item_id=1234 To update the ITAR_license001 ITAR license to Category B: Copy ada_util -u=user -p=pass -g=group -m=modlicense -license_id=ITAR_license001 -category="Category B" To update user citizenships on the license ITAR_license01 to Great Britain and Japan: Copy ada_util -u=user -p=password -g=group -m=modlicense -license_id=ITAR_license01 -citizenships=GB,JP File-based examples: The ada_util supports the use of a puid column in the input file to identify objects when using the addlicense, removelicense, and setclassification arguments. This is useful if the object's id contains special characters, which are not supported in the input file. Example If you use the setclassification argument, you cannot use the item id in this case because it contains special characters: Copy !|item|classification|type Model_8"x11"|top-secret|ip Instead, identify the item using its puid. Copy !|puid|classification|type w9OAAEXS5ZdsKD|top-secret|ip Use the pipe character (|) as a delimiter in your files and the pound sign (#) at the beginning of a file for comments. Create new licenses using the newlicense mode: Copy ada_util -u=Tc-admin-user -p=password -g=group -m=newlicense -filename=TC_21910_004_newlicense_datafile.txt TC_21910_004_newlicense_datafile.txt contents: Copy !|license_id|reason|type|citizenships TC21910_ITAR_1|To_Manage_Control_Over_Location|itar|US,JP,AL,AS TC21910_ITAR_2|To_Manage_Control_Over_Location|itar|US,JP,AL,AS TC21910_ITAR_3|To_Manage_Control_Over_Location|itar|US,JP,AL,AS TC21910_ITAR_4|To_Manage_Control_Over_Location|itar|US,JP,AL,AS TC21910_IP_4|To_Manage_Control_Over_Location|ip|US,JP Modify licenses using the modlicense mode: Copy ada_util -u=Tc-admin-user -p=password -g=group -m=modlicense -filename=TC_21910_104_modlicense_datafile.txt TC_21910_104_modlicense_datafile.txt contents: Copy !|license_id|reason TC21910_ITAR_1|To_Manage_Control_Over_Location_Modified TC21910_ITAR_2|To_Manage_Control_Over_Location_Modified TC21910_ITAR_3|To_Manage_Control_Over_Location_Modified TC21910_ITAR_4|To_Manage_Control_Over_Location_Modified TC21910_IP_4|To_Manage_Control_Over_Location_Modified Add licenses using the addlicense mode: Copy ada_util -u=Tc-admin-user -p=password -g=group -m=addlicense -filename=TC_21910_104_addlicense_datafile.txt TC_21910_104_addlicense_datafile.txt contents: Copy !|license_id|Item_id|ead_paragraph TC21910_ITAR_1|TC_21910_Item_4|ITAR_Section_127_1_1 TC21910_ITAR_2|TC_21910_Item_5|ITAR_Section_127_1_1 TC21910_ITAR_3|TC_21910_Item_6 TC21910_ITAR_4|TC_21910_Item_7 Remove licenses using the removelicense mode: Copy ada_util -u=Tc-admin-user -p=password -g=group -m=removelicense -filename=TC_21910_304_removelicense_datafile.txt TC_21910_304_removelicense_datafile.txt contents: Copy !|license_id|Item_id TC21910_ITAR_1|TC_21910_Item_4 TC21910_ITAR_2|TC_21910_Item_5 TC21910_ITAR_3|TC_21910_Item_6 TC21910_ITAR_4|TC_21910_Item_7 Add users using the adduser mode: Copy ada_util -u=Tc-admin-user -p=password -g=group -m=adduser -filename=TC_21910_404_adduser_datafile.txt TC_21910_404_adduser_datafile.txt contents: Copy !|license_id|userid TC21910_IP_4|TC_21910_User_4 TC21910_ITAR_1|TC_21910_User_5 TC21910_ITAR_2|TC_21910_User_6 TC21910_ITAR_3|TC_21910_User_7 TC21910_ITAR_2|TC_21910_User_7 Remove users using the removeuser mode: Copy ada_util -u=Tc-admin-user -p=password -g=group -m=removeuser -filename=TC_21910_504_removeuser_datafile.txt TC_21910_504_removeuser_datafile.txt contents: Copy !|license_id|userid TC21910_IP_4|TC_21910_User_4 TC21910_ITAR_1|TC_21910_User_5 TC21910_ITAR_2|TC_21910_User_6 TC21910_ITAR_3|TC_21910_User_7 Add groups using the addgroup mode: Copy ada_util -u=Tc-admin-user -p=password -g=group -m=addgroup -filename=TC_21910_604_addgroup_datafile.txt TC_21910_604_addgroup_datafile.txt contents: Copy !|license_id|groupid TC21910_IP_4|TC_21910_Group_4 TC21910_ITAR_1|TC_21910_Group_5 TC21910_ITAR_2|TC_21910_Group_6 TC21910_ITAR_3|TC_21910_Group_7 Remove groups using the removegroup mode: Copy ada_util -u=Tc-admin-user -p=password -g=group -m=removegroup -filename=TC_21910_704_removegroup_datafile.txt TC_21910_704_removegroup_datafile.txt contents: Copy !|license_id|groupid TC21910_IP_4|TC_21910_Group_4 TC21910_ITAR_1|TC_21910_Group_5 TC21910_ITAR_2|TC_21910_Group_6 TC21910_ITAR_3|TC_21910_Group_7 Set classification using the setclassification mode: Copy ada_util -u=Tc-admin-user -p=password -g=group -m=setclassification -filename=TC_21910_904_setclassification_datafile.txt TC_21910_904_setclassification_datafile.txt contents: Copy !|item|classification|type TC21910_Item_4|secret|ip TC21910_Item_5|secret|itar TC21910_Item_6|top-secret|itar Set clearance using the setclearance mode: Copy ada_util -u=Tc-admin-user -p=password -g=group -m=setclearance -filename=TC_21910_804_setclearance_datafile.txt TC_21910_804_setclearance_datafile.txt contents: Copy !|userid|clearance|type TC21910_User_4|secret|ip TC21910_User_5|secret|itar TC21910_User_6|top-secret|itar To create a new ITAR license license001 with an expiration date of 11 December 2018 at 15:20: Copy ada_util -u=user -p=pass -g=group -m=newlicense -filename=input_file_name -report_file=report_file.report -repeat_file=repeat_file.rep -o=log_file.log license_id=license001 -date="11-dec-2018 15:20" -type=itar Related Topics Data Access Management