FLEXNET OPERATIONS SOAP WEB SERVICES GUIDE

FlexNet Operations Web Services Guide

Methods: LicenseService

Methods
Name  Description 
activateShortCode 

The activateShortCode operation generates one keyboard activation response. To use the License service to generate a short code response:

  • Short code ASRs must be created and associated with deployed bulk entitlements in the FlexNet Operations database.

  • Short code ASRs must be delivered to customers with an activation utility.

  • Bulk entitlement and/or a web register key must be delivered to customers.

  • If web register keys are going to be loaded dynamically into a bulk entitlement at fulfillment time, a FlexNet Operations configuration setting to load web register keys as part of activation for trusted bulk entitlements must be checked
consolidateFulfillments  The consolidateFulfillments operation creates one or more consolidated license certificates from a set of fulfillments. To use the License service to create consolidated certificate licenses, there must be fulfillments in the FlexNet Operations database.
createChildLineItemFulfillment  The createChildLineItemFulfillment operation generates licenses for one or more renewal, upgrade, or upsell line items. To generate a license for a child line item, there must be an existing RENEWAL, UPGRADE, or UPSELL activatable item.
createCVDFulfillments 

The createCVDFulfillments method generates fulfillment records by tying together the following elements:

  • activation IDs

  • product counts

  • license hosts

To use the License service to generate a CVD fulfillment record:

  • There must be deployed entitlements in the FlexNet Operations database.

  • You must provide any fulfillment-time data that is required by the specified license model.

The resulting CVD fulfillments can then be consolidated by the createCVDLicenseFile operation to create a license file for a given host.
createCVDLicenseFile 

The createCVDLicenseFile operation consolidates CVD fulfillments (generated by createCVDFulfillment) and features and generates a license file for a given license host. As input, it requires a license host or a set of custom host attributes.

Workflow

The workflow of the createCVDLicenseFile operation usually comprises the following steps:

  1. Get all fulfillment records for specified host.

  2. Generate an unsigned license file for each fulfillment.

  3. Consolidate features for the specified host. For features to be consolidated, all properties present in the INCREMENT lines (except for the signing encryption) must match. Identical feature INCREMENT lines will be merged and the fulfill count is accumulated, leaving only the unique INCREMET lines.

  4. Sign the license file using lmcrypt (customized by producer, hosted by Revenera).

  5. Group the fulfillments based on license generator.

  6. Group the fulfillments based on license technology.

  7. Output signed license file.

Prerequisites

  • A custom license technology of type Manual or Handsfree.

  • A custom license generator configuration that generates licenses for the custom license technology.

  • A license model for the license technology.

Custom License Generator Attributes

A set of custom license generator attributes:

Attribute Name  Type  Other Properties 
LICENSE_TEMPLATE
 Long Text
 Display type: Text area
SERVER_LINE
 Long Text
 Display type: Text area
DEFAULT_SERVER_PORT
 Number
VENDOR_NAME
 Text

Text type: Freeform

Display type: Text field

Custom License Model Attributes

A set of custom license model attributes:

Attribute Name  Type  Other Properties 
BORROW_HOURS
 Number
SUPERSEDE
 Boolean
USER_BASED
 Number
HOST_BASED
 Number
DUP_GROUP
 Long text
 Display type: Text field
VENDOR_STRING
 Long text
 Display type: Text field
ISSUER
 Long text
 Display type: Text field
NOTICE
 Long text
 Display type: Text field

Custom Host Attributes

A set of custom host attributes:

Attribute Name  Type  Other Properties 
HOSTID1
 Text

Text type: Free form

Display type: Text field
HOSTNAME1
 Text

Text type: Free form

Display type: Text field
HOSTID2
 Text

Text type: Free form

Display type: Text field
HOSTNAME2
 Text

Text type: Free form

Display type: Text field
HOSTID3
 Text

Text type: Free form

Display type: Text field
HOSTNAME3
 Text

Text type: Free form

Display type: Text field
HOST_ID_TYPE
 Text

Text type: Free form or Single select

Display type: Text field

lmcrypt

If licenses are to be signed, the lmcrypt utility must have been customized and been made available to Revenera.
createLicense 

The createLicense operation generates one or more license certificates and corresponding fulfillment records. To use the License service to generate a certificate license:

  • There must be deployed entitlements in the FlexNet Operations database.

  • You must provide any fulfillment-time data that re required by the specified license model.
createLicensesAsBatch 

The createLicensesAsBatch operation generates one or more license certificates and corresponding fulfillment records from a set of activatable items that use the same license model and fulfillment-time attributes. Hostids and counts can be defined for each activatable item. To use the License service to generate certificate licenses in a batch:

  • There must be test or deployed entitlements in the FlexNet Operations database that use the same license model.

  • You must provide any fulfillment-time data that are required by the specified license model. Hostids and count can be provided for each individual fulfillment, but other fulfillment-time data applies to all the fulfillments.
createLicensesAsBatchAndConsolidate 

The createLicensesAsBatchAndConsolidate operation generates one or more consolidated license certificates and corresponding fulfillment records from a set of activatable items that use the same license model and fulfillment-time attributes. Hostids and counts can be defined for each activatable item. To use the License service to generate consolidated certificate licenses in batch:

  • There must be test or deployed entitlements in the FlexNet Operations database that use the same license model.

  • You must provide any fulfillment-time data that are required by the specified license model. Hostids and count can be provided for each individual fulfillment, but other fulfillment-time data applies to all the fulfillments.
deleteOnholdFulfillments  The deleteOnholdFulfillments operation takes one or more on-hold fulfillmentIDs and deletes them.
emailConsolidatedLicenses 

The emailConsolidatedLicenses operation sends one or more consolidated licenses via email. To send a consolidated license as an email attachment using the License service:

  • Configure the from-address for the license email. See the FlexNet Operations Installation Guide.

  • Customize the consolidated license email templates, if necessary. See the FlexNet Operations Producer Portal Help Guide.

  • A consolidated license must exist in the database.

  • At least one email address must be provided.
emailLicense 

The emailLicense operation sends a license certificate. To send a license certificate as an email attachment using the License service:

  • Configure the from-address for the license email. See the FlexNet Operations Installation Guide.

  • Customize the license email templates, if necessary. See the FlexNet Operations Producer Portal Help Guide.

  • A fulfillment ID for a generated license must exist in the database.

  • At least one email address must be provided.
emergencyLicense  The emergencyLicense operation generates an emergency nodelocked or served certificate license for one or more fulfillments. To generate an emergency license, there must be existing fulfillments in the database that are eligible for an emergency license, according to their license model policies.
getConsolidatedFulfillmentCount  The getConsolidatedFulfillmentCount operation returns the number of consolidated fulfillments that match specified criteria.
getConsolidatedFulfillmentsQuery  The getConsolidatedFulfillmentsQuery operation returns the consolidated fulfillments that match specified criteria.
getFulfillmentAttributesForBatchActivation  The getFulfillmentAttributesForBatchActivation operation returns all the license model or entitlement attributes for the specified activation IDs that must be specified at the time the licenses are generated
getFulfillmentAttributesFromModel  The getFulfillmentAttributesFromModel operation returns all the license model attributes for the specified model that must be specified at the time the license is generated.
getFulfillmentCount  The getFulfillmentCount operation returns the number of fulfillments that match specified criteria.
getFulfillmentHistory  The getFulfillmentHistory operation returns the history of a specified fulfillment.
getFulfillmentPropertiesQuery 

The getFulfillmentPropertiesQuery operation returns the fulfillment details that match specified criteria.

The response from getFulfillmentProperties is highly configurable. You can use it to select only the data you need in a given response.

getFulfillmentsQuery  The getFulfillmentsQuery operation returns the fulfillments that match specified criteria.
getHostAttributesFromLicenseTechnology  The getHostAttributesFromLicenseTechnology operation takes a custom license technology and gives host attributes for the given technology in the response data. It is used to create a custom host when generating a license.
getHostCount 

This operation returns the number of hosts that match specified criteria. The following search criteria are available: Host ID, Sold To, Account, License Technology, and Host Type.

This operation is equivalent to displaying the number of hosts that fit certain criteria by filtering hosts using the Search for field on the Support Licenses and Maintenance page in the FlexNet Operations Producer Portal.

Tip:The returned number can be used as the batch size input for getHostQuery.
getHostQuery  This operation extracts the same information as that available on the Support Licenses and Maintenance page in the FlexNet Operations Producer Portal user interface: Host ID, Sold To, Account, License Technology, and Host Type. In addition, producers can filter for hosts that have active or inactive fulfillments.
manualActivation  The manualActivation operation takes a single trusted activation XML request as a string and generates a single trusted activation XML response as a string.
manualRepair  The manualRepair operation generates one manual trusted activation repair response.
manualReturn  The manualReturn operation generates one trusted activation return response.
offlineFNPTrustedStorageActivation  The offlineFNPTrustedStorageActivation operation generates one or more fulfillment responses, based on the contents of the offline activation request, and returns output that can be stored as a file for subsequent processing on the machine that originated the request. The operation takes one or many activation IDs and an XML structure that contains information about the state of trusted storage on a single host machine. The operation output is an XML structure containing the fulfillment that must be saved to a file and processed on the host machine.
publisherErrorLicense  The publisherErrorLicense operation generates a publisher error nodelocked or served certificate license for one or more fulfillments. To generate a publisher error license, there must be existing fulfillments in the database that are eligible for a publisher error license, according to their license model policies.
rehostLicense  The rehostLicense operation modifies the hostids of one or more fulfillments. To rehost a license, there must be existing fulfillments in the database that are eligible to be rehosted, according to their license model policies.
renewFulfillment  The renewFulfillment operation generates renewal licenses for one or more fulfillments. To renew a fulfillment, there must be an existing RENEWAL entitlement line item for the product licensed by the parent fulfillment
repairLicense  The repairLicense operation modifies editable parameters in fulfillments other than hostids. To repair a license, there must be existing fulfillments in the database that are eligible to be repaired, according to their license model policies.
repairShortCode  The repairShortCode operation generates one short code repair response.
returnLicense  The returnLicense operation returns one or more fulfillments. To return a license, there must be existing fulfillments in the database that are eligible to be returned, according to their license model policies.
returnShortCode  The returnShortCode operation generates one short code return response.
setLicense  The setLicense operation sets the license text for one or more on-hold fulfillmentIDs for a manual custom license technology.
stopGapLicense  The stopGapLicense operation generates a stop-gap nodelocked or served certificate license for one or more fulfillments. To generate a stop-gap license, there must be existing fulfillments in the database that are eligible for a stop-gap license, according to their license model policies.
transferHost  The transferHost operation transfers active fulfillments from one or more hosts owned by one customer account to another customer account. When a host is transfered, line items that are the source of the fulfillments on that host are moved as well. The result of the move is to either create new entitlements for the target account or to pool the line items—incrementing the counts of the target account's existing (and matching) line items by the counts on the hosts’ line items.
upgradeFulfillment  The upgradeFulfillment operation generates upgrade licenses for one or more fulfillments. To upgrade a fulfillment, there must be an existing UPGRADE entitlement line item for the product licensed by the parent fulfillment.
upsellFulfillment  The upsellFulfillment operation generates upsell licenses for one or more fulfillments. To upsell a fulfillment, there must be an existing UPSELL entitlement line item for the product licensed by the parent fulfillment.
verifyCreateLicense 

The verifyCreateLicense operation checks whether licenses can be generated with the specified parameters, but does not generate fulfillment records. To use the License service to verify that licenses can be created:

  • There must be test or deployed entitlements in the FlexNet Operations database.

  • You must provide any fulfillment-time data that are required by the specified license model.

FlexNet Operations SOAP Web Services Guide

July 2025