Data Elements

In the following tables, for each data element are indicated only the semantic tag and the type. The tables contain a concise listing of the data elements, with the indentation showing how the data elements are nested one within each other. For data elements of type STRUCT which appear in the table more than once, the indication of the components is done only the first time that they appear. For data elements of type LIST, the component can be repeated any number of times. The column labeled "Required" indicates if a data element is a required or an optional component of the data element in which it appears (the data elements where this column has been left blank are optional). The column labeled "Basic set" indicates if a data element belongs to the set of elements which must be supported by all the XSLM compliant Licensing System. All the data elements not in the Basic set are in the only functional tower presently defined, and their entry has been left blank.

For convenience, in the summary tables the data elements have been divided in three groups:

• The data elements that can appear on the physical certificate (that is, the one created by the application publisher)

• The data elements that are internally maintained by the Licensing System (which are referred to as state information)

• The data elements which are logged by the Licensing System and which become historic data.

Note that some data elements are repeated in the different tables. The final table provides a detailed description of all the data elements, arranged in alphabetical order.

Certificate Data Elements

State Information

Logged Data Elements

Detailed Data Element Descriptions

Data Element Name

Type

Basic Set

ID number

and followed by a description and a list of components.

ADMIN_RESET_COUNTER_LIST

LIST

no

1

This data element contains the list of counters (and their values) when the administrator resets them to their initial value.

Components:

COUNTER_UNITS

One required

ADMINISTRATOR

STRUCT

yes

2

This data element identifies the customer's license administrator performing an action. This information is provided to the License Server by the management agent client library.

Components:

ADMINISTRATOR_TYPE

Required

ADMINISTRATOR_ID

Required

ADMINISTRATOR_HWM_VALUE

FIXED

no

3

This data element contains the value of the Administrator High Water Mark (AHWM). The AHWM is the maximum number of reusable units simultaneously in use since the last time this value was reset to zero, and is logically the same quantity as counted by the Publisher HWM, the only difference being when they are reset, and by whom. At any time the AHWM can be reset to zero by the administrator with an xslm_set_admin_policy() call.

ADMINISTRATOR_ID

BSTR

no

4

This data element contains a byte string which uniquely identifies the customer's license administrator performing the action which led to the logging of this event. The exact meaning and format of the byte string is determined by the ADMINISTRATOR_TYPE data element. If the value of ADMINISTRATOR_TYPE data element is 1 (login name), the content of this data element must be parsed as if it was of type TEXT. This information is provided to the License Server by the management agent client library.

ADMINISTRATOR_NODE

STRUCT

yes

5

This data element specifies the node from which the administrator made a request to the Licensing System.

Components:

NODE_TYPE

Required

NODE_ID

Required

SUBNODE

Optional

ADMINISTRATOR_TYPE

FIXED

no

6

This data element indicates the format and the meaning of the ADMINISTRATOR_ID data element associated with it. The only instance type presently defined is:

Value = 1

Login name

ADVANCE_EXPIRATION_NOTIFICATION

INTVL

no

7

The presence of this data element in the certificate instructs the Licensing System to log a warning before the expiration of the actual license period. The lead time of the warning is the time period here specified, or a shorter period specified by the customer. If the Licensing System is capable of generating (implementation dependent) alerts, an alert should also be generated.

ADVANCE_EXPIRATION_NOTIFICATION_IN_USE

STRUCT

no

8

This data element consists of data elements which provide information about the publisher and/or customer requested advance notifications associated with the last date for which the application has been licensed.

Components:

PUBLISHER_ASSIGNED

    NOTIFICATION_DUE

Required

PUBLISHER_ASSIGNED

    NOTIFICATION_ISSUED

Optional

CUSTOMER_ASSIGNED

    NOTIFICATION_DUE

Optional

CUSTOMER_ASSIGNED

    NOTIFICATION_ISSUED

Optional

APPLICATION_ERROR_CODE

FIXED

no

9

This data element specifies the type of error, caused by the application, which was detected by the Licensing System.

ASSIGNABLE_CAPACITY

STRUCT

no

10

This data element specifies a capacity which must be assigned by the customer before the Licensing System can grant a license. The customer can assign any value up to the maximum value indicated in this data element.

Components:

CAPACITY

Required

NOT_REASSIGNABLE

Optional

ASSIGNABLE_CAPACITY_LIST

LIST

no

11

The presence of this data element in the certificate indicates that the customer is required to assign a value for all the capacities here specified before the Licensing System can grant a license to the application. The assignment will be done by the customer's license administrator by providing to the Licensing System a list of CAPACITY data elements.

Components:

ASSIGNABLE_CAPACITY

One required

ASSIGNABLE_CONSUMPTIVE_COUNTERS

LIST

no

12

The presence of this data element in the certificate indicates that the customer is required to assign a value to all the consumptive counters here specified before the Licensing System can grant a license to the application. The assignment will be done by the customer's license administrator by providing to the Licensing System a list of COUNTER_UNITS data elements. For each counter, the customer can assign any value up to the maximum number indicated in this data element.

Components:

COUNTER

One required

ASSIGNABLE_NODES

STRUCT

no

13

The presence of this data element in the certificate indicates that the customer is required to assign one or more nodes to this certificate before the Licensing System can grant a license to the application. The assignment will be done by the customer's license administrator by providing to the Licensing System a list of NODE data elements. The customer can assign any number of nodes up to the maximum number indicated in this data element. The publisher can specify also if an assigned NODE can be deleted (or substituted) from the list.

Components:

NUMBER_OF_NODES

Required

NOT_REASSIGNABLE

Optional

ASSIGNABLE_UNITS

STRUCT

no

14

The presence of this data element in the certificate indicates that the customer is required to specify a value for the "units of use" (which then will become available to the application) before the Licensing System can grant a license to the application. The assignment will be done by the customer's license administrator by providing to the Licensing System any value up to the maximum number indicated in this data element.

Components:

LICENSED_UNITS

Required

NOT_REASSIGNABLE

Optional

ASSIGNABLE_USERS

STRUCT

no

15

The presence of this data element in the certificate indicates that the customer is required to assign one or more users to this certificate before the Licensing System can grant a license to the application. The assignment will be done by the customer's license administrator by providing to the Licensing System a list of USER data elements. The customer can assign any number of users up to the maximum number indicated in this data element. The publisher can specify also if an assigned USER can be deleted (or substituted) from the list. All the assignments (and possibly deletions and substitutions) will be logged by the Licensing System.

Components:

NUMBER_OF_USERS

Required

LINKED_TO_NODE

Optional

NOT_REASSIGNABLE

Optional

ASSIGNED_ADVANCE_NOTIFICATION

INTVL

no

16

This data element is a customer assigned time interval which represents the lead time by which the Licensing System must log (issue) a license expiration warning. The value set by the administrator must be shorter than the one specified in the ADVANCE_EXPIRATION_NOTIFICATION data element present in the certificate.

ASSIGNED_CAPACITY_LIST

LIST

no

17

This data element contains the value of the capacities which have been assigned by the customer's license administrator as a consequence of the presence of the ASSIGNABLE_CAPACITY_LIST data element in the certificate. The value of the CAPACITY_UNITS contained in this data element is set by the xslm_set_admin_policy() call.

Components:

CAPACITY

Required

ASSIGNED_CONFIRM_INTERVAL

INTVL

no.

18

This data element specifies the confirm interval set by the license administrator for this certificate, when the CONFIRM_INTERVAL data element is present and the license administrator chooses a value within the CONFIRM_INTERVAL_RANGE. The value of this data element is set by the xslm_set_admin_policy() call.

ASSIGNED_CONSUMPTIVE_COUNTERS

LIST

no

19

This data element contains the list of consumptive counters (and their values) assigned by the administrator, when an assignment is required by the certificate. The value of the COUNTER_VALUE associated with this data element is set by the xslm_set_admin_policy() call.

Components:

COUNTER_UNITS

One required

ASSIGNED_LICENSED_UNITS

FIXED

no

20

This data element specifies the number of licensed units which have been assigned by the customer’s license administrator as a consequence of the presence of the ASSIGNABLE_UNITS data element in the certificate. The value of this data element is set by the xslm()_set_admin_policy call.

ASSIGNED_NODE_LIST

LIST

no

21

This data element contains the list of the nodes assigned by the administrator, when an assignment is required by the certificate.

Components:

NODE

One required

ASSIGNED_NODE_USER_LIST

LIST

no

22

This data element contains the list of users assigned by the administrator, when an assignment is required by the certificate. If the certificate further specifies that the users must be "linked to a node", this data element contains also the nodes to which the users have been linked.

Components:

NODE_USERS_ASSOCIATION

One required

AUTHENTICATION_KEY

STRUCT

no

23

This data element of the certificate contains the publisher's public key to be used by the Licensing System in order to verify the integrity of the certificate. The key can be provided just as a byte string (value of the AUTHENTICATION_TYPE data element equal to 1) or as part of a X.509 certificate (value of the AUTHENTICATION_TYPE data element equal to 2). In the latter case the Licensing System must support the X.509 certificate format provided in this data element.

Components:

X.509 defined

Required

AUTHENTICATION_SECTION

STRUCT

no

24

This data element of the certificate contains the information needed for the Licensing System to verify the integrity of the certificate, and for the application to verify its authenticity. The verification of the integrity is based on a message digest encrypted with a public private key encryption scheme.

Components:

AUTHENTICATION_TYPE

Required

AUTHNTICATION_KEY

Required

SIGNATURE

Required

AUTHENTICATION_TYPE

FIXED

no

25

This data element indicates which type of authentication scheme must be used by the Licensing System in order to verify the integrity of this certificate, and how the publisher's public key is being provided by this certificate. The only type presently specified is the validation based on a message digest encrypted with the publisher's private key, and verified by the Licensing System at certificate installation time by means of the publisher's public key provided on the certificate. If the value of this data element is equal to 1, the AUTHENTICATION_KEY data element contains just the key represented as a byte string; if the value of this data element is equal to 2, the AUTHENTICATION_KEY data element contains the complete X.509 certificate of the publisher.

Value = 1

Bare key

Value = 2

X.509 certificate

BASE_SECTION

STRUCT

yes

26

This data element is required on every certificate, and contains information about the application publisher, the licensed product and all other information used to grant licenses.

Components:

FUNCTIONAL_LEVEL

Required

CERTIFICATE_CREATED

Required

CERTIFICATE_ID

Required

CERTIFICATE_DESCRIPTION

Required

PUBLISHER_USE

Optional

REPLACE_CERTIFICATE

Optional

LIFE

Optional

DURATION

Optional

LICENSED_UNITS

Optional

PUBLISHER_CAPACITY_LIMITS_LIST

Optional

PUBLISHER_ASSIGNMENTS_LIST

Optional

CERTIFICATE_TARGET_NODES

Optional

CUSTOMER_ASSIGNABLE_LIMITS

Optional

COUNTERS_CONSUMPTIVE

Optional

COUNTERS_CUMULATIVE

Optional

CONFIRM_INTERVAL

Optional

NON_MASKABLE_EVENTS

Optional

RESETTING_FREQUENCY

Optional

LOCALLY_AVAILABLE

Optional

DEFAULT_UNITS_TO_GRANT

Optional

FORCE_RELEASE_OK

Optional

ADVANCE_EXPIRATION_NOTIFICATION

Optional

DISASTER_RECOVERY

Optional

MULTI_USE_ALLOWED

Optional

CAPACITY

STRUCT

no

27

This data element specifies the type of capacity and the value of the capacity which should not be exceeded in the node where the application is running.

Components:

CAPACITY_TYPE

Required

CAPACITY_UNITS

Required

CAPACITY_ADDITIONAL

Optional

CAPACITY_ADDITIONAL

FLOAT

no

28

This data element specifies an additional capacity value which can be used by the Licensing System to possibly grant a license (in "soft stop" mode) when the application is running on a node with a capacity greater than the one specified in the CAPACITY_UNITS data element (or in the customer assigned capacity value).

CAPACITY_IN_USE

LIST

no

29

This data element provides a list of data elements each of which specifies the total license capacity in use for this certificate at the current time.

Components:

CAPACITY

Required

CAPACITY_TYPE

FIXED

no

30

This data element indicates the format and the meaning of the CAPACITY_UNIT data element associated with it. The capacity types presently defined are:

Value = 1

MIPS

Value = 2

DASD

Value = 3

Memory

CAPACITY_UNITS

FLOAT

no

31

This data element specifies the capacity value which should not be exceed by the node where the application is running. This information is provided to the Licensing System by the application agent.

CERTIFICATE

STRUCT

yes

32

This is the major data element which encodes the terms and conditions under which the product identified in the certificate is licensed to a customer by the software publisher.

Components:

BASE_SECTION

Required

PUBLISHER_SECTION

Optional

LICENSING_SYSTEM_SECTION_LIST

Optional

AUTHENTICATION_SECTION

Optional

CERTIFICATE_CREATED

TIME

yes

33

This data element of the certificate contains the date and the time when this certificate was created by the application publisher

CERTIFICATE_DESCRIPTION

STRUCT

yes

34

This data element contains the textual representation of the components present in the CERTIFICATE_ID data element, to be used by the Licensing System or a management tool to display information about this certificate in a form more understandable for a human reader.

Components:

PUBLISHER_NAME

Required

PRODUCT_NAME

Required

VERSION_NAME

Required

FEATURE_NAME

Required

CERTIFICATE_ID

STRUCT

yes

35

This data element contains information which identify the publisher who created the certificate, the product this certificate refers to, and a certificate serial number. This information uniquely identify a certificate instance.

Components:

PUBLISHER_ID

Required

PRODUCT_ID

Required

VERSION_ID

Required

FEATURE_ID

Required

CERTIFICATE_SERIAL_NUMBER

Required

CERTIFICATE_INSTALLED

STRUCT

yes

36

This data element contains all the information related to the installation of this certificate.

Components:

INSTALL_DATE

Required

INSTALL_ANNOTATION

Required

ADMINISTRATOR

Required

ADMINISTRATOR_NODE

Required

CERTIFICATE_LIST

LIST

no

37

This data element consists of a list of certificates, related one to each other. If the list has only one certificate, this data element (and the GROUP_CERTIFICATE data element where it is contained) can be omitted.

Components:

CERTIFICATE

One required

CERTIFICATE_RELATED_INFORMATION

STRUCT

yes

38

This data element consists of those certificate related data elements that are not already present on the physical certificate. These data elements are returned by the get certificate call and provide the following types of certificate information: installation, replacement, license life, advanced notifications, confirm interval, status of optional log events, hard-stop status, disaster recovery status, customer assignments, in use values for licenses granted, capacity, counters and high water marks.

Components:

CERTIFICATE_UPDATE_SEQ

Required

CERTIFICATE_INSTALLED

Required

CERTIFICATE_REMOVED

Optional

DURATION_IN_USE

Optional

ADVANCE_EXPIRATION_NOTIF_IN_USE

Optional

CONFIRM_CERTIFICATE_INTERV.

Optional

MASKED_EVENTS

Optional

HARD_SOFT_STOP_INDICATOR

Optional

DISASTER_RECOVERY_INDICATOR

Optional

ASSIGNED_CONFIRM_INTERVAL

Optional

ASSIGNED_ADVANCE_NOTIFICATION

Optional

ASSIGNED_LICENSED_UNITS

Optional

ASSIGNED_NODE_LIST

Optional

ASSIGNED_NODE_USERS_LIST

Optional

ASSIGNED_CAPACITY_LIST

Optional

ASSIGNED_CONSUMPTIVE_COUNTERS

Optional

LICENSED_UNITS_CERTIFICATE_IN_USE

Required

ADMINISTRATOR_HWM_VALUE

Optional

PUBLISHER_HWM_VALUE

Optional

CAPACITY_IN_USE

Optional

COUNTERS_CONSUMPTIVE_IN_USE

Optional

COUNTERS_CUMULATIVE_IN_USE

Optional

CERTIFICATE_REMOVED

STRUCT

yes

39

This data element contains the information related to the removal or replacement of this certificate. To prevent reinstallation, a certificate can be deleted only at the end of the license duration. A certificate can be replaced at any time, which is equivalent to the deletion of the certificate being replaced, and the installation of the replacement certificate. The Licensing System must maintain information about the replaced certificate, to prevent its reinstallation.

Components:

REMOVED_DATE

Required

REMOVE_ANNOTATION

Required

ADMINISTRATOR

Required

ADMINISTRATOR_NODE

Required

CERTIFICATE_REPLACEMENT

Optional

CERTIFICATE_REPLACEMENT

STRUCT

no

40

This data element contains all the data elements related to the replacement of this certificate, including the replacement date and the certificate id of the replacement certificate.

Components:

REPLACEMENT_DATE

Required

CERTIFICATE_ID

Required

CERTIFICATE_SERIAL_NUMBER

FIXED

yes

41

The value of this data element contains a publisher specified certificate number, which must be unique within all the certificates for this same product, version and feature.

CERTIFICATE_TARGET_NODES

LIST

yes

42

The presence of this data element in the certificate indicates that this certificate can only be installed on one of the nodes specified by this data element. It is expected that the publisher will receive this information from the customer, before creating the certificate. If the data element is not present, the Licensing System will assume that the certificate can be installed on any node.

Components:

NODE

One required

CERTIFICATE_UPDATE_SEQUENCE

FIXED

yes

43

This data element contains the certificate's current update value. This value is an input parameter to the xslm_set_admin_policy() call and is updated every time this license certificate's values are updated by a xslm_set_admin_policy() call. The Licensing System will only update the certificate if the value passed by the xslm_set_admin_policy() call matches the value of this data element.

CLIENT_TIME_STAMP

TIME

yes

44

This data element contains the date and time at which the client library sent to the Licensing System a request which triggered the logging of an event. This information is given to the Licensing System by the client agent library (application or management). For those events where this information is missing or meaningless, it must be set to NULL.

CONFIRM_CERTIFICATE_INTERVAL_IN_USE

INTVL

yes

45

This data element specifies the value of the confirm interval that the Licensing System will use for this certificate. This value is dependent on the values of the ASSIGNED_CONFIRM_INTERVAL and the CONFIRM_INTERVAL data elements. The certificate's confirm interval is established in the following priority order: When present, the value of the ASSIGNED_CONFIRM_INTERVAL determines the confirm interval. If only the CONFIRM_INTERVAL data element is present, that value determines the confirm interval. If none of these data elements are present, the interval value is considered to be infinite.

CONFIRM_INSTANCE_INTERVAL_IN_USE

STRUCT

yes

46

This data element specifies the value of the confirm interval that the Licensing System will use for this license instance. The Licensing System will use the value of the CONFIRM_CERTIFICATE_INTERVAL_IN_USE data element for the license instance’s confirm interval value, whenever the request license and confirm calls do not provide a confirm interval value.

Components:

CONFIRM_INTERVAL_VALUE

Required

NEXT_CONFIRM_TIME

Required

CONFIRM_INTERVAL

STRUCT

yes

47

The presence of this data element in the certificate specifies the maximum elapsed time within which the license server should receive the next "confirm" call. If a "confirm" call is not received within this time, the Licensing System may assume that the application ended abnormally and may reclaim the reusable granted units (consumptive units are never reclaimed, as they are "consumed" when they are granted). The value of the confirm interval can be changed by the application (when issuing a "request license" or "confirm" call) or by the customer. This data element also specifies the range (minimum and maximum values) within which the customer may change the value of the confirm interval. In the absence of this data element, the Licensing System will assume that the confirm interval is infinite, unless a value is set by the application or by the customer. In this last case, the customer can set the confirm interval to any value.

If an application uses the basic API set, the certificate should contain a CONFIRM_INTERVAL_RANGE with CONFIRM_INTERVAL_MIN and CONFIRM_INTERVAL_MAX both set to the confirmation interval assumed by the application.

Components:

CONFIRM_INTERVAL_VALUE

Required

CONFIRM_INTERVAL_RANGE

Optional

CONFIRM_INTERVAL_MAX

INTVL

yes

48

This data element specifies the maximum value of the confirm interval which can be set by the customer. When the value of the confirm interval is set by the application, it is not subject to this maximum. If this data element is NULL or not present, the Licensing System will assume that the maximum value is infinite.

CONFIRM_INTERVAL_MIN

INTVL

yes

49

This data element specifies the minimum value of the confirm interval which can be set by the customer. When the value of the confirm interval is set by the application, it is not subject to this minimum. If this data element is NULL or not present, the Licensing System will assume that the minimum value is zero.

CONFIRM_INTERVAL_RANGE

STRUCT

yes

50

The presence of this data element indicates that the customer is allowed to set the confirm interval value only between a minimum and maximum value specified by this data element. In the absence of this data element, the Licensing System will assume that the customer can set the confirm interval at any value. An application may set any confirmation interval, no matter what value is set by the customer.

Components:

CONFIRM_INTERVAL_MIN

Optional

CONFIRM_INTERVAL_MAX

Optional

CONFIRM_INTERVAL_VALUE

INTVL

yes

51

The value of this data element specifies the maximum elapsed time within which the license server must receive the next "confirm" call. If a "confirm" call is not received within this time, the Licensing System may assume that the application ended abnormally and may reclaim the reusable granted units (consumptive units are never reclaimed, as they are "consumed" when they are granted). The value of the confirm interval can be changed by the application, when issuing a "request license" or "confirm" call, or by the customer.

COUNTER

STRUCT

no

52

This data element identifies a counter (either cumulative or consumptive) that the Licensing System will maintain. The value of a counter can be changed only by the application, via a "record" call. A counter can be reset to its initial value by the Licensing System (in so instructed in the certificate) or by the administrator (if so allowed in the certificate). A counter is identified by its COUNTER_ID, which is a publisher assigned integer, unique within the set of counters specified on the same certificate.

Components:

COUNTER_ID

Required

COUNTER_NAME

Required

COUNTER_VALUE

Required

COUNTER_RESETABLE

Optional

COUNTER_ADDITIONAL_VALUE

Optional

NOT_REASSIGNABLE

Optional

COUNTER_ADDITIONAL_VALUE

FLOAT

no

53

This data element specifies an additional consumptive counter value which can be used by the Licensing System to possibly grant a license (in "soft stop" mode) when the application is requesting a license and all the consumptive counters are negative by a value not greater than the value here specified.

COUNTER_ID

FIXED

no

54

The value of this data element is a publisher assigned integer which uniquely identifies this counter within the set of counters specified in this certificate.

COUNTER_NAME

TEXT

no

55

The value of this data element is a character string which can be used by Licensing System as an external representation of a counter.

COUNTER_RESETABLE

FIXED

no

56

If this data element is present, the customer will be able to reset the actual value of the counter to its initial value that is, the value specified in the certificate. In the case of consumptive counters appearing in the ASSIGNED_CONSUMPTIVE_COUNTERS data element, the resetting of the counter will satisfy the assignment required condition. When present, the value of this data element must be set to zero. If this data element is not present, the Licensing System will assume that the counter is not resettable.

COUNTER_UNITS

STRUCT

no

57

This data element specifies a counter and a value associated with it. Depending on the "parent" data element, this value may be either the actual value of the counter or the quantity by which the counter is being incremented or decremented.

Components:

COUNTER_ID

Required

COUNTER_VALUE

Required

COUNTER_UPDATE_UNITS

STRUCT

no

58

This data element specifies a counter and an update value associated with it. Depending on the type of counter, this value will be added (subtracted) to (from) the counter actual value.

Components:

COUNTER_ID

Required

COUNTER_VALUE

Required

COUNTER_VALUE

FLOAT

no

59

The value of this data element is a number which can represent the current value of a counter, or its initial value, or the maximum value which can be assigned to the counter by the customer, depending on the data element where COUNTER_VALUE appears.

COUNTERS_CONSUMPTIVE

LIST

no

60

The presence of this data element in the certificate indicates that the application will make use of consumptive counters, which will be maintained by the Licensing system. All the counters must have an initial value greater than zero. After an application has been granted a valid license, it will issue "record" calls to instruct the Licensing System to decrement a counter by a given amount (both the COUNTER_ID and the amount are specified in the "record" call). "Record" calls received when the counter is negative will be honored and the counter will be updated. If all the consumptive counters specified in this certificate are less than or equal to zero when a "request license" call is received, the license will not be granted.

Components:

COUNTER

One required

COUNTERS_CONSUMPTIVE_IN_USE

LIST

no

61

This data element provides a list of data elements each of which specifies current value of one of the consumptive counters in use for this certificate.

Components:

COUNTER_UNITS

Required

COUNTERS_CUMULATIVE

LIST

no

62

The presence of this data element indicates that the application will make use of cumulative counters, which will be maintained by the Licensing system. All the counters will have an initial positive or negative value. After an application has been granted a valid license, it will issue "record" calls to instruct the Licensing System to increment a counter by a given amount (both the COUNTER_ID and the amount are specified in the "record" call).

Components:

COUNTER

One required

COUNTERS_CUMULATIVE_IN_USE

LIST

no

63

This data element provides a list of data elements each of which specifies current value of one of the cumulative counters in use for this certificate.

Components:

COUNTER_UNITS

Required

CUSTOMER_ASSIGNABLE_LIMITS

STRUCT

no

64

The presence of this data element in the certificate indicates that the customer must assign a value to the data elements here indicated before the Licensing System can grant a license to the application. The customer can assign any value, up to the limit indicated in the data element.

Components:

ASSIGNABLE_UNITS

Optional

ASSIGNABLE_NODES

Optional

ASSIGNABLE_USERS

Optional

ASSIGNABLE_CAPACITY_LIST

Optional

ASSIGNABLE_CONSUMPTIVE_COUNTERS

Optional

CUSTOMER_ASSIGNED_NOTIFICATION_DUE

TIME

no

65

This data element specifies the date and time at which the customer has requested that the Licensing System log a warning indicating when the license will expire. If the Licensing System is capable of generating (implementation dependent) alerts, an alert should also be generated. The value of this data element is determined by the administrator through a xslm_set_admin_policy() call which specifies a time interval shorter than the one specified by the ADVANCE_EXPIRATION_NOTIFICATION data element. If the ADVANCE_EXPIRATION_NOTIFICATION data element is not present in the certificate, the administrator is not allowed to set any value, and no notification will be logged.

CUSTOMER_ASSIGNED_NOTIFICATION_ISSUED

TIME

no

66

This data element specifies the date and time at which the Licensing System logged a customer requested warning indicating when the license will expire. This data element is only present when the notification has been issued.

CUSTOMER_ASSIGNED_APPL_INFO

TEXT

no

67

Customer-defined application data. If defined within the certificate, this field is always customer-assignable

CUSTOMER_ASSIGNED_LIC_SYS_INFO

TEXT

no

68

Customer-defined licensing-system data. If defined within the certificate, this field is always customer-assignable

DATA_ELEMENT_ID

FIXED

yes

69

This data element specifies a Data Element ID value.

DEFAULT_UNITS_TO_GRANT

FIXED

no

70

The presence of this data element in the certificate specifies the number of units which will be granted when the application issues a "request license" call where the number of units requested is equal to "default units". If this data element is not present, the Licensing System will assume that the default number of units to grant is 1.

DISASTER_RECOVERY

INTVL

no

71

The presence of this data element in the certificate indicates that all restrictions specified on the certificate will be waived when the customer declares to the Licensing System (in an implementation dependent way) that the environment is now entering Disaster Recovery Mode. In this mode also the restrictions imposed by the CERTIFICATE_TARGET_NODES data element are waived. The Licensing System will resume enforcement of the restrictions specified on this certificate when the maximum duration here specified is elapsed or when Disaster Recovery Mode has ended, whichever occurs first.

DISASTER_RECOVERY_END

TIME

no

72

This data element specifies the date and time on which this certificate will no longer honor disaster recovery mode. This data element value is dependent on the values of the DISASTER_RECOVERY_START and DISASTER_RECOVERY data elements.

DISASTER_RECOVERY_INDICATOR

STRUCT

no

73

This data element contains data elements which track the start of disaster recovery mode for a certificate and the date on which disaster recovery mode is no longer honored by this certificate.

Components:

DISASTER_RECOVERY_START

Required

DISASTER_RECOVERY_END

Required

DISASTER_RECOVERY_MODE

FIXED

no

74

This data element indicates how the administrator set the Disaster Recovery Mode.

Value = 1

Disaster recovery start

Value = 2

Disaster recovery end

DISASTER_RECOVERY_SERVER_INDICATOR

STRUCT

no

75

The presence of this data element indicates that this server is currently in "disaster recovery" mode and will ignore all restrictions for those certificates which contain the DISASTER_RECOVERY data element for the interval specified in this certificate data element.

Components:

DISASTER_RECOVERY_START

Required

ADMINISTRATOR

Required

DISASTER_RECOVERY_START

TIME

no

76

This data element specifies the date and time on which the customer's license administrator declared "disaster recovery mode" to the Licensing System

DURATION

STRUCT

yes

77

The presence of this data element in the certificate specifies the period (as a time interval) during which the application is licensed to the customer. The beginning of this period will be either at the time the certificate is installed or the first time that the application will run and will issue a "request license" call. If this data element is not present, the Licensing System will assume that the duration is the same as the certificate life, and it will start at certificate installation.

Components:

DURATION_PERIOD

Required

DURATION_START_TYPE

Required

DURATION_ADDITIONAL

Optional

DURATION_ADDITIONAL

INTVL

yes

78

This data element specifies an additional duration of the certificate which can be used by the Licensing System to possibly grant a license (in "soft stop" mode) if the application requests a license and the duration period has not expired by more than the time interval here specified. This can be used by the application publisher to provide the customer with a "grace period".

DURATION_END_IN_USE

TIME

yes

79

This data element specifies the actual end date and time for which this certificate is valid. The value of this element is dependent on the presence and values of the DURATION data element.

DURATION_IN_USE

STRUCT

yes

80

This data element consists of the data elements which provide information about the certificate's actual duration.

Components:

DURATION_START_IN_USE

Required

DURATION_END_IN_USE

Required

DURATION_PERIOD

INTVL

yes

81

This data element specifies the period (as a time interval) during which the application is licensed to the customer. The beginning of this period will be either at the time the certificate is installed or the first time that the application will run and will issue a "request license" call, depending on the DURATION_START_TYPE data element.

DURATION_START_IN_USE

TIME

yes

82

This data element specifies the actual start date and time for which this certificate is valid. The value of this data element may be either the date on which the certificate was installed or the date on which the certificate was first used, depending on the value of DURATION_START_TYPE data element present on the certificate.

DURATION_START_TYPE

FIXED

yes

83

This data element specifies if the period during which the application is licensed (DURATION_PERIOD data element) will start at certificate installation or at certificate first use (the first time that the application issues a "request license" call). In both cases the life of the certificate will be extended, if needed, until the end of the duration period.

Value = 1

Start date at certificate installation

Value = 2

Start date at first certificate use

EVENT

STRUCT

yes

84

This data element uniquely identifies a category of events by specifying their class, type and subtype. The EVENT_CLASS data element is required. If one or both of the other data elements are omitted (or specified as NULL) the Licensing System will assume that this data element specifies all the events of the specified class, or all the events of the specified class and type.

Components:

EVENT_CLASS

Required

EVENT_TYPE

Optional

EVENT_SUBTYPE

Optional

EVENT_CLASS

FIXED

yes

85

This data element specifies a class of events that can be logged by the Licensing System

Value = 1

Administration

Value = 2

Application

Value = 3

Licensing System

Value = 9 (XSLM_LOGCLASS_ANY)

Any event class

EVENT_SUBTYPE

FIXED

yes

86

This data element specifies a subtype of events (within a given class and a given type), that can be logged by the Licensing System.

Value = 0

NULL

Value = 10

New

Value = 11

Replace

Value = 20

Units

Value = 21

Nodes

Value = 22

Users

Value = 23

Capacity

Value = 24

Consumptive counters

Value = 30

Hard soft stop

Value = 31

Confirm interval

Value = 32

Advance notification

Value = 33

Reset administrator HWM

Value = 34

Reset counters

Value = 35

Mask events

Value = 36

Release units

Value = 37

Disaster recovery

Value = 40

Granted

Value = 41

Denied

Value = 42

Consumptive

Value = 43

Consumptive zero crossing

Value = 44

Consumptive underflow

Value = 45

Cumulative

Value = 46

Cumulative overflow

Value = 47

Cumulative zero crossing

Value = 50

Publisher high water mark

Value = 51

Counters

Value = 53

System

Value =999 (XSLM_LOGSUBTYPE_ANY)

Any event subtype

EVENT_TYPE

FIXED

yes

87

This data element specifies a type of events (within a given class), that can be logged by the Licensing System.

Value = 1

Install

Value = 2

Delete

Value = 3

Assign

Value = 4

Set policy

Value = 11

Log message

Value = 12

Request license

Value = 13

Release license

Value = 14

Confirm

Value = 15

Record

Value = 16

Begin session

Value = 17

End session

Value = 21

License server start

Value = 22

License server stop

Value = 23

Reset

Value = 24

Expiration warning

Value = 25

Errors

Value =99 (XSLM_LOGTYPE_ANY)

Any event type

FEATURE

STRUCT

yes

88

This data element describes a feature by ID and name.

Components:

FEATURE-ID

Required

FEATURE_NAME

Required

FEATURE_ID

FIXED

yes

89

The value of this data element is a publisher defined integer which uniquely identifies the feature of the product among all the other features of this product.

FEATURE_NAME

TEXT

yes

90

The value of this data element is the textual representation of the version of the product for which this certificate was created, normally used by the Licensing System or a management tool to provide external information about the product in a human readable form.

FORCE_RELEASE_OK

FIXED

no

91

The presence of this data element in the certificate indicates that the administrator can instruct the Licensing System to release the reusable units presently in use by the application. This capability can be useful when the customer may have knowledge that the application is no longer running, while the Licensing System is not aware of this fact. If this data element is not present, the units in use can only be released by the Licensing System when a "confirm" call has failed. The value of this data element must be set to zero.

FORCED_RELEASE_UNITS

FIXED

no

92

This data element contains the number of reusable units which have been released by the administrator.

FUNCTIONAL_LEVEL

STRUCT

yes

93

When used within a license certificate, this data element specifies the minimum level of functionality that a license server must have in order to support this license certificate. If the license server does not have this level of functionality, the certificate will not be installed. This data element also specifies the functional level supported by a license server, and is part of the information maintained by the Licensing System for each license server. This information is returned to a management application in response to the xslm_query_api_level() and xslm_query_servers() calls.

Components:

FUNCTIONAL_SPECIFICATION_LEVEL

Required

FUNCTIONAL_TOWER_LIST

Required

FUNCTIONAL_SPECIFICATION_LEVEL

FIXED

yes

94

This data element specifies the specification revision level supported by a license server. A certificate can be installed only by license servers which support at least the functional level specified in the certificate.

The current specification is defined as Value = 1.

FUNCTIONAL_TOWER

FIXED

yes

95

This data element identifies a functional tower supported by a license server. The functional capabilities of the functional towers are defined in the specifications with the revision level indicated in the SPECIFICATION_LEVEL data element. A certificate can be installed only by license servers which support all the functional towers specified in the certificate.

Note that:

1. All license servers must support Basic (Legacy) XMAPI and Basic XLCA.

2. The Advanced XAAPI includes the Basic XAAPI.

Value = 1

Basic XAAPI

Value = 2

Advanced XAAPI

Value = 3

Advanced XMAPI

Value = 4

Advanced XLCA

FUNCTIONAL_TOWER_LIST

LIST

yes

96

This data element specifies a list of functional towers supported by a license server. A certificate can be installed only by license servers which support all the functional towers specified on the certificate

Components:

FUNCTIONAL_TOWER

One required

GRANTED_UNITS

FIXED

yes

97

This data element contains the number of licensed units which have been granted by the Licensing System after receiving a "request license" call from an application. In some cases this number may be different from the number of units requested.

GROUP_AUTHENTICATION_SECTION

STRUCT

no

98

This data element contains the authentication information for all the certificates contained in the GROUP_CERTIFICATE data element. This information will allow the Licensing System to verify the integrity of the certificate, and will allow the application to verify its authenticity. The verification is based on a public private key encryption scheme.

Components:

AUTHENTICATION_TYPE

Required

AUTHENTICATION_KEY

Required

SIGNATURE

Required

GROUP_CERTIFICATE

STRUCT

no

99

This data element consists of a number of complete certificates related one to each other, and an optional global authentication section with the signature of the group of certificates. If only one certificate is present, this data element may be omitted.

Components:

CERTIFICATE_LIST

Required

GROUP_AUTHENTICATION_SECTION

Optional

GROUP_TYPE

FIXED

no

100

This data element identifies the type of relationship that exists between the individual certificates in a group certificate.

Value = 0

Bundle

Value = 1

Suite

HARD_SOFT_STOP_INDICATOR

FIXED

yes

101

This data element specifies whether or not the administrator has placed this certificate in "hard stop" mode. When in "hard stop" mode the Licensing System ignores the values in the following data elements: LICENSED_ADDITIONAL_UNITS, CAPACITY_ADDITIONAL, COUNTER_ADDITIONAL_VALUE and DURATION_ADDITIONAL. The value of this data element is set by the xslm_set_admin_policy() call.

Value = 0

Soft stop mode

Value = 1

Hard stop mode

HARD_SOFT_STOP_POLICY

FIXED

yes

102

This data element indicates how the administrator set the hard soft stop policy (at the time this event was logged). In administrator set "hard stop mode" the Licensing System will not make use of any "additional" quantities in order to return a "license granted in soft stop mode". The administrator can change this policy any number of times.

Value = 1

Soft stop mode

Value = 2

Hard stop mode

INSTALL_ANNOTATION

TEXT

yes

103

This data element contains any descriptive text which the administrator chooses to provide when installing this certificate. The value of this data element is set by the xslm_set_admin_policy() call.

INSTALL_DATE

TIME

yes

104

This data element specifies the date and time at which this certificate was installed by the Licensing System.

LICENSE_ADMINISTRATOR

STRUCT

yes

105

This data element describes each license administrator defined to this license server. The values for the ADMINISTRATOR_TYPE and ADMINISTRATOR_ID_STRING associated with this data element are set by the xslm_set_admin_policy() call.

Components:

ADMINISTRATOR

Required

ADMINISTRATOR_CAPABILITIES_LIST

Required

ADMINISTRATOR_CREATION_DATE

Required

LICENSE_ADMINISTRATOR_LIST

LIST

yes

106

This data element lists the license administrators defined to this license server.

Components:

LICENSE_ADMINISTRATOR

Required

LICENSE_INSTANCE_ID

STRUCT

yes

107

This data element consists of the data elements which uniquely identify a license instance.

Components:

CERTIFICATE_ID

Required

INSTANCE_NUMBER

Required

LICENSE_INSTANCE_INFORMATION

STRUCT

yes

108

This data element consists of the set of data elements containing information about license instances. These data elements are returned by the "get license instances" call and provide the following types of instance information: instance id, handles, license units in use, confirm interval, user id and node id of license requester.

Components:

LICENSE_INSTANCE_ID

Required

SESSION_HANDLE

Required

TRANSACTION_HANDLE

Required

LICENSED_UNITS_INSTANCE_IN_USE

Required

CONFIRM_INSTANCE_INTERVAL_IN_USE

Required

REQUESTOR_ID

Required

USERID_FROM_API

Optional

LICENSE_INSTANCE_INFORMATION_LIST

LIST

yes

109

This data element contains a list of license instances, and is returned as answer to a "get license instances" call.

Components:

LICENSE_INSTANCE_INFORMATION

One required

LICENSE_INSTANCE_NUMBER

FIXED

yes

110

This data element specifies a value provided by the Licensing System which uniquely differentiates this license instance from all other license instances associated with a specific certificate.

LICENSE_SERVER_DATA_ELEMENTS

LIST

yes

111

This data element contains a list of all the data element IDs supported by this licensed server. This data element is returned from the xslm_query_server_info() call.

Components:

DATA_ELEMENT_ID

One required

LICENSE_SERVER_ID

STRUCT

no

112

This data element uniquely identifies the License Server responsible for the logging of this event.

Components:

LICENSING_SYSTEM_PUBLISHER_ID

Required

LICENSE_SERVER_INSTANCE_ID

Required

FUNCTIONAL_LEVEL

Required

NODE

Required

LICENSE_SERVER_INFORMATION

STRUCT

yes

113

This data element consists of the data elements that describe the license server and its level, the license server's disaster recovery indicator setting, and the license administrators registered to this license server to use the management API. These data elements are returned by the 'query servers' call.

Components:

LICENSE_SERVER_ID

Required

LICENSE_SERVER_DATA_ELEMENTS

Required

SERVER_START

Required

SERVER_LAST_STOP

Required

DISASTER_RECOVERY_SERVER_INDICATOR

Required

LICENSE_ADMINISTRATOR_LIST

Required

LICENSE_SERVER_INSTANCE_ID

UUID

yes

114

This data element identifies the instance of a License Server running on a node. This information is usually provided to the License Server by the Operating System.

LIC_SYS_INFO_DATA

BSTR

yes

115

The data described by the associated LIC_SYS_INFO_DESCRIPTOR element.

LIC_SYS_INFO_DESCRIPTOR

UUID

yes

116

A unique identification, describing the format of data contained in the associated LIC_SYS_INFO_DATA element.

LICENSE_SYSTEM_INFO

STRUCT

yes

117

This data element contains optional information recorded by the licensing system as part of a log record. The contents and format of the information is entirely up to the licensing system.

Components:

LIC_SYS_INFO_DESCRIPTOR

Required

LIC_SYS_INFO_DATA

Required

LICENSED_ADDITIONAL_UNITS

FIXED

yes

118

The value of this data element is a number of additional "units of use" which can be used by the Licensing System to grant a license (in "soft stop" mode) when the number of units requested by the application (with a "request license" call) is greater than the number of available units.

LICENSED_UNIT_NUMBER

FIXED

yes

119

The value of this data element is the number of "licensed units" which are available to the application. The Licensing System will grant a license to an application issuing a "request license" call if the number of units requested is smaller or equal to the number of available units, and will decrease the number of available units by the granted amount. If the units are reusable the number of available units is increased by the granted amount when the application issues a "release license" call. If the units are non-reusable the number of available units is not increased when the application issues a "release license call", as the units have been "consumed" by the application when they have been granted.

LICENSED_UNIT_TYPE

FIXED

yes

120

If the value of this data element is equal to 1 the "licensed units" are reusable, that is, the number of available units is increased by the granted amount when the application issues a "release license" call. If the value of this data element is equal to 2 the "licensed units" are non-reusable, that is, the number of available units is not increased when the application issues a "release license call", as the units have been "consumed" by the application when they have been granted.

Value = 1

Reusable units

Value = 2

Non-reusable units

LICENSED_UNITS

STRUCT

yes

121

This data element of the certificate provides the number of "licensed units" which are available to the licensed application. The units can be reusable, in which case the number of available units is increased by the granted amount when the application issues a "release license" call, or can be non-reusable, in which case the number of available units is not increased when the application issues a "release license call". This data element may contain an additional number of "licensed units", to be used by the Licensing System to grant a license when the number of units requested by the application with a "request license" call is greater than the number of available units. In this case a status will be set to indicate that the license was granted in a "soft stop" condition. If this data element is not present, the Licensing System will assume that the number of "licensed units" is infinite.

Components:

LICENSED_UNIT_TYPE

Required

LICENSED_UNIT_NUMBER

Required

LICENSED_ADDITIONAL_UNITS

Optional

LICENSED_UNITS_CERTIFICATE_IN_USE

FIXED

yes

122

This data element specifies the total number of license units granted for this certificate. When the LICENSED_UNIT_TYPE data element specifies "reusable" units, this data element represents the current number of licensed units in use at this time. When the LICENSED_UNIT_TYPE data element specifies "non-reusable" units, this data element represents the total number of licensed units requested and consumed as this point in time.

LICENSED_UNITS_INSTANCE_IN_USE

FIXED

yes

123

This data element specifies the total number of license units granted for this license instance.

LICENSING_SYSTEM_PUBLISHER

STRUCT

no

124

This data element uniquely identifies a publisher of a Licensing System. It can appear in the certificate (as a component of the LICENSING_SYSTEM_SECTION data element), and is also maintained by the Licensing System as a component of the LICENSE_SERVER_ID data element.

Components:

PUBLISHER_ID

Required

PUBLISHER_NAME

Required

LICENSING_SYSTEM_SECTION

STRUCT

no

125

This data element of the certificate contains information defined for a particular Licensing System, and in general their meaning is understood only by the Licensing System which defines them. Required components of this data element are the ID and the name of the Licensing System publisher, in addition to the Licensing System specific information.

Components:

LICENSING_SYSTEM_PUBLISHER

Required

LICENSING_SYSTEM_SPECIFIC_INFO

Required

LICENSING_SYSTEM_SECTION_LIST

LIST

no

126

This data element of the certificate contains a list of sections, each one specific to a particular Licensing System. If this data element is present, the certificate can only be installed by a Licensing System which supports at least one of the sections.

Components:

LICENSING_SYSTEM_SECTION

One required

LICENSING_SYSTEM_SPECIFIC_INFO

STRUCT

no

127

This data element of the certificate contains information whose exact format and meaning are defined by the Licensing System publisher.

Components:

Licensing System publisher defined

Required

LIFE

STRUCT

yes

128

The presence of this data element in the certificate specifies the time span during which this certificate is valid, that is, it can be used. The certificate can be installed at any time, but no licenses will be granted before the certificate life start date or after the certificate life end date. In the absence of this data element the Licensing System will assume that the certificate is always valid.

Components:

LIFE_START

Optional

LIFE_END

Optional

LIFE_END

TIME

yes

129

This data element specifies the date when the validity of this certificate will end. After this date no licenses will be granted and the certificate can be deleted from the Licensing System. The actual end date of the certificate life can possibly be extended by the time interval specified in the DURATION data element, if the activation of the license was done just before the certificate life end date. If this data element is not present or is specified as NULL, the Licensing System will assume that the certificate will never expire.

LIFE_START

TIME

yes

130

This data element specifies the date when the validity of this certificate will start. The certificate can be installed at any time, but before this date no licenses will be granted. If this data element is not present or is specified as NULL, licenses can be granted immediately after installation.

LINKED_TO_NODE

FIXED

no

131

The presence of this data element in the certificate (as an optional component of the ASSIGNABLE_USERS data element) indicates that the customer must also specify a node to which the named users are assigned. The value of this data element must be set to zero.

LOCALLY_AVAILABLE

FIXED

no

132

The presence of this data element in the certificate indicates that this certificate must be "locally" available to the application, that is, the application should be able to request and release licenses without the need of accessing a network. How this is accomplished is implementation dependent. The value of this data element must be set to zero.

LOGGED_DATA

STRUCT

yes

133

This data element contains data specific to the event being logged. The components of this data element depend on the Class, Type and Subtype of the event being logged. The chapter on Recording and Logging specifies which data elements are required for each combination of Class, Type and Subtype.

Components:

ADMINISTRATOR

Optional

ADMINISTRATOR_NODE

Optional

CERTIFICATE_ID

Optional

INSTALL_ANNOTATION

Optional

REMOVE_ANNOTATION

Optional

REPLACE_CERTIFICATE

Optional

ASSIGNED_LICENSE_UNITS

Optional

ASSIGNED_NODE_LIST

Optional

ASSIGNED_NODE_USERS_LIST

Optional

ASSIGNED_CAPACITY_LIST

Optional

ASSIGNED_CONSUMPTIVE_COUNTERS

Optional

HARD_SOFT_STOP_POLICY

Optional

ASSIGNED_ADVANCE_NOTIFICATION

Optional

CONFIRM_INTERVAL_VALUE

Optional

ADMINISTRATOR_HWM_VALUE

Optional

ADMIN_RESET_COUNTER_LIST

Optional

MASKED_EVENTS

Optional

FORCED_RELEASE_UNITS

Optional

DISASTER_RECOVERY_MODE

Optional

REQUESTOR_ID

Optional

USER_ID_FROM_API

Optional

SESSION_HANDLE

Optional

TRANSACTION_HANDLE

Optional

LOGGED_MESSAGE

Optional

REQUESTED_UNITS

Optional

GRANTED_UNITS

Optional

RETURNED_UNITS

Optional

RETURN_STATUS

Optional

COUNTER_UNITS

Optional

COUNTER_UPDATE_UNITS

Optional

PUBLISHER_HWM_VALUE

Optional

SYSTEM_RESET_COUNTER_LIST

Optional

DURATION_END_IN_USE

Optional

APPLICATION_ERROR_CODE

Optional

SYSTEM_ERROR_CODE

Optional

LOGGED_EVENT

STRUCT

yes

134

This data element contains all the information for an event which is being logged by a specific License Server of a Licensing System. This information is comprised of a set of components which are the same for all the events (the first six components listed below) and a component (namely LOGGED_DATA) whose contents depends on the Class, Type and Subtype of the event being logged.

Components:

EVENT_CLASS

Required

EVENT_TYPE

Required

EVENT_SUBTYPE

Required

LICENSE_SERVER_ID

Required

SERVER_TIME_STAMP

Required

CLIENT_TIME_STAMP

Required

LOGGED_DATA

Required

LOGGED_MESSAGE

TEXT

yes

135

This data element contains the text string which has been passed to the Licensing System by the application, in order for it to be logged.

MASKED_EVENTS

LIST

yes

136

This data element consists of a list of the optional events for this certificate which the administrator requested not to log.

Components:

EVENT

One required

MULTI_USE_ALLOWED

FIXED

no

137

The presence of this data element in the certificate indicates that, for reusable licensed units, the Licensing System must grant a license without increasing the number of units in use (that is, without using any of the available units) when the requesting application satisfies the conditions indicated by the value of this data element.

Value~=~1

The request comes from the same node as a previous request

Value~=~2

The request comes from the same user as a previous request

Value~=~3

The request comes from the same user and the same node as a previous request

NEXT_CONFIRM_TIME

TIME

yes

138

This data element specifies the next date and time by which the application associated with this license instance must issue a "confirm" call, otherwise the Licensing System may assume that the application ended abnormally and may reclaim any reusable licenses in use by this license instance.

NODE

STRUCT

yes

139

This data element specifies a node, and its meaning depends on the data element where it appears. If it appears in the certificate (as a component of CERTIFICATE_TARGET_NODES or NODE_USERS_ASSOCIATION), it specifies a node where the application must run in order to be granted a license. At run time, the information about the node where the application is running is provided to the Licensing System by the application agent, in addition to the information provide by the application through the parameters of the API calls. This information is usually platform dependent, and the publisher may have to receive this information from the customer before creating the certificate. Otherwise NODE, for information purposes, will indicate the node where the application is running, or a license server is running, or a management application is running.

Components:

NODE_TYPE

Required

NODE_ID

Required

SUBNODE

Optional

NODE_ID

BSTR

yes

140

This data element contains a byte string which uniquely identifies a node where the application is licensed to run. The exact meaning and format of the byte string is determined by the NODE_TYPE data element. At run time, this information is provided to the Licensing System by the application agent, or the management agent, or the Operating System.

NODE_TYPE

FIXED

yes

141

This data element indicates the format and the meaning of the NODE_ID data element associated with it. The node types presently defined are:

Value = 1

System board serial number

Value = 2

Network interface MAC address

Value = 3

External Hardware Key

Value = 4

Operating System provided

Value = 5

Licensing System provided

NODE_USERS_ASSOCIATION

STRUCT

no

142

This data element indicates a node where the application must (will) run in order to be granted a license, and a list of users which are licensed to use this application. When the application issues a "request license" call, the Licensing System will grant a license (provided that all other conditions are met) only if the application is running the specified node, and is being used by one of the specified users. The information about the node where the application is running is provided to the Licensing System by the application agent (not the application itself). The information about the user of the application can be provided by the application itself (as one of the parameter of the "request license" call) or by the application agent. This data element can be specified in the certificate by the application publisher, or can be defined by the administrator, if so requested in the certificate (ASSIGNABLE_NODES and ASSIGNABLE_USERS).

Components:

NODE

Required

USER_LIST

Required

NON_MASKABLE_EVENTS

LIST

yes

143

If this data element is present in the certificate, the Licensing System will not allow a license administrator to mask the logging of the optional events listed in this data element. If this data element is not present, the logging of all the events defined as optional will be under the control of the license administrator.

Components:

EVENT

One required

NOT_REASSIGNABLE

FIXED

no

144

The presence of this data element in the certificate indicates that the assignment specified in the parent data element, once done by the customer's license administrator, cannot be "undone", that is, the assignment become permanent and its value cannot be changed. If this data element is not present, the Licensing System will assume that the administrator is allowed to perform the assignment operation any number of times. The value of this data element must be set to one.

NUMBER_OF_NODES

FIXED

no

145

This data element indicates the maximum number of nodes that the customer can assign to this certificate. If this data element is present in the certificate, the customer is required to assign at least one node.

NUMBER_OF_USERS

FIXED

no

146

This data element indicates the maximum number of named users that the customer can assign to this certificate. If this data element is present in the certificate, the customer is required to assign at least one named user.

PRODUCT

STRUCT

yes

147

This data element describes a product by ID and name.

Components:

PRODUCT_ID

Required

PRODUCT_NAME

Required

PRODUCT_ID

FIXED

yes

148

The value of this data element is a publisher defined integer which uniquely identifies this product among all the other products of this publisher.

PRODUCT_NAME

TEXT

yes

149

The value of this data element is the textual representation of the name of the product for which this certificate was created, normally used by the Licensing System or a management tool to provide external information about the product in a human readable form.

PUBLISHER_ASSIGNED_NOTIFICATION_DUE

TIME

no

150

This data element specifies the date and time at which the publisher has requested that the Licensing System log a warning indicating when the license will expire. If the Licensing System is capable of generating (implementation dependent) alerts, an alert should also be generated.

PUBLISHER_ASSIGNED_NOTIFICATION_ISSUED

TIME

no

151

This data element specifies the date and time at which the Licensing System logged a publisher requested warning indicating when this certificate will expire. This data element is only present when the notification has been issued.

PUBLISHER_ASSIGNMENTS_LIST

LIST

no

152

The presence of this data element in the certificate indicates that the use of the application has been restricted to the set of users here specified, and can only run on the nodes here specified. Each data element of the list associates a node with a list of users. The application can only be used by those users identified in the user list, when the application is running on the specified node. The node can be indicated as NULL, and the meaning is that the application can only be used by those users identified in the user list, regardless of where the application is running. The list of users can be indicated as NULL, and the meaning is that the application can be used by any user when it is running on the specified node. The restrictions specified in each node-users association are independent one from the other.

If this data element is not present, the Licensing System will assume that the application can run on any node and can be used by any user.

Components:

NODE_USERS_ASSOCIATION

One required

PUBLISHER_CAPACITY_LIMITS_LIST

LIST

no

153

The presence of this data element in the certificate indicates that the application is licensed to run on nodes which do not exceed the capacity limits specified by this data element. The capacity can be based on CPU power such as MIPS, or memory size, or megabytes of storage and the like. The information about the capacity of the node where the application is running will be provided to the Licensing System by the application agent, and not by the application itself.

Components:

CAPACITY

One required

PUBLISHER_HIGH_WATER_MARK

STRUCT

no

154

The presence of this data element in the certificate specifies when the Licensing System must reset to zero the value of the Publisher High Water Mark (PHWM, see the description for the PUBLISHER_HWM_VALUE data element). If this data element is not present, the value of PHWM will always increase.

Components:

RESET_MODE

Required

RESET_INTERVAL

Optional

PUBLISHER_HWM_VALUE

FIXED

no

155

This data element contains the value of the Publisher High Water Mark (PHWM). The PHWM is the maximum number of reusable units simultaneously in use since the last time this value was reset to zero, and is logically the same quantity as counted by the Administrator HWM, the only difference being when they are reset, and by whom. The PHWM is reset to zero by the Licensing System with a frequency specified in the RESETTING_FREQUENCY data element.

PUBLISHER

STRUCT

yes

156

This data element describes a publisher by ID and name.

Components:

PUBLISHER_ID

Required

PUBLISHER_NAME

Required

PUBLISHER_ID

UUID

yes

157

This data element uniquely identifies (by means of a UUID)the publisher of the application software or the publisher of the Licensing System, depending on the "parent" data element where it appears.

PUBLISHER_NAME

TEXT

yes

158

This data element provides the textual representation of the name of the publisher, normally used by the Licensing System or a management tool to display external information about the publisher in a human readable form.

PUBLISHER_SECTION

STRUCT

no

159

This data element of the certificate contains publisher defined information, which will be passed to the application by the Licensing System in answer to a "query" call .The components of this data element will be publisher defined.

Components:

Publisher defined

Required

PUBLISHER_USE

TEXT

yes

160

This data element contains additional publisher defined information, which can be used either by the application (which can retrieve it via a "query" call) or by the Licensing System or a management tool for external display. This data element can be used as an alternative to the PUBLISHER_SECTION data element in those Licensing System which do not support the latter.

REMOVE_ANNOTATION

TEXT

yes

161

This data element contains any descriptive text which the administrator chooses to provide when requesting that this certificate be removed or replaced. The value of this data element is set by the xslm_set_admin_policy() call.

REMOVED_DATE

TIME

yes

162

This data element specifies the date and time at which this certificate was removed from the Licensing System per the administrator's request or was replaced by a replacement certificate.

REPLACE_CERTIFICATE

LIST

no

163

The presence of this data element in the certificate indicates that this entire certificate is to replace one or more previously installed certificates. The certificates to be replaced are identified by a list of CERTIFICATE_ID data elements. If a match is found for all the CERTIFICATE_IDs, the certificates being replaced are "logically deleted" from the Licensing System and the present certificate is installed. However the Licensing System must maintain enough information to prevent the re-installation of the certificates being replaced. If a match is not found, no replacement will occur.

Components:

CERTIFICATE_ID

One required

REPLACEMENT_DATE

TIME

no

164

This data element specifies the date and time at which this certificate was replaced by another certificate.

REQUESTED_UNITS

FIXED

yes

165

This data element contains the number of licensed units which have been requested by the application with a "request license" call.

REQUESTOR_ID

STRUCT

no

166

This data identifies the requester of a license on the part of the Licensing System. The requester is the combination of a node and a user, and is provided to the Licensing System by the application client agent.

Components:

NODE

Required

USER

Required

RESET_INTERVAL

INTVL

no

167

This data element specifies the value of the time interval at which the Licensing System must reset to zero the value of the Publisher High Water Mark, or reset to their initial value the resettable counters. If this data element is not present the Licensing System will assume that the resetting interval is infinite, unless the RESET_MODE data element specifies a value other than 1.

RESET_MODE

FIXED

no

168

This data element specifies the frequency with which the Licensing System must reset to zero the value of the Publisher High Water Mark, or reset to their initial value the resettable counters.

Value = 1

Frequency in RESET_INTERVAL

Value = 2

Every hour

Value = 3

Every day

Value = 4

Every week

Value = 5

Every month

Value = 6

Every year

RESETABLE_COUNTER

STRUCT

no

169

This data element indicates a counter (consumptive or cumulative) whose value must be reset to the initial value by the Licensing System, and the frequency of the resetting action.

Components:

COUNTER_ID

Required

RESET_MODE

Optional

RESET_INTERVAL

Optional

RESETABLE_COUNTERS_LIST

LIST

no

170

This data element specifies the counters (consumptive or cumulative) whose value must be reset to the initial value by the Licensing System, and the frequency of the resetting action.

Components:

RESETABLE_COUNTER

One required

RESETTING_FREQUENCY

STRUCT

no

171

This data element specifies the data elements whose value is to be reset to an initial value by the Licensing System , and the frequency of the resetting action.

Components:

PUBLISHER_HIGH_WATER_MARK

Optional

RESETABLE_COUNTERS

Optional

RETURN_FUNCTION_CODE

FIXED

yes

172

This data element contains the code being returned by the Licensing System as the value of the function being invoked by the client library (application or management). The possible values and meaning of this data element are described for each API function.

RETURN_STATUS

STRUCT

yes

173

This data element contains the values being returned by the Licensing System at the completion of an API call.

Components:

RETURN_FUNCTION_CODE

Required

RETURN_STATUS_CODE

Optional

RETURN_STATUS_CODE

FIXED

yes

174

This data element contains the code being returned by the Licensing System as the output parameter value which appears in each function being invoked by the client library (application or management).

The possible values and meaning of this data element are described for each API function.

RETURNED_UNITS

FIXED

yes

175

This data element contains the number of reusable licensed units which have been returned by the application with a "release license" call. This number must match the number of units granted by the Licensing System in a previous "request license" call.

SERVER_LAST_STOP

TIME

yes

176

This data element specifies the date and time that this license server was last stopped.

SERVER_START

TIME

yes

177

This data element specifies the date and time that this license server was last started.

SERVER_TIME_STAMP

TIME

yes

178

This data element contains the date and time at which the License Server logged this event.

SESSION_HANDLE

STRUCT

yes

179

This data element contains the reference established by the Licensing System in order to uniquely identify a session of an application with the Licensing System. The components of this data element are implementation dependent and are defined by the Licensing System publisher.

Components:

Licensing System defined

SIGNATURE

STRUCT

no

180

This data element of the certificate contains the specification of the digest algorithm used to generate the message digest, the encryption algorithm used to encrypt the digest, and the encrypted message digest itself.

Components:

SIGNATURE_DIGEST_ALGORITHM

Required

SIGNATURE_ENCRYPTION_ALGORITHM

Required

SIGNATURE_ENCRYPTED_DIGEST

Required

SIGNATURE_DIGEST_ALGORITHM

FIXED

no

181

This data element specifies the algorithm used to generate the digest of the certificate. Presently the only algorithm defined is MD5.

Value = 1

MD5

SIGNATURE_ENCRYPTED_DIGEST

BSTR

no

182

This data element contains the digest of the certificate, encrypted with the publisher's private key. The input to the digest algorithm consists of the whole certificate, except this data element itself.

SIGNATURE_ENCRYPTION_ALGORITHM

FIXED

no

183

This data element specifies the algorithm used to encrypt (with the publisher's private key) the digest of the certificate. Presently the only algorithm defined is RSA.

Value = 1

RSA

SUBNODE

STRUCT

no

184

This data element contains further identification of a node, for those platforms where the notion of "sub-node" is relevant

Components:

SUBNODE_TYPE

Required

SUBNODE_ID

Required

SUBNODE_ID

BSTR

no

185

This data element contains a byte string which uniquely identifies a node where the application is licensed to run. The exact meaning and format of the byte string is determined by the NODE_TYPE data element. At run time, this information is provided to the Licensing System by the client library (application or management agent).

SUBNODE_TYPE

FIXED

no

186

This data element indicates the format and the meaning of the SUBNODE_ID data element associated with it. Only one sub-node type is presently defined.

Value = 1

LPAR

SYSTEM_ERROR_CODE

FIXED

no

187

This data element specifies the type of error which was detected by the Licensing System in the platform where the License Server was running. The error may have been caused by the Licensing system itself, by the Operating System, or by the hardware. System error codes are the implementation-defined values.

SYSTEM_ERROR_MESSAGE

TEXT

no

188

This data element contains the implementation-defined error messages.

SYSTEM_RESET_COUNTER_LIST

LIST

no

189

This data element contains the list of counters and their values when the Licensing System resets them to their initial value, with a frequency specified by the application publisher in the certificate.

Components:

COUNTER_UNITS

One required

TRANSACTION_HANDLE

STRUCT

yes

190

This data element contains the reference established by the Licensing System in order to uniquely identify a "request license" transaction with an application. The components of this data element are implementation dependent and are defined by the Licensing System publisher.

Components:

Licensing System defined

USER

STRUCT

yes

191

This data element identifies a user to which the application has been licensed. At run time the information about the user of the application is provided to the Licensing System by the application agent by means of information derived from the operating system. Additional information may be provided by the application itself, through a parameter of the "request license" call.

Components:

USER_TYPE

Required

USER_ID

Required

USER_ID

BSTR

yes

192

The value of this data element is a byte string which uniquely identifies a user of an application. The exact meaning and format of the byte string is determined by the USER_TYPE data element. If the value of USER_TYPE data element is 1 (login name), the content of this data element must be parsed as if it was of type TEXT. At run time this information is provided to the Licensing System by the application agent by means of information derived from the operating system. Additional information may be provided by the application itself through a parameter of the "request license" call (e.g. an application server which provides the identity of the application clients "logging on" to the application).

USER_ID_FROM_API

STRUCT

yes

193

This data element identifies the user to which the application is licensed and is passed by the "request" call. The user type is the same as that defined by the USER_TYPE data element.

USER_LIST

LIST

no

194

This data element is a list of users to which the application has been licensed. At run time the information about the user of the application is provided to the Licensing System by the application itself , through a parameter of the "request license" call, and also by the application agent by means of information derived from the operating system.

Components:

USER

One required

USER_TYPE

FIXED

yes

195

The value of this data element indicates the format and the meaning of the USER_ID data element associated with it. The user types presently defined are:

Value = 1

Login name

VERSION

STRUCT

yes

196

This data element describes a publisher by ID and name.

Components:

VERSION_ID

Required

VERSION_NAME

Required

VERSION_ID

FIXED

yes

197

The value of this data element is a publisher defined integer which uniquely identifies the version of the product among all the other versions of this product.

VERSION_NAME

TEXT

yes

198

The value of this data element is the textual representation of the version of the product for which this certificate was created, normally used by the Licensing System or a management tool to provide external information about the product in a human readable form.

Defined Symbols and their Assigned Values