Command Macros; Context-Specific Macros; Global Macros - HP BB118BV - StorageWorks Data Protector Express Package User's Manual & Technical Reference

macro syntax is also supported in this field, for many different uses. See
more information.
• Number of minutes to wait for command completion: This value in minutes specifies how long the
application should wait for the command to return. By default, it is set to Forever, meaning the
application will wait for as long as possible for the command to complete. If set to something other
than Forever, the application will terminate the command forcefully if it does not return in time.

Command Macros

Macros are classified as two types, global macros and context-specific macros. The syntax for a macro is
two dollar signs around a key, for instance $keyName$. This string will expand to whatever the defined
macro for the key "keyName" is. Key names are not case sensitive, so $keyname$ and $KEYNAME$
will both expand to the same thing.
For instance, if the user wanted to use the job name as a parameter in their script, they could specify
a command path as follows:
myBatchFile.bat -$jobname$
When executed, this command would expand to something like:
myBatchFile.bat -MyBackupJob
Context-Specific Macros
The following are all the context-specific macros available for use on pre/post commands on jobs and
objects.
All pre/post commands
jobName: Name of the job that executed the command
jobPath: Path to the job relative to the home folder (home\admin\Backup Job)
rotationSet: Current rotation set being used by the job, if a rotation is enabled
copySet: Current copy set being used by the job, if a copy policy is enabled
jobObjectId: Current object id of job, in the form {N-N-N-N}, can be used with getObject function
in script engine.
Only on post command path on job objects
jobCcode: Job error code, either 0 for success or non-zero indicating some kind of failure.
Only on pre/post command paths on objects which can be backed up
objectName: Name of the object that executed the command
objectPath: Path to the object relative to the network object (network\machine\file systems\file)
objectObjectId: The object id of the object, in the form {N-N-N-N}, can be used with getObject function
in script engine.
Only on post command paths on objects which can be backed up
objectCcode: Object error code, either 0 for success or non-zero indicating some kind of failure. Only
available for file objects, containers never set this error, since more than one child object may fail.

Global Macros

These macros are global to the product, on all operating systems, and are initialized when the application
first starts up. They are available anywhere macros are expanded, so this includes the command path.
1 10
Backup Jobs
Command Macros for