axlAddJobPolicy

axlAddJobPolicy( 
t_jobPolicyName 
t_selectedPath
l_jobPolicyProperties
) 
=> t / nil

Description

Adds or saves a job policy at the specified location.

This function does not apply the job policy. It only saves a new job policy at the given location. To use this job policy, you need to set this policy in the Job Policy form or by using the defaultJobPolicy environment variable. To apply a job policy while defining its properties, use the axlAttachJobPolicy function.

Arguments

t_jobPolicyName	Job policy name.
t_selectedPath	Location of the `.cadence` directory where the job policy file is to be stored. You can store the job policy file in the `.cadence` directory in one of the following default locations specified in the `setup.loc` file at `<`your_inst_dir`>/share/cdssetup` in your Cadence installation, or customize the `setup.loc` file to specify more locations to save the job policy file: `.cadence` directory in the current directory The `.cadence` directory in the path specified in the `CDS_WORKAREA` environment variable. `$HOME/.cadence` (the `.cadence` directory in your home directory) The `.cadence` directory in the path specified in the `CDS_PROJECT` environment variable. The `.cadence` directory in the path specified in the `CDS_SITE` environment variable. Ensure that you have write permissions in the .cadence directory where you want to store the job policy file. The job policy file is saved in the `jobpolicy` directory under the specified `.cadence` directory. The job policy file has the `.jp` extension. For more information, see "Saving a Job Policy".
l_jobPolicyProperties
	List of job policy property name-value pairs.

Value Returned

`t`	The job policy is added.
`nil`	The job policy is not added.

Examples

Saves the mypolicy policy in the .cadence directory:

axlAddJobPolicy( "mypolicy" 
          "./.cadence"
          '( nil distributionmethod "LBS" 
          configuretimeout "1200" 
          maxjobs "5" 
          name "LBS_Policy" 
          runtimeout "3600" 
          starttimeout "300" ) )
=> t

After saving a job policy, you can set this as the default policy for a session by using the defaultJobPolicy environment variable.

Virtuoso ADE SKILL Reference
Product Version IC23.1, November 2023