UpdateSecurityLabels Command Line Utility Output File
After you run the UpdateSecurityLabels command line utility, an output file is created. The output file displays object status information for the objects processed by the utility. Use the output file to address any issues that occurred when running the utility. After addressing any issues, you can rerun the utility to ensure that all objects have the appropriate security labels applied.
The location of the output file is provided in a summary line in the windchill shell after the tool runs. The output file is in the TSV file format, but can be converted to XLS or XLSX for easy viewing. In some cases, such as when processing large amounts of data, more than one output file is created. Additional output files can be found in the same directory with a “_x” suffix, where “_x” is the file number.
 |
Any additional output files do not have a heading row indicating the column assignments. The heading row can be copied from the first output file.
|
The output file has columns for the object identifier, the display identity, a status for the object, a message describing the status, and old and new values of the security labels. The input file location and a summary line with the total number of successes, failures, and so on are also listed.
The following table shows possible object status values. The amount of detail available in the output file can vary depending on the configured log4j.logger.UpdateSecurityLabelsReport property setting. Errors or failures will always display.
Status | Description | Fix |
|---|---|---|
Ignored: The object cannot have security labels applied. | Appears when the object specified in the Object Identifier column cannot have security labels applied. Only certain object types can have security labels applied. For more information, see Object Types Exposing Security Labels. | Security label changes cannot be applied. Remove the object from the input file. |
Failure: The specified Object Identifier is invalid. | Appears when the Object Identifier column in the input file contains an invalid value. | Ensure that there are no typographical errors in the object identity in the input file. Object identifiers can be displayed in Windchill. For more information, see Configuration for Exporting Object Information and Security
Label Values and Exporting Objects with Current Security Label Values. |
Failure: Missing Object Identifier information | Appears when the Object Identifier column in the input file is blank. | 1. Enter the appropriate object identity information. 2. Remove the row from the input file. |
Failure: The object does not exist. | Appears when the object cannot be found in Windchill. | 1. Check for typographical errors in the input file. 2. Remove the object from the input file. |
Failure: A security label value could not be set for the object because it is in a personal folder or workspace and the value would restrict the owner’s access rights: <Security Label>=<Value> | Appears when a user has the specified object checked out and the security label value change would prevent them from checking in the object. | 1. Check in the object. 2. Update the target security label value in the input file to a value that does not restrict the user’s access. |
Failure: A security label value could not be set for this version of the object because one or more versions of the object are in a personal folder or workspace and the value would restrict the owner’s access rights: <Security Label>=<Value> | Appears when the following conditions are met: • The -allVersions parameter is specified when running the utility. • A user has a version of the object checked out and the security label value change would prevent them from checking in the object. | 1. Check in the object. 2. Update the target security label value in the input file to a value that does not restrict the user’s access. 3. Run the utility without the -allVersions parameter. |
Failure: An unexpected error occurred. Contact your administrator. | Appears when an error occurs while running the utility. | Contact your administrator with the following information: • The name of the utility. • The time you encountered the error. |
Failure: The UpdateSecurityLabels command has failed after encountering unexpected errors. | Appears when an error occurs while running the utility. | Contact your administrator with the following information: • The name of the utility. • The time you encountered the error. |
Failure: The security labels of the object cannot be set to the target values because the labels or label values have been disabled: <Security Label>=<Value> | Appears when the security label or security label value specified in the input file has been disabled. | Set the security label value to a valid option in the input file. • If the security label has been disabled, the security label value can be set to the same value or to the unrestricted (null) value. • If the security label value has been disabled, the security label value can be set to the same security label value, an enabled security label value, or the unrestricted (null) value. • Check the security label configuration file, locate the respective SecurityLabelValue section and update the value of respective enabled attribute to true. |
Failure: The target security label value is invalid: <Security Label>=<Value> | Appears when the security label value specified in the input file is not a configured security label value. | Set the security label value to a valid value in the input file. |
Failure: <Security Label> does not support multiple security label values | Appears when a user tries to set multiple values for a standard security label which is not configured to have multiple security label values. | Check the security label configuration file, locate the respective SecurityLabel element and add the MultiValueLogicalOperator tag with required condition. For more information, see SecurityLabel element. |
No change | Appears when the security label value settings have not changed for the specified object. | |
Success | Appears when the security label value settings updated successfully for the specified object. |
| | If you open the output file in a spreadsheet processing program, such as Microsoft Excel, you can sort the output data by object status. |