HCL Workload Automation, Version 9.4

rename

Renames a scheduling object already existing in the database. The new name must not identify an object already defined in the database.

Authorization

To rename scheduling objects, you must have delete access to the object with the old name and add access to the object with the new name.

To rename security objects, you must have permission for the modify action on the object type file with attribute name=security.

Syntax

{rename | rn}

{calendars|calendar|cal |

parms|parm|vb |

vartable|vt |

prompts|prom |

resorces|resource|res |

runcyclegroup|rcg |

workstation|ws |

workstationclass|wscl |  

domain|dom |

jobs|jobdefinition|jd |

jobsched|jb |

eventrule|erule|er |


sched|jobstream|js |

securitydomain|sdom |

securityrole|srol
|

users|user }

old_object_identifier  new_object_identifier

Arguments

old_object_identifier
Specifies the old external key identifying the scheduling object, for example calendar name cal1 as identifier for a defined calendar object to be renamed.
new_object_identifier
Specifies the new external key identifying the scheduling object, for example calendar name cal2 as new identifier to be assigned to calendar object previously named cal1.
For what concerns jobs, job streams, resources and users both the old_object_identifier and new_object_identifier have the following formats:
[workstationame#]jobname
The command applies to this job definition. This format is used with the jobs|jobdefinition|jd key.
[workstationame#]jstreamname
The command applies to all versions of this job stream. This format is used with the sched|jobstream|js key.
[workstationame#]jstreamname.jobname
The command applies to this job instance defined in this job stream. See the js keyword in the Job stream definition syntax for additional details. This format is used with the jobsched|jb key.
[workstationame#]resourcename
The command applies to this resource definition. This format is used with the resources|resource|res key.
[workstationame#][domain\]username
The command applies to this user definition. This format is used with the users|user key.
For what concerns variables (global parameters):
old_object_identifier
Must be specified in the tablename.variablename format. If tablename is omitted, composer looks for the variable in the default variable table.
new_object_identifier
Must be specified in the variablename format. Adding the table name here generates an error.

Comments

To be renamed the object must be unlocked or locked by the user who issues the rename command.

The variable table containing the variable is locked, while the variable is renamed. This implies that, while the table is locked, no other user can run any other locking commands on it.

If an object named as specified in the old_object_identifier field does not exist in the database an error message is displayed.

The use of wildcards is not allowed with this command.

When workstationame is not specified for objects that have the workstation name as part of their object identifier (for example, job or job stream definitions), the scheduler uses one of the following for workstationame:
  • The default workstation specified in the localopts file
  • The master domain manager if the composer command line program is running on a node outside the HCL Workload Automation network. In this case, in fact, the default workstation set in the localopts file is the master domain manager.

The rename command is used to assign new names to objects already existing in the database. The new name assigned to an object becomes immediately effective in the database, while it becomes effective in the plan after the JnextPlan script is run again. This can lead to incongruences when submitting ad-hoc jobs before generating again the production plan.

Examples

To rename domain object DOMAIN1 to DOMAIN2 , run the following command:
rename dom=DOMAIN1 DOMAIN2
To rename job stream LABJST1 to LABJST2 on workstation CPU1, run the following command:
rename js=CPU1#LABJST1 CPU1#LABJST2
To rename variable ACCTOLD (defined in table ACCTAB) to ACCTNEW, run the following command:
rename parm=ACCTAB.ACCTOLD ACCTNEW

See also

From the Dynamic Workload Console you can perform the same tasks as described in:

the Dynamic Workload Console User's Guide.