Product Documentation
Virtuoso Studio Licensing and Configuration User Guide
Product Version IC23.1, September 2023

B


Virtuoso Studio Licensing and Configuration Forms

This topic lists the Virtuoso® Studio Licensing and Configuration forms.

Software Product License Management Form - Status Tab

Software Product License Management Form: Token Usage Tab

Software Product License Management Form: Ordering Tab

Software Product License Management Form: Diagnostics Tab

Software Product License Management Form: Performance Tests Tab

Software Product License Management Form - Status Tab

Displays the checked out and relevant licenses.

Field Description

Checked out Licenses

Lists the licenses that are currently checked out and their count.

Number

Specifies the license number. For example, 111, 95011, and 95115.

Product Name

Species the name of the product for which the license is checked out.

In Use

Specifies the number of licenses being used.

Relevant Licenses

Lists the DFII licenses relevant to all of the tools incorporated into the workbench.

Number

Specifies the license numbers of relevant licences. For example, 111, 95011, and 95115.

Product Name

Specifies the name of the products relevant to all of the tools incorporated into the workbench.

Users

Displays the License Use form the displays the license usage information (for example: user logins, host names, display time, number of licenses, and license version) for the selected licenses, independent of the license-checkout status. Information in this form is read from the license servers that are defined in the CDS_LIC_FILE and is extracted from more than one license server. If you do not have any licenses for a selected feature in any license file, the License Use form will display total and available licenses as “0”.

Refresh

Updates the Checked Out Licenses and Relevant Licenses lists to show the current list of products being run, and the respective license count, along with any changes to the available license list since the initial access of the Software Product License Management form.

Related Topics

Software Product License Management Form: Status Tab

Software Product License Management Form

Software Product License Management Form: Token Usage Tab

Displays the number of Virtuoso_LayoutSuite_GXL tokens required to run each capability and the respective usage status.

Field Description

Capability

Specifies the application for which the tokens are needed.

Tokens

Specifies the number of licenses needed to use a capability.

Version

Specifies the Virtuoso Studio release version.

Count

Specifies the number of tokens checked out.

Related Topics

Software Product License Management Form: Token Usage Tab

Software Product License Management Form

Software Product License Management Form: Ordering Tab

Provides an interface for defining the license checkout order of the Virtuoso Studio application tiers.

Field Description

Current Checkout Order

Displays the list of product families along with their current checkout order and UseNext settings.

Family

Lists the names of the product license families. For example, Schematic, Layout, Layout Option, ADE, AMSenv, VIVA, and EAD_DATASET.

To change the checkout order of a product family, click and drag the required tier up or down to move it to the desired location.

UseNext

Displays the UseNext setting, which controls whether to check out the next available license for Virtuoso tier-based applications when the license required for a requested application is not available.

If a tiered application has an associated UseNext setting, a drop-down list appears next to its name. If you reorder a tier within the product family, the UseNext drop-down moves along with it.

The UseNext drop-down list provides the following options:

  • prompt: Confirm before checking out a higher-tier license.
  • always: Always check out the higher-tier license (as per selected checkout order).
  • never: Never check out the higher-tier license and display an error message instead.

When prompt is set as the UseNext drop-down value and the license for a requested application is not available, the Next License dialog box displays, which lets you check out a higher tier license, subject to availability. Four options are offered: Session, Skip, Always, or Never.

  • Session: Checks out a higher-tier license, if available, for the current session. If a higher-tier license is unavailable, the Next License dialog box will only be displayed once. However, a new virtuoso session will cause the dialog box to display again.
    The Session option does not override the setting in the local .cdsenv file and updates only the internal or in-memory value of the corresponding UseNextLicense .cdsenv variable. Because of this, the Session response is applicable for the current session only. However, if you want to restore the Next License dialog box settings in the same session, reset the UseNextLicense .cdsenv variable to prompt using the envSetVal function in the CIW or select prompt from the UseNext drop-down list.
  • Skip: Skips the next license. For example, if L license is not available, and you click Skip in the Next License dialog box, the XL license will be skipped and an attempt to check out the GXL license will be made.
  • Always: Virtuoso will always try to check out the next license, if the requested license is not available. The Next License dialog box is not displayed again when virtuoso is restarted.
  • Never: Virtuoso will never try to check out the next license, if the requested license is not available. The Next License dialog box is not displayed again when virtuoso is restarted.
    The Always and Never options are stored in the following environment variables in ~/.cdsenv as soon as they are set.

For example:

license VLSXL_UseNextLicense string "prompt"/"always"/"never"
license VSEL_UseNextLicense string "prompt"/"always"/"never"

If a license is not available warning messages will be displayed in the CIW.

The settings selected in the Current Checkout Order pane are reflected in the .cdsenv variables CheckoutOrder and UseNextLicense.

Available Tiers

Displays all applicable tiers for each product family. However, you can choose to deselect a tier and remove it from the current checkout order list by dragging and moving it to Available Tiers.

If there is only one tier in the family tree, you are not allowed to remove it from the Current Checkout Order list by dragging and moving it to Available Tiers list, because a family tree cannot be empty.

Tier

List of available and applicable tiers in the right pane.

UseNext

Displays the value of the tier.

Save to File

Saves the selected options in the .cdsenv file. You can also edit your preferences in the.cdsenv file.

Related Topics

Software Product License Management Form: Ordering Tab

Software Product License Management Form

Software Product License Management Form: Diagnostics Tab

Provides an interface for setting the parameters needed for license-checkout reporting.

Field Description

The Diagnostics Tab Panes

Specifies information related to available and printer licenses along with their respective token capabilities.

Available License

Lists all available licenses.

Printed License

Displays a list of licenses selected for the detailed license-checkout report. When a license listed in the Printed licenses pane is checked out, a warning message will be output to the CIW.

You can select an appropriate license name from Available License pane and click the right arrow (-->) to move it to the Printed Licenses pane.

License feature “111” is printed by default in the Printed licenses pane as “111” is the required license for Virtuoso applications.

Available token capabilities

Displays the list of available token capabilities for the selected license type. You can list the token capabilities of a particular license by selecting the license name from the drop-down list box provided above this pane.

Printed token capabilities

Displays a list of token capabilities selected for the detailed license-checkout report. When a token capability listed in the Printed token capabilities pane is checked out, a warning message will be output to the CIW.

You can select an appropriate token capability from the Available token capabilities pane and click the right arrow (-->) to move it to the Printed token capabilities pane.

The selected printed licenses and token capabilities are used to set the value of the CDS_LIC_PRINT_FILTER shell variable.

The Diagnostics Tab Controls

The settings specified for the control options in this pane, update the values of the corresponding shell variables.

Timer interval

Sets the timeout interval (in number of seconds) for license search.

SHELL Variable: CDS_LIC_TIMER_INTERVAL

Print messages

Prints all license call-related messages. You can choose to display only warning messages, or both information and warning messages in the CIW.

SHELL Variable: CDS_LIC_PRINT_TYPE

Print checkout: time

Prints the time lapse during a license check-out process (in seconds).

SHELL Variable: CDS_LIC_PRINT_TIME

Show timeout dialog

Displays the timeout message box when the license-checkout time of a license feature exceeds the specified timer interval.

SHELL Variable: CDS_LIC_TIMEOUT_DIALOG and CDS_LIC_TIMER_INTERVAL

Always print checkout messages

Prints a checkout message when a particular license feature is checked out.

SHELL Variable: CDS_LIC_PRINT_ALWAYS

Related Topics

Software Product License Management Form: Diagnostics Tab

Software Product License Management Form

Software Product License Management Form: Performance Tests Tab

You can run a diagnostic test from the Performance Tests tab to test the license checkout performance on a feature-by-feature basis and across each server. This tab is an interface to the perf_test utility.

Field Description

Number

Specifies the license number. For example, 111, 95011, and 95115.

Product Name

Lists of all the DFII license features that are available for testing. You can select multiple license features for testing.

Type of tests

Specifies the type of test that to perform

  • Server Load determines the performance of a license server for a given number of clients (or subprocesses).
    You can select multiple license features for the server load test. However, the test will be performed for the first license feature only.
  • Network Latency determines the license-checkout performance on a feature-by-feature basis and across each server.
  • Checkout Performance displays the loop of checkout calls checking out the same feature with additional (upgrade) license for each iteration of the loop.
    The server maintains one job with a number of licenses over the course of this test. The first license server will be used if there are more than one servers specified in the license path.
  • Feature Exists Performance tests if the feature exists on the license server(s) specified in the license path (CDS_LIC_FILE).

Loop count

Specifies the loop count for checkout calls in the Loop Count field. This value is used for the checkout performance and server load tests; the default is 100.

Sub processes

Specifies the number of sub processes for the server in the Sub processes field. This value is used for the server load test; the default value is 50.

Repeat count

Specifies the test repeat count to rerun the tests <count> number of times in the Repeat count field.The default value is 1.

Repeat interval

Specifies the test repeat interval in the Repeat interval field. Valid only if Repeat count is specified. Reruns the tests every <interval> seconds. The default value is 3600 seconds (1hour).

XML output file

Specifies the XML file name in which you want to save the output results in the XML output file field.

Output directory

Specifies the directory name where you want to save the output results in the Output directory field.

If the specified directory does not exist, it is automatically created. When the output directory is specified, the XML file is saved in this directory.

Run tests

Starts the license-checkout performance test. After test completion the PerfTest Output window displays the test results.

While the performance test is running, license feature names in the left pane are temporarily disabled. These licenses become available only after the previous test run is complete.

Related Topics

Software Product License Management Form: Performance Tests Tab

Software Product License Management Form


Return to top
 ⠀
X