Renaming Objects and Folders

Renaming objects and folders is always possible, also if they are used in other objects. The Rename function is available from all lists that contain objects, from combo boxes, and from the global search dropdown list.

The following rules apply:

  • Maximum length of object names: 200 characters

    Exceptions:

    • Time Zone (TZ): 8 characters only.
    • Clients: 4 digits.
    • Agents and Agent Groups: 32 characters

  • Allowed characters:

    • A–Z
    • 0–9
    • $ @ _ - . #

Tip: Using a consistent naming policy for your objects is important. Before you create or rename objects have a look at Best Practices: Naming Conventions, where we provide detailed information on naming rules, best practices and examples. Applying consistent naming conventions will help you not only in your daily work but also in defining and keeping a reliable authorization system

Example

You change the name of a Queue object that is being used in multiple Jobs. When doing so, you can also simultaneously edit the Jobs in which it is being used by also editing the Queue name there. This renames not only the Queue object itself but also all its occurrences in the Job objects. This way, the Jobs will be able to continue running as usual without your having to adapt them manually.

To Rename an Object or Folder

  1. Select the object or folder and right-click to select Rename.

  2. The Rename Object or Rename Folder dialog is displayed. This dialog is different depending on whether the object you want to rename is used in other objects or not.

    If the object is not used in other objects, on the Rename Object dialog enter its new name (and optionally title) and click Rename.

    If the object is used in other objects, the dialog lists all those objects. All objects in the list are selected by default. This means that, if you confirm your action, all objects will be renamed. Activate or deactivate the checkboxes to select the instances that should be renamed. Scripts are an exception; for more information, see Restrictions.

    If the object you want to rename is used multiple times in another object (for example, in a Workflow ), the list contains an entry for each instance of the object. The Used in column tells you exactly where the instance of the object is used.

    Example: The object that you want to rename is used two times in a Workflow. There are two entries in the list for the Workflow. The Used in column shows Task(3) and Task(5). This means that the first instance is the task with number 3 in the Workflow and the second instance is the task number 5.

    Tip: To understand the potential impact or renaming an object that is being used by other objects, click the Open in New Tab button. The selected objects open in a browser tab each. If the object is used in a Workflow or in a Schedule, the Workflow or the Schedule opens to show you exactly where in its structure that particular task is located. The task is highlighted.

  3. Do one of the following:

    • To rename the selected object only, clear all checkboxes and click the Rename this Object only button

    • To rename the selected object and some or all of its occurrences in other objects, activate only the checkboxes of the objects where it should be renamed. Then click Rename & Update Selected.

Important!

  • When renaming an object, if you do not have authorization to view some of the objects in which it is used, the list displayed on the Rename Object dialog does not contain them. An information bar is displayed informing you of this.
  • If you leave the dialog open for a while and during this time another user adds a new reference to the object, this reference is not taken into account and the object is not renamed.

Restrictions

Restriction

If the object is used in a script (on any of the Process pages of executable objects) or in an Include (JOBI) or Script (SCRI) object, you have to rename it there manually:

  1. Highlight the name of the object in which it is used and click Ctrl+C to copy it.
  2. Paste it in the Global Search field that is available at the upper right corner of the window.
  3. Right-click the object and select Open or Open in New Tab.
  4. On the Process page search for the object you want to rename. The Script editor provides convenient functions for this purpose, see Searching and Replacing Strings.
  5. Save and close the object.