Command Reference > pmrep Command Reference > ApplyLabel


Applies a label to an object or a set of objects in a folder. If you enter a folder name, all the objects in the folder receive the label. You can apply the label to dependent objects. If you use the dependency_object_types option, pmrep labels all dependent objects. To apply a label to selected dependent objects, separate each object type name by a comma with no spaces between them on the command line.
Use ApplyLabel to label reusable input objects. If you want to label non-reusable input objects, you must use a persistent input file that contains encoded object IDs.
If ApplyLabel succeeds, pmrep displays either no status information or a list of objects that already have the label. If the command fails, pmrep displays the reason for the failure.
The ApplyLabel command uses the following syntax:

-a <label_name>

{{-n <object_name>

  -o <object_type>

  [-t <object_subtype>]

  [-v <version_number>]

  [-f <folder_name>] } |

  -i <persistent_input_file>}

[-d <dependency_object_types>]

[-p <dependency_direction (children, parents, or both)>]

[-s (include pk-fk dependency)]

[-g (across repositories)]

[-m (move label)]

[-c <comments>]

[-e dbd_separator]
The following table describes pmrep ApplyLabel options and arguments:
Required. Label name to apply to the object.
Required if you are updating a specific object. Name of the object to receive the label. You cannot enter object names if you use the -i option.
Type of object to apply the label to. You can specify source, target, transformation, mapping, session, worklet, workflow, scheduler, session config, task, cube, or dimension. Required when applying a label to a specific object.
Required. Type of task or transformation you are labeling. pmrep ignores other object types. For more information about valid subtypes, see Listing Object Types.
Optional. Version of the object to apply the label to. The command fails if the version is checked out. Applies the label to the latest version of the object by default.
Optional. Folder that contains the objects. If you enter a folder name but no object name, pmrep applies the label to all objects in the folder. If you enter a folder name with an object name, pmrep searches the folder for the object. You cannot use the -f option if you use the -i option.
Optional. Name of a text file generated from ExecuteQuery, ListObjectDependency, or Validate. Contains a list of objects to receive the label. If you use this option, do not use the object name, object type, or folder name to specify objects.
Optional. Dependent object types to label. Valid dependent object types include shortcuts, mappings, mapplets, sessions, workflows, worklets, target definitions, source definitions, and foreign key dependencies.
Use this option with option -p. If you enter an object type, the label applies to dependent objects of that object type.
Optional. Dependent parents or children to apply the label to. You can specify parents, children, or both. If you do not enter option -d, all dependent objects receive the label.
If you do not enter this option, the label applies to the specified object.
Optional. Include the primary key-foreign key dependency objects regardless of the direction of the dependency.
Optional. Find object dependencies across repositories.
Optional. Move a label from the current version to the latest version of an object. Use this argument when the label type is one_per_object.
Optional. Comments about the label.
Optional. If an ODBC source has a period (.) in the name, define a different separator character when you define the source object. For example, instead of database_name.source_name, define the source object as database_name\source_name, and define the dbd_separator as backslash (\).