Note
For more information on integration with Wibu-Systems CodeMeter, see the following:
- SAP Help Document: Integration with Wibu-Systems CodeMeter
- Integration Package: SAP Entitlement Management Integration with WIBU CodeMeter License Central
Integration between SAP Entitlement Management and Wibu-Systems CodeMeter bridges the gap between sales, provisioning, and fulfillment. This integration ensures that commercial entitlements managed in SAP Entitlement Management are seamlessly translated into technical entitlements on the end user's device using CodeMeter.
Below are the detailed steps for this integration:
Step 1: Create a Service Instance and Service Key for Inbound Authentication
- In the SAP Cloud Integration, create a service instance with the plan set to Integration-flow.
- Create a service key with the key type set to ClientId/Secret.
- In the Security Material section, add a new OAuth2 credential using the details from the service key.
Step 2: Add SAP Entitlement Management OAuth2 Credentials
- In SAP BTP, create a service instance of SAP Entitlement Management OAuth service.
- Generate a service key for the created service instance.
- In SAP Cloud Integration, in the Security Material section, add a new OAuth2 credential using the client ID, client secret, and OAuth token URL from the service key.
Step 3: Add Client Certificate of CodeMeter License Central - Web Service
- Navigate to the Keystore section of SAP Cloud Integration.
- Add a new key pair by selecting your key pair and providing an alias and password.
- Confirm the addition of the key pair to the Keystore.
Step 4: Add Basic Authentication Credential of CodeMeter License Central - Web Service
- Navigate to the Security Material section of SAP Cloud Integration.
- Add a new user credential.
- Enter the Name and Description of the user credential.
- Specify the Type as User Credentials.
- Enter the password for CodeMeter basic authentication and repeat the password for confirmation.
Step 5: Request Ticket Generation from CodeMeter License Central
- In SAP Cloud Integration, configure the Sender tab as follows:
- Specify the Address as /codemeter/ticket-generation.
- Set the Authorization User Role to ESBMessaging.Send.
- Configure the Receiver tab for CodeMeter as follows:
- Specify the Address of the CodeMeter web service.
- Set the Authentication Method to Client Certificate.
Configure the Receiver tab for PostExit as follows:
Specify the Address of your Sender Process Direct in your extension integration flow.
- Configure the Receiver tab for EntitlementManagement as follows:
Specify the Address of the Inbound_Interface_Entitlement_Update_v2 API.
- On the More tab, set the CMLC Credential to the user credential name defined in Step 4.
- Specify the display names for License Quantity and Maintenance Period.
- Set the entitlement attribute for Ticket Code to the entitlement attribute defined in the entitlement model.
- Enable error handling, if required.
Step 6: Receive Activation State of License from CodeMeter License Central
- In SAP Cloud Integration, configure the Sender tab as follows:
- Specify the Address as /license/activation-state.
- Set the Authorization User Role to ESBMessaging.Send.
- Configure the Receiver tab for CodeMeter as follows:
- Specify the Address of the CodeMeter web service.
- Set the Authentication Method to Client Certificate.
Configure the Receiver tab for PostExit as follows:
Specify the Address of your Sender Process Direct in your extension integration flow.
Configure the Receiver tab for EntitlementManagement as follows:
Specify the Address of the Inbound_Interface_Entitlement_Update_v2 API.
- On the More tab, set the CMLC Credential to the user credential name defined in Step 4.
- Specify the iterating splitter settings, such as:
- Number of Concurrent Processes
- Timeout
- In SAP Entitlement Management, set the Status Code to the status configured in the integration flow.
- Enable error handling if required.
Step 7: Configure Wibu-Systems CodeMeter Settings
- Ensure you have created a service key for Wibu-Systems CodeMeter integration.
- If your CodeMeter License Central system is operated by WOPS, provide the clientid, clientsecret, and tokenURL to WOPS for configuration.
- If your CodeMeter License Central system is hosted by a software vendor, add the following settings to the deployment configuration file:Code Snippet12345678910111213141516171819``` EMS settings emsOAuthTokenUrl=<<tokenurl of service key>> emsClientId=<<clientid of service key>> emsClientSecret=<<clientsecret of service key>> emsBase=<<baseUrl of endpoint of iflow>> emsOrders= emsLicenses= emsActivations=<<path of endpoint of iflow>> ```
Step 8: Implement Extensions
- Identify extension points, such as:
- Overwriting the whole process
- Overwriting the standard process
- Enhancing the payload of entitlement update
- Enhancing additional actions after entitlement status update
- Set the appropriate parameters in the HTTP Header for each extension point.
- Provide a list of IDs of activation states in the HTTP Header – successIdList to confirm successful processing to CodeMeter.
Step 9: Activation Process
In the Wibu-Systems WebDepot, activate the entitlements on the end user's PC or device.
This portal allows online or offline activation of all licenses that are part of the ticket.
- Licenses can be stored as a software file bound to the device’s hardware digital fingerprint, in the secure crypto chip of a dongle, or in a cloud container bound to a known user.
- Once the activation process is completed successfully, all license checks (with the exception of a cloud license) are performed locally, with no need for a permanent server connection.
Summary
By following these steps, businesses can effectively integrate SAP Entitlement Management with Wibu-Systems CodeMeter, ensuring a seamless process from sales and provisioning to the implementation and management of entitlements on end users' devices. This integration provides robust protection for intellectual property and flexible licensing options to meet diverse customer needs.