sntl_licensing_configure 
Library Information
>This API belongs to the Sentinel RMS licensing library.
>The corresponding header is licensing.h.
Description
Use this API to configure the RMS licensing library. The supported configurations are:
>Enabling the trace writer file for troubleshooting. By default, tracing is disabled for the licensing library (refer to attributes no. 1 and 2)
>Customizing the default standalone license filename/path (refer to attributes no. 3)
>Determining whether to configure SCP using configuration file or this API (refer to attributes no. 4)
>Setting Cloud LM configuration (refer to attributes no. 5 and 6)
>Setting lease configuration (refer to attributes no. 7 to 20)
NOTE To configure lease, it is mandatory to set customer, YPS address, and Fingerprint Friendly name fields.
The API must be called before creating the first application context because the library configuration becomes effective at the time of first application context creation. The library configuration cannot be modified later.
Syntax
SNTL_DECLARE(sntl_status_t) sntl_licensing_configure(const sntl_licensing_attr_t *attr);| Argument | Description |
|---|---|
| attr [In] |
Pointer to the attribute object. The attributes that can be set are described below. |
Attributes
| # | Attribute for... | Key and Description | ||
|---|---|---|---|---|
| 1 | Trace Level |
>Attribute Key - SNTL_ATTR_CONFIG_TRACE_LEVEL >This attribute is used for setting the client trace level required by the client trace writer file and custom trace writer. >The allowed values are: •SNTL_ATTR_CONFIG_TRACE_ERROR - Traces the errors encountered on run-time. •SNTL_ATTR_CONFIG_TRACE_FUNCTION - Traces the major licensing API functions along with errors encountered at run-time. This option also includes the traces encountered at runtime (SNTL_ATTR_CONFIG_TRACE_ERROR). |
||
| 2 | Trace Writer File name |
>Attribute Key - SNTL_ATTR_CONFIG_TRACE_WRITER_FILE >This attribute is used for setting the client trace writer filename. >The RMS library writes traces to this file based on the specified client trace level. >To use the client trace writer file, set the client trace level attribute (mandatory). NOTE Tracing will not be enabled for API calls placed before application context creation (for example, sntl_licensing_attr_new and sntl_licensing_attr_set). |
||
| 3 | License File name |
>Attribute Key - SNTL_ATTR_CONFIG_LSERVRC_FILE >This attribute is used for customizing the default standalone license file name/path. The default license filename is lservrc. >On Windows platform, support is also provided for Unicode-based filename/path. In this case, filename (set using this attribute) should be in UTF-8 format. >This attribute is applicable for standalone licensing only. >If multiple standalone applications from different vendors are installed on a system then, use this attribute to allow over-ridding the default license filename/path for each vendor application. |
||
| 4 | SCP configuration file usage |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_USE_CONFIG_FILE >This attribute is used to set the SCP configuration setting. >The allowed values are: • Yes (Default) - Configure using the SCP configuration file.
•No - Configure using this API (sntl_licensing_configure) and ignoring the SCP configuration file. |
||
| 5 | Tenant Host Address |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_TENANT_HOST_ADDRESS >This is a mandatory attribute used to define the address of SCL components hosted in Cloud. |
||
| 6 | Registration Token |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_REGISTRATION_TOKEN >This is a mandatory attribute used to get the access token using which Cloud LM Rest APIs can be consumed. |
||
| 7 | YPS Address |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_YPS_ADDRESS >This is a mandatory attribute used to define the URL of the server machine (cloud instance) where Directory Service is deployed. >The URL uses https://<YPS_HOSTS>/YPServer format. Where,YPS_HOSTS is the domain name of the Directory Services (DS) machine. |
||
| 8 | Fingerprint Friendly Name |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_FINGERPRINT_FRIENDLYNAME >This is a mandatory attribute used to specify the host name. |
||
| 9 | Customer List |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_CUSTOMER_LIST >Customer list is defined using sntl_licensing_attr_add_object API, which is used to add a customer object in the configure object. >This customer object contains the customer id, which is defined using sntl_licensing_attr_set API.
NOTE At present, SCP supports single customer at a time. |
||
| 10 | Product Key List |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_PRODUCT_KEY_LIST >This attribute is used to add product object in the customer object. >This product object contains the Product key id and product variant attributes (listed below), which is defined using sntl_licensing_attr_set API.
NOTE After configuring this attribute, ensure to add it in the customer list attribute. |
||
| 11 | Product Variant |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_PRODUCT_VARIANT >This attribute sets the product variant for the license to retrieve. This is an optional property and is used when the fingerprint registration is disabled from EMS. The attribute is applicable only for version-less products. |
||
| 12 | Product Quantity |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_PRODUCT_QUANTITY >This attribute sets the product quantity for the license to retrieve. This is an optional property and used when the fingerprint registration is disabled from EMS. NOTE Quantity decrease functionality introduced in Sentinel EMS v5.3 is supported with SCP clients 5.3 or later. |
||
| 13 | Connection Timeout |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_CONNECTION_TIMEOUT >This is an optional attribute that is used to set the session timeout interval. |
||
| 14 | Retry Count |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_CONNECTION_RETRY_COUNT >This is an optional attribute that is used to manage the number of reconnection attempts if there is a connection failure. |
||
| 15 | Proxy Mode |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_PROXY_MODE >This attribute is used to define the proxy connection mode. >The allowed values are: •1: It indicates that the proxy is disabled. •2: It refers to the manual proxy mode. In this mode, you need to manually set the proxy settings. NOTE The licensed application will not connect to the cloud if the client machine is in a proxy environment and proxy settings for SCP are not defined. •3: It refers to the auto proxy mode. In this mode, the proxy settings are automatically detected. For more information on proxy mode, see Configure Proxy Settings. |
||
| 16 | Proxy Host |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_PROXY_HOST >This attribute is used to set the proxy host name or IP address. |
||
| 17 | Proxy User |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_PROXY_USER >This attribute is used to set the user name for proxy authentication. |
||
| 18 | Proxy Password |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_PROXY_PASSWORD >This attribute is used to set the password for proxy authentication |
||
| 19 | Proxy Port Number |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_PROXY_PORT >This attribute is used to define the port number of the proxy server. |
||
| 20 | Proxy PAC |
>Attribute Key - SNTL_ATTR_CONFIG_SCP_PROXY_PAC >This attribute sets the location of the auto-proxy configuration (.pac) file to be used for proxy detection. Use this option in the case of auto-proxy with the .pac file support. >The allowed values are: •URL of the .pac file •Path of the .pac file |
Returns
The status code SNTL_SUCCESS is returned, if successful. Otherwise, an error code is returned indicating the reason for failure. For the complete list of error codes, refer to Licensing Library Error and Result Codes.