Parameters for Custom Actions
The following are lists of the parameters for job and jobstream properties that you can insert into the address string for a URL that a custom action invokes. The values that are passed with the URL come from the job or jobstream from which you opened the Action menu and selected the action.
The parameters are listed under their categories as they appear on the Add Custom Action and Edit Custom Action dialogs, where you can click them to add them to the action URL at the place the cursor is positioned. For information, see Custom Actions.
When you add a parameter to a custom action URL, the action appears in the related parts of AAI depending on whether the parameter is for Jobs, Jobstreams, or Jobs in Jobstreams. If a parameter is in more than one category, it means it can apply to both or all three of the object types. Therefore, regardless of which category you pick it from, it applies to all those categories, and appears in the corresponding action menus.
If you choose no parameters, the action appears in all job and jobstream menus.
In the following table, parameters with an asterisk (*) appear in all three categories.
|
{parameterName} Descriptive Name |
For Jobs |
For Jobstreams |
For Jobs in Jobstream Runs |
|---|---|---|---|
|
{avgDuration} Average Duration |
Jobs |
|
Jobs in Jobstream |
|
{conditions} Conditions String |
Jobs |
|
Jobs in Jobstream |
|
{days} Days of Week |
Jobs |
|
Jobs in Jobstream |
|
{definedMachine} Defined Machine |
Jobs |
|
Jobs in Jobstream |
|
{deletedTime} Deletion Time |
Jobs |
|
Jobs in Jobstream |
|
{excludeCalendar} Exclude Calendar |
Jobs |
|
Jobs in Jobstream |
|
{extRunId} External Run ID |
Jobs |
|
Jobs in Jobstream |
|
{isStartJob} Trim Point |
Jobs |
|
Jobs in Jobstream |
|
{jobName} Job |
Jobs |
|
Jobs in Jobstream |
|
{owner} Owner |
Jobs |
|
Jobs in Jobstream |
|
{parent} Parent Job |
Jobs |
|
Jobs in Jobstream |
|
{retrys} # of Retries |
Jobs |
|
Jobs in Jobstream |
|
{runCalendar} Run Calendar |
Jobs |
|
Jobs in Jobstream |
|
{runMachine} Run Agent |
Jobs |
|
Jobs in Jobstream |
|
{scheduler} Scheduler Name * |
Jobs |
Jobstreams |
Jobs in Jobstream |
|
{startMins} Start Minutes |
Jobs |
|
Jobs in Jobstream |
|
{startTimes} Start Times * |
Jobs |
Jobstreams |
Jobs in Jobstream |
|
{streamBusinessAreas} Jobstream Business Areas |
|
Jobstreams |
Jobs in Jobstream |
|
{streamDaysAfter} Jobstream Days After |
|
Jobstreams |
Jobs in Jobstream |
|
{streamExpDuration} Jobstream Expected Duration |
|
Jobstreams |
Jobs in Jobstream |
|
{streamExpEndtime} Jobstream Expected End Time |
|
Jobstreams |
Jobs in Jobstream |
|
{streamIsCritical} Jobstream Is Critical |
|
Jobstreams |
Jobs in Jobstream |
|
{streamIsForecastable} Jobstream Is Forecastable |
|
Jobstreams |
Jobs in Jobstream |
|
{streamName} Jobstream Name |
|
Jobstreams |
Jobs in Jobstream |
|
{streamTarget} Jobstream Target |
|
Jobstreams |
Jobs in Jobstream |
|
{termRunTime} Term Run Time |
Jobs |
|
Jobs in Jobstream |
|
{timeZone} Time Zone * |
Jobs |
Jobstreams |
Jobs in Jobstream |
|
{user} User * |
Jobs |
Jobstreams |
Jobs in Jobstream |
|
{window} Run Window |
Jobs |
|
Jobs in Jobstream |