AA-specific tags

<< Click to Display Table of Contents >>

Navigation:  Modules > Asset Management > Software License Management > Authorization Analyzer (Complex license types) > AA Rule Definition (RD) >

AA-specific tags

In some functions, for text inputs and where tags are accepted, you can also use the AA-specific tag that is used to substitute one of many values that are specific to the AA.

The difference is that the AA-specific tag is delimited by square bracket-percent sign characters. General tags are delimited by curly bracket-percent sign characters.

 
The AA-specific tag takes one of the following forms:

 
1. Return the results of the rule definition specified

 [%<rule definition #>%]

Where <rule definition> is the RD number of the rule definition from which you wish to substitute the most recent results.  If the value in the tag is purely a numeric integer number, it will be interpreted as a rule definition number.

The entire tag will be replaced with the string result from the rule definition referenced.

 

2. Return a variable saved by a rule definition (currently only supported with Func57)

 [%<rule definition #>,<variable name>%]

Where <rule definition> is the RD number of the rule definition from which you wish to substitute the most recent results and <variable name> is one of the variables supported by the desired rule definition (see AA Functions for supported tags per function).  If the value in the tag is an integer followed by a comma, and then followed by a variable name, it will be interpreted as a variable lookup from the results of the desired rule definition's processing.

 

3. Return a pre-determined value

 [%<variable name>%]

This form of the tag will return a pre-determined value based on the variable name provided.  The following table shows the variable names available and the value that will be returned:

(Note where multiple variable names are shown, the names are interchangeable)
 

Variable Name(s)

Value returned

HOWAUTHORIZED, HOWAUTH, AUTHHOW, AUTHORIZEDHOW

Returns the text authorization reason (code) from the authorization record.

NOTE: In the case the the authorization record does not carry the reason code, the reason code comes from the MSL transaction log, which is a table that is kept trimmed to only the last 90 days' worth of activity.

RULEAUTHORIZED, RULEAUTH, AUTHRULE

Returns the rule number (rhNo) of the rule that originally created the authorization under test, or 0 if the authorization under test was not created by a rule.

VCORES, VIRTUALCORES

Cores of the asset associated with the authorization under test.  If the asset is physical, this will return the physical core count.  Otherwise, it will return the cores assigned to the VM.

VCORESALL,VIRTUALCORESALL

Sum of cores of all virtual assets (all assets marked as virtual and have a physical host computer name assigned) that have an active authorization for the MSL title under test.

PROCS, PROCESSORS, PHYSICALPROCESSORS

Number of processors of the physical asset associated with the authorization under test.

PROCSALL,PPROCSALL,PHYSICALPROCSALL,PHYSICALPROCESSORSALL

Sum of processors of all physical assets that have an active authorization for the MSL title under test.

CORES, PCORES, PHYSICALCORES

Cores of the physical asset associated with the authorization under test.

CORESALL,PCORESALL,PHYSICALCORESALL

Sum of cores of all physical assets that have an active authorization for the MSL title under test.

VPROCS, VPROCESSORS, VIRTUALPROCESSORS

Number of processors of the asset associated with the authorization under test.  If the asset is physical, this will return the physical processor count.  Otherwise, it will return the number of processors assigned to the VM.

VPROCSALL,VIRTUALPROCSALL,VIRTUALPROCESSORSALL

Sum of processors of all virtual assets (all assets marked as virtual and have a physical host computer name assigned) that have an active authorization for the MSL title under test.

PROCSLOTS, PROCESSORSLOTS

Number of processor slots (sockets) for the physical asset associated with the authorization under test.

PROCMFR, PROCESSORMFR, PROCESSORMANUFACTURER

Name (including manufacturer) of the physical processor of the asset associated with the authorization under test.

PARENT

Asset number of the parent (if defined) of the asset associated with the authorization under test.

PHYSICALCOMPUTERNAME, PCOMPUTERNAME, PDEVICENAME

Device or computer name of the physical parent (if defined) of the asset associated with the authorization under test.

VMS,VMSHOSTED

If the asset under test is marked as a physical machine, this tag will be replaced by the count of asset records whose PhysicalComputerName value matches the asset under test's ComputerName value and the records are marked as virtual machines.  The result is the number of virtual machines that are currently showing as being hosted on the asset under test.  If the asset under test is marked as a virtual machine, this tag will evaluate to 0.

VMEURSALL,VMLURSALL

Sum of Entitlement Units Required (EUR) across all authorizations for the physical machine associated with the authorization under test.  If the authorization under test is a VM, its physical host is checked along with all associated VMs for the presence of an authorization for the MSL title under test.  The sum of all EURs of all authorizations on the physical as well as any hosted VMs is returned.

CLUSTERHOSTS


Will resolve to a comma separated list of all the asset numbers for physical machines (hosts) that share the same cluster name as the asset associated with the authorization under test.

 

3. Return the value of a user-defined variable (created during the current AA session run)

 [%<user defined variable name>%]

The value of the matching user defined variable will be substituted for the tag.

 

4. Return a column from one of the records under test

 [%<table>.<column name>%]

Any tag with a "." character embedded within it will be interpreted as a <table>.<column> reference.  The following table names are valid:

"USER", "DATACONTACT", "CONTACT" - references the contact record (if any) associated with the authorization under test.

"AUTH", "AUTHORIZATION", "ATDATAASSETSXMANAGEDSW" - references the authorization under test record

"MSL", "MANAGEDSOFTWARE" - references the managed software record associated with the authorization under test.

Any other <table> reference defaults to referencing the asset record associated with the authorization under test.

Example: [%Assets.Processors%] will return the processor count for the asset associated with the authorization under test.

 

NOTE:  This form of the tag is used primarily by ESI as knowledge of the column names is required.

 

5. Return one value from the JSON results of the rule definition specified

 [%JRESULT,<rule definition #>,<tag name>%]

Where:  

o<rule definition #> is the RD number of the rule definition from which you wish to substitute the most recent results.

o<tag name> is the column name from the table row that is stored in the JSON results.

The entire tag will be replaced with the string result from the rule definition referenced.  This AA tag currently will only process the first row of the JSON results.