A

---

Licensing Environment Variables

---

This appendix describes the licensing variables that you can use to customize the default license settings. You can set the values of these environment variables in the .cdsenv file.

The following example illustrates an environment variable setting in the .cdsenv file.

license VLSLicenseCheckoutOrder string "XL, GXL, EXL, MXL" 

In each entry, the first column is the tool partition, the second column is the variable, the third column is the data type, and the fourth column contains the value to be used. For more information, see Specifying Environment Settings in Virtuoso Studio Design Environment User Guide.

You can also set and retrieve the values of these environment variables using the envSetVal and envGetVal functions in CIW. For example:

envSetVal("license" "VLSLicenseCheckoutOrder" ’string "XL, GXL, EXL, MXL")

envGetVal("license" "VLSLicenseCheckoutOrder")

This section describes the environment variables available in the license partition of the .cdsenv file:

• CheckoutOrder Variables
• UseNextLicense Variables
• Other Licensing VariablesskipAMSEnvironmentLicCheck

CheckoutOrder Variables

These variables control the license checkout order of Virtuoso Studio tier-based applications. The values specified in these variables govern the order in which higher-tier licenses are checked out when an attempt to check out a lower-tier license fails.

For each CheckoutOrder variable, a set of valid values can be created using a combination of values from the default value list, with commas or spaces as delimiters. However, an empty string is not allowed as a valid value for these variables, except EADLicenseCheckoutOrder.

The following CheckoutOrder variables available in the license partition:

VLSLicenseCheckoutOrder

VSELicenseCheckoutOrder

VLSAdvOptLicenseCheckoutOrder

maestroCheckoutOrder

EADdatasetCheckoutOrder

AMSEnvLicenseCheckoutOrder

VIVALicenseCheckoutOrder

cdlNetlistCheckoutOrder

VLSLicenseCheckoutOrder

license VLSLicenseCheckoutOrder string "XL, GXL, EXL, MXL"

Description

Specifies the license checkout order preference for the Virtuoso Layout Suite (VLS) product family.

The default is XL,GXL,EXL, MXL.

GUI Equivalent

Command:	CIW – Options – License – Ordering
Field:	Layout

Examples

envGetVal("license" "VLSLicenseCheckoutOrder")

envSetVal("license" "VLSLicenseCheckoutOrder" 'string "EXL, MXL, XL")

Related Topics

Software Product License Management Form: Ordering Tab

VSELicenseCheckoutOrder

license VSELicenseCheckoutOrder string "L, XL"

Description

Specifies the license checkout order preference for the Virtuoso Schematic Editor (VSE) product family.

The default is: L,XL

GUI Equivalent

Command:	CIW – Options – License – Ordering
Field:	Schematic

Examples

envGetVal("license" "VSELicenseCheckoutOrder")

envSetVal("license" "VSELicenseCheckoutOrder" 'string "XL, L")

Related Topics

Software Product License Management Form: Ordering Tab

VLSAdvOptLicenseCheckoutOrder

license VLSAdvOptLicenseCheckoutOrder string "95513" "95511, 95512"

Description

Specifies the license checkout order preference for Virtuoso advanced node features.

The default is: 95513, 95511,95512    

GUI Equivalent

Command:	CIW – Options – License – Ordering
Field:	Layout Option

Examples

envGetVal("license" "VLSAdvOptLicenseCheckoutOrder")

envSetVal("license" "VLSAdvOptLicenseCheckoutOrder" 'string "95513, 95511")

Related Topics

Software Product License Management Form: Ordering Tab

maestroCheckoutOrder

license maestroCheckoutOrder string "Explorer, Assembler"

Description

Specifies the license checkout order preference for Maestro (Virtuoso ADE Explorer or Virtuoso ADE Assembler) licenses.

The default is: Explorer, Assembler

GUI Equivalent

Command:	CIW – Options – License – Ordering
Field:	Maestro

Examples

envGetVal("license" "maestroCheckoutOrder")

envSetVal("license" "maestroCheckoutOrder" 'string "Assembler, Explorer")

Related Topics

Software Product License Management Form: Ordering Tab

EADdatasetCheckoutOrder

license EADdatasetCheckoutOrder string "EXL, VVAO"

Description

Specifies the license checkout order preference for the Virtuoso Electrically Aware Design license.

The default is: EXL, VVAO

GUI Equivalent

Command:	CIW – Options – License – Ordering
Field:	EAD_DATASET

Examples

envGetVal("license" "EADdatasetCheckoutOrder")

envSetVal("license" "EADdatasetCheckoutOrder" 'string "VVAO, EXL")

Related Topics

Software Product License Management Form: Ordering Tab

AMSEnvLicenseCheckoutOrder

license AMSEnvLicenseCheckoutOrder string "AMS, ADE"

Description

Specifies the license checkout order to be considered while running the Check and Save feature of Text Editor for verilogams and SystemVerilog views. By default, this feature first looks for the AMS_Environment license (Product number 70000), when the AMS_Environment license is not available  orthe Maestro (Virtuoso ADE Explorer or Virtuoso ADE Assembler) license is checked out.

The default is: AMS, ADE

AMSEnvLicenseCheckoutOrder replaces the skipAMSEnvironmentLicCheck, which will be removed from a future release. Currently, when skipAMSEnvironmentLicCheck is set to t, AMS is removed from the checkout order.

GUI Equivalent

Command:	CIW – Options – License – Ordering
Field:	AMS_env

Examples

envGetVal("license" "AMSEnvLicenseCheckoutOrder")

envSetVal("license" "AMSEnvLicenseCheckoutOrder" 'string "ADE, AMS")

Related Topics

Software Product License Management Form: Ordering Tab

VIVALicenseCheckoutOrder

license VIVALicenseCheckoutOrder string "VIVA, ADE,Verifier"

Description

Specifies the license checkout order preference for Virtuoso Visualization and Analysis XL. By default, this variable is set to VIVA,ADE,Verifier.

If the VIVA license is not available,  Maestro (Virtuoso ADE Explorer or Virtuoso ADE Assembler) license is checked out. If both VIVA and ADE licenses are not available, the Verifier license is checked out.

You must set this environment variable in .cdsinit or .cdsenv file. Do not set this environment variable in the CIW.

The default is: VIVA,ADE,Verifier

GUI Equivalent

Command:	CIW – Options – License – Ordering
Field:	VIVA

Examples

envGetVal("license" "VIVALicenseCheckoutOrder")

envSetVal("license" "VIVALicenseCheckoutOrder" 'string "VIVA, Verifier")

Related Topics

Software Product License Management Form: Ordering Tab

cdlNetlistCheckoutOrder

license cdlNetlistCheckoutOrder string "Schematic, SE"

Description

Specifies the license checkout order preference for auCdl netlisting. By default, this variable is set to Schematic, SE. If the Schematic license (Virtuoso_Schematic_Editor_L or Virtuoso_Schematic_Editor_XL) is not available, the SE license (Virtuoso_Simulation_Environment) is checked out.

You must set this environment variable in .cdsinit or .cdsenv file. Do not set this environment variable in the CIW.

The default is: Schematic, SE

GUI Equivalent

None

Examples

envGetVal("license" "cdlNetlistCheckoutOrder")

envSetVal("license" "cdlNetlistCheckoutOrder" 'string "SE, Schematic")

Related Topics

Software Product License Management Form: Ordering Tab

UseNextLicense Variables

If a license for a requested application is not available, the Use Next License dialog box is displayed, which lets you check out a higher tier license, subject to availability.

These variables control whether to check out the next available license for Virtuoso tier-based applications, when the license required for a requested application is not available.

Depending on the value of this variable, you are given an opportunity to check out a higher tier license, subject to availability.

These environment variables can have the following values:

Value	Use
prompt	Prompts for confirmation before checking out the next tier license. Note: During a Virtuoso Studio session, the Next License dialog appears only once for each application. When prompt is set as the current value, the Next License dialog is displayed asking you to confirm before checking out the next tier license.
always	Always tries to check out the next tier license when the requested license is not available.
never	Never attempts to check out the next tier license and displays an error message instead.

If the value of these variables is set as an empty string " " (except for EADLicenseCheckoutOrder) or has an incorrect variable value, the license tool prints an appropriate CIW warning message about the specific issue. In both cases, the previous checkout order is restored.

If Virtuoso Studio is currently being run in the -nograph mode, the license order mechanism will not display the Use Next License dialog if a specific license is not available, and the value of *_UseNextLicense is set to prompt. Instead, a warning message will be added to the log file.

The following UseNextLicense variables available in the license partition:

VLSXL_UseNextLicense

VSEL_UseNextLicense

VLSAdvStd_UseNextLicense

VLSAdvOpt_UseNextLicense

VIVA_UseNextLicense

ADE_UseNextLicense

Explorer_UseNextLicense

VLSXL_UseNextLicense

license VLSXL_UseNextLicense string "prompt"

Description

Sets the UseNextLicense value that controls whether to check out the next available license (Virtuoso_Layout_Suite_GXL) for Virtuoso Layout Suite XL or not.

Valid values are prompt, always, never. The default is prompt

GUI Equivalent

Command:	CIW – Options – License – Ordering – Layout – XL
Field:	UseNext

Examples

envGetVal("license" "VLSXL_UseNextLicense")

envSetVal("license" "VLSXL_UseNextLicense" 'string "always")

Related Topics

Software Product License Management Form: Ordering Tab

license VIVALicenseCheckoutOrder string "VIVA, ADE,Verifier"

license VLSXL_UseNextLicense string "prompt"

VSEL_UseNextLicense

license VSEL_UseNextLicense string "prompt"

Description

Sets the UseNextLicense value that controls whether to check out the next available license (Virtuoso_Schematic_Editor_XL) for Virtuoso Schematic Editor L or not.

Valid values are prompt, always, never. The default is prompt

GUI Equivalent

Command:	CIW – Options – License – Ordering – Schematic – L
Field:	UseNext

Examples

envGetVal("license" "VSEL_UseNextLicense ")

envSetVal("license" "VSEL_UseNextLicense " 'string "always")

Related Topics

Software Product License Management Form: Ordering Tab

VLSAdvStd_UseNextLicense

license VLSAdvStd_UseNextLicense string "prompt"

Description

Sets the UseNextLicense value that controls whether to check out the next available license (95512) for Virtuoso advanced node applications or not.

Valid values are prompt, always, never. The default is prompt

GUI Equivalent

Command:	CIW – Options – License – Ordering – Layout Option – 95512
Field:	UseNext

Examples

envGetVal("license" "VLSAdvStd_UseNextLicense)

envSetVal("license" "VLSAdvStd_UseNextLicense" 'string "always")

Related Topics

Software Product License Management Form: Ordering Tab

VLSAdvOpt_UseNextLicense

license VLSAdvStd_UseNextLicense string "prompt"

Description

Sets the UseNextLicense value that controls whether to check out the next available license (95511) for Virtuoso advanced node applications or not.

Valid values are prompt, always, never. The default is prompt

GUI Equivalent

Command:	CIW – Options – License – Ordering – Layout Option – 9511
Field:	UseNext

Examples

envGetVal("license" "VLSAdvOpt_UseNextLicense)

envSetVal("license" "VLSAdvOpt_UseNextLicense" 'string "always")

Related Topics

Software Product License Management Form: Ordering Tab

VIVA_UseNextLicense

license VIVA_UseNextLicense string "prompt"

Description

Sets the UseNextLicense value that controls whether to check out the next available license (Maestro), as per the specified checkout order for Virtuoso Visualization and Analysis XL or not.

Valid values are prompt, always, never. The default is prompt

GUI Equivalent

Command:	CIW – Options – License – Ordering – VIVA
Field:	UseNext

Examples

envGetVal("license" "VIVA_UseNextLicense)

envSetVal("license" "VIVA_UseNextLicense" 'string "always")

Related Topics

Software Product License Management Form: Ordering Tab

ADE_UseNextLicense

license ADE_UseNextLicense string "prompt"

Description

Sets the UseNextLicense value that controls whether to check out the next available license (Maestro: Virtuoso ADE Explorer/Virtuoso ADE Assembler) for Virtuoso Analog Design Environment product tiers or not.

Valid values are prompt, always, never. The default is prompt

GUI Equivalent

Command:	CIW – Options – License – Ordering – Maestro – Explorer
Field:	UseNext

Examples

envGetVal("license" "ADE_UseNextLicense)

envSetVal("license" "ADE_UseNextLicense" 'string "always")

Related Topics

Software Product License Management Form: Ordering Tab

adeMaestroCheckoutOrder

Explorer_UseNextLicense

license Explorer_UseNextLicense string "prompt"

Description

Sets the UseNextLicense value that controls whether to check out the next available license (Virtuoso ADE Assembler) for Virtuoso ADE Explorer or not.

Valid values are prompt, always, never. The default is prompt

GUI Equivalent

Command:	CIW – Options – License – Ordering – Maestro – Explorer
Field:	UseNext

Examples

envGetVal("license" "Explorer_UseNextLicense)

envSetVal("license" "Explorer_UseNextLicense" 'string "always")

Related Topics

Software Product License Management Form: Ordering Tab

maestroCheckoutOrder

Product Families and the Associated CheckoutOrder and UseNextLicense

For applications in product family tiers (such as, Layout, Schematic, and ADE), the checkout behavior is governed by both CheckoutOrder and UseNextLicense variable settings. If the license required for an application as per the CheckoutOrder is not available, the UseNextLicense variable for the product family controls whether the higher-tier license should be checked out or not.

The following table lists the product families and the associated CheckoutOrder and UseNextLicense variables:

Product Family	CheckoutOrder Variable	UseNextLicense Variable
Layout	VLSLicenseCheckoutOrder	VLSXL_UseNextLicense
Schematic	VSELicenseCheckoutOrder	VSEL_UseNextLicense
Virtuoso Advanced Node	VLSAdvOptLicenseCheckoutOrder	VLSAdvOpt_UseNextLicense
Maestro	maestroCheckoutOrder	Explorer_UseNextLicense
ADE/Maestro	adeMaestroCheckoutOrder	ADE_UseNextLicense
VIVA	VIVALicenseCheckoutOrder	VIVA_UseNextLicense

Other Licensing Variables

skipAMSEnvironmentLicCheck

license skipAMSEnvironmentLicCheck boolean nil

Description

Skips AMS_environment license check and uses ADE licenses instead.

The default is nil

This environment variable will be deprecated in a future release. Instead, use AMSEnvLicenseCheckoutOrder.

GUI Equivalent

None

Examples

envGetVal("license" "
skipAMSEnvironmentLicCheck
")

envSetVal("license" "
skipAMSEnvironmentLicCheck
" 'boolean t)

Related Topics

Return to top