Verimatrix adaptor for encryption
PROPERTIES
| Name | VerimatrixOMI |
| System ID | VO |
| Connection String | |
| Heartbeat Connection String |
SUPPORTED NODE
DEFINITIONS
* Indicates the message has been deprecated. Please use the replacement message(s) instead.
NODE DEFINITION
DETAILS
Adds content to Vermatrix with a given contentId only if the contentId does not exist in the verimatrix. This contentId is used in other subsequent api calls.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id can used to reference the content |
| contentDescription | NO | description of the content |
| contentTag | NO | tag associated with the content |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of Add Content, 'Success' if successful |
This message will start the encryption. It calls the Verimatrix AddContentToNetwork function.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id used in AddContent message. |
| outputLocation | NO | Output file directory |
| ratingLevel | NO | Rating level value (range 1 - 255). Default is 1 |
| encryptionDescription | NO | Description related to encryption |
| movieName | NO | Name of the movie |
| fileSize | NO | file size of the movie |
| fileType | NO | file type of the movie |
| networkId | NO | Id of Network |
| inputFilePath | NO | for iptv case, inputFilePath MUST NOT null; otherwise, it means ott case. |
| keyList | NO | All the encryption parameter keys that supported. |
| valueList | NO | Values of all the encryption parameters in the above parameter keyList. |
| valueTypeList | NO | Specify the data type for each parameter in the list keyList. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of Start Encryption, 'Success' if successful |
| networkContentId | Id the Network uses to reference the content |
Add Content to Internet TV network
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id used in AddContent message. |
| ratingLevel | NO | Rating level value (range 1 - 255). Default is 1 |
| networkId | NO | Id of Network |
| networkContentId | NO | Id the Network uses to reference the content |
| keyList | NO | All the encryption parameter keys that supported. |
| valueList | NO | Values of all the encryption parameters in the above parameter keyList. |
| valueTypeList | NO | Specify the data type for each parameter in the list keyList. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of Start Encryption, 'Success' if successful |
Adds a device to Vermatrix with a given deviceId only if the deviceId does not exist in the verimatrix (if it does the existing device will be overwritten). This deviceId is used in AddEntitlement.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| networkId | NO | Id of Network |
| deviceId | NO | ID used by the SMS to identify the device. Should be unique unless updating previous created device. |
| networkDeviceId | NO | ID used by the SMS to identify the network. Should be unique. |
| deviceType | NO | The DeviceType data type defines specific types of client devices (for example, set-top boxes). Valid values are as follow, refer to Verimatrix documentation for more info: |
| authenticator | NO | Middleware authenticator. Can be left blank. Note that if filled the inputed string will be Base64 encoded. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response says 'Success' if successful |
Adds a domain to Vermatrix with a given domainId only if the domainId does not exist in the verimatrix (if it does the existing domain will be overwritten). This domainId is used in AddEntitlement.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service |
| domainId | NO | A unique reference to identify the Domain within OMI. |
| maxDevices | NO | Allows limiting the number of Devices that can be added to the Domain. |
| startTime | NO | Start time boundaries for the validity of this domain. While experiation of the period does not automatically dissolve the Domain, OMI rejects any operations performed with the Domain outside that period. |
| endTime | NO | End time boundaries for the validity of this domain. While experiation of the period does not automatically dissolve the Domain, OMI rejects any operations performed with the Domain outside that period. |
| domainAddress | NO | Allows 1-64 (in VCAS) groups that could be uniquely addressed. If group addressing is not intended to be used, it can be omitted, as this field is optional. In most cases it should probably should be left empty unless you know what domain addresses were not used before. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of AddDomain, 'Success' if successful |
Add one entitlement.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| packageId | NO | Unique package ID. User created. Should already be created with AddPackage node before entitlement created. |
| operatorId | NO | Unique operator ID. If left blank it will default to 1. Package should already be created to create an entitlement. |
| extendedAccessClassId | NO | Service class Id that will override the value generated by OMI. Can be left empty. Package should already be created to add an entitlement |
| entitlementId | NO | Unique entitlement ID. User created |
| startTime | NO | Start time boundaries for the validity of this entitlement. Format: YYYY-MM-DDThh:mm:ss |
| endTime | NO | End time boundaries for the validity of this entitlement. Format: YYYY-MM-DDThh:mm:ss |
| entityId | NO | The ID of either the Domain or Device this entitlement is for. The Domain or Device must exist already. |
| entityType | NO | The entity type. The only valid inputs are 'DOMAIN' or 'DEVICE' |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of Add Event, 'Success' if successful |
Add one event.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id used in AddContent message. |
| networkId | NO | Id of Network |
| eventId | NO | Unique ID for this Event. User created. |
| exclusive | NO | If set to true, this Event is exclusive or opaque. |
| preStartDuration | NO | Duration during which prior to the start time defined in timePeriod a CA shall play out EMMs, etc. |
| startTime | NO | Start time boundaries for the validity of this Event. |
| endTime | NO | End time boundaries for the validity of this Event. |
| ratingLevel | NO | Rating level of the movie. Valid values are 1 to 255. Can be left empty. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of Add Event, 'Success' if successful |
Associates an Event to a Package. If the Event does not exist already it is created. If event does exist the values are overwritten. Pacakge must exist beforehand.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id used in AddContent message. |
| networkId | NO | Id of Network |
| eventId | NO | Unique ID for this Event. User created. |
| startTime | NO | Start time boundaries for the validity of this Event. Format: YYYY-MM-DDThh:mm:ss |
| endTime | NO | End time boundaries for the validity of this Event. Format: YYYY-MM-DDThh:mm:ss |
| packageId | NO | Unique package ID. User created |
| operatorId | NO | Unique operator ID. If left blank it will default to 1. |
| extendedAccessClassId | NO | Service class Id that will override the value generated by OMI. Can be left empty. |
| preStartDuration | NO | Duration during which prior to the start time defined in timePeriod a CA shall play out EMMs, etc. According to the documentation preStartDuration is not currently supported but maybe in the future. |
| exclusive | NO | If set to true, this Event is exclusive or opaque. |
| ratingLevel | NO | Rating level of the movie. 1 to 255 Dynamic rating level. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of Add Package, 'Success' if successful |
Add one package.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| packageId | NO | Unique package ID. User created |
| operatorId | NO | Unique operator ID. If left blank it will default to 1. |
| extendedAccessClassId | NO | Service class Id that will override the value generated by OMI. Can be left empty. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of Add Package, 'Success' if successful |
Associates an content to specify network. Currently this SuperState only supports OTT network.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| networkId | NO | Id of Network |
| contentId | NO | cms created id used in AddContent message. Notes: the contentId format MUST align with downstreams(MSMW,Openstream, etc.). The followings are default formats currently used by prepack: |
| networkContentId | NO | Id the Network uses to reference the content. |
| contentDescription | NO | Description related to the content. |
| contentTag | NO | Tag for the content. |
| keyList | NO | All the encryption parameter keys that are supported by OTT. |
| valueList | NO | Values of all the encryption parameters in the above parameter keyList. |
| valueTypeList | NO | Specify the data type for each parameter in the list keyList. |
| ratingLevel | NO | Rating level of the movie(1-255). |
| networkContentType | NO | Defines categories of content recognized by OMI(DTV or VOD). |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Latest response text from VCAS OMI. |
| existingNetworkContentIds | Existing network content ids corresponding to the content id. |
| result | true: associate content to network sucess. false: associate content to network fail. |
Do encryption against a video content file and generate a new content file with encryption. Generally, this is used in IPTV solution.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id used in AddContent message. Notes: the contentId format MUST align with downstreams(MSMW,Openstream, etc.). The followings are default formats currently used by prepack: |
| contentDescription | NO | Description related to the content. |
| contentTag | NO | Tag for the content. |
| outputLocation | NO | Location where the encrypted file is placed, this path should be acessed by VCAS. |
| inputFilePath | NO | Location where file to be encrypted is placed, this path should be acessed by VCAS. |
| ratingLevel | NO | Rating level of the movie(1-255). |
| encryptionDescription | NO | User-friendly description. |
| movieName | NO | Name of the movie you want to add. |
| fileSize | NO | File Size. |
| fileType | NO | File Type. |
| networkId | NO | Id of Network |
| networkContentId | NO | keep empty. |
| networkContentType | NO | Defines categories of content recognized by OMI(DTV or VOD). |
| delay | NO | interval in seconds to pull the encryption status. |
| localOutputLocation | NO | Location where the encrypted file is placed, this path should be accessed by CMS. |
| keyList | NO | All the encryption parameter keys that supported. |
| valueList | NO | Values of all the encryption parameters in the above parameter keyList. |
| valueTypeList | NO | Specify the data type for each parameter in the list keyList. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Latest response text from VCAS OMI. |
| percentComplete | Indicates the encryption progress. |
| status | Status from VCAS |
| encryptedFilePath | absolute path of the content file after encryption done. this path should be accessed by CMS. |
| encryptionKeyBlock | The VCAS key resource id used for encryption. |
| existingNetworkContentIds | Existing network content ids corresponding to the content id. |
This message gets the current status of the encryption process.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id can used to reference the content |
| networkId | NO | Id of the network |
| networkContentId | NO | Id the Network uses to reference the content |
| networkContentType | NO | VOD or DTV. Default is VOD |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| percentComplete | Encryption % completion as integer |
| status | Encryption Status |
| response | response of thw message, 'Success' if successful |
This message gets the networkcontentId which can be used to get status of an Encryption process
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id can used to reference the content |
| networkId | NO | Id of the network |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| networkContentIds | Comma Seperated Ids the Network uses to reference the content |
| response | response of thw message, 'Success' if successful |
This message logs off the user from the verimatrix sytem
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string obtained from successful login to Verimatrix service. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of Log off, 'Success' if successful |
Modify the encryption parameters that are accepted by the OTT netwrok.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| keyList | NO | The keys that are passed to OMI for OTT encryption parameters setting. |
| valueList | NO | Values of all the encryption parameters in the above parameter keyList. |
| valueTypeList | NO | Specify the data type for each parameter in the list keyList. |
| networkContentId | NO | Id the Network uses to reference the content. |
| networkContentType | NO | Defines categories of content recognized by OMI(DTV or VOD). |
| networkId | NO | Id of Network |
| ratingLevel | NO | Rating level of the movie(1-255). |
| smsContentId | NO | cms created id used in AddContent message. Notes: the contentId format MUST align with downstreams(MSMW,Openstream, etc.). The followings are default formats currently used by prepack: |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Latest response text from VCAS OMI. |
| result | Indicates whether operation sucess. |
This message try to modify OTT network content parameters. It calls the Verimatrix modifyContentOnNetwork function.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| keyList | NO | The keys that are passed to OMI for OTT encryption parameters setting. |
| networkContentId | NO | For ott case, networkContentId is required. it is the resourceId from the key block. |
| networkContentType | NO | VOD or DTV. Default is VOD. |
| networkId | NO | Id of the network. |
| ratingLevel | NO | Rating level of the movie. 1 to 255 Dynamic rating level. For PPC, these values are set at the Network Content level. For PPV, these values are set at the Event level. For IPTV, these values can be 0-255 and are fetched by VKS when reading the service-class definitions. |
| valueList | NO | value of each key in the keyList |
| valueTypeList | NO | data type of each key in the keyList |
| smsContentId | NO | cms created id used in AddContent message. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of ModifyContentOnNetwork, 'Success' if successful. |
| result | indicates whether the operation is successful or not. |
Remove content specified by the content id from VCAS OMI. And if this content is associated with networks, all the association with these networks will also removed.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id used in AddContent message. Notes: the contentId format MUST align with downstreams(MSMW,Openstream, etc.). The followings are default formats currently used by prepack: |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Latest response text from VCAS OMI. |
| result | Indicates whether operation sucess. |
Removing Content from OMI removes all associations of that Content with other elements within OMI such as Networks, Events, etc. and subsequently all cascaded associations
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| contentId | NO | cms created id can used to reference the content |
| handle | NO | Signon handle string after successful login to Verimatrix service |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | response of throw message, 'Success' if successful |
| result | Indicates whether operation sucess. |
Removes Content from a Network.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| contentId | NO | cms created id can used to reference the content |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| networkId | NO | Id of the network |
| networkContentType | NO | VOD or DTV. Default is VOD |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | response of thw message, 'Success' if successful |
This message Signs in a user to perform encryption operation
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| handle | Signon handle string after successful login to Verimatrix. |
checks status of a encryption process, every given interval till encryption completes
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id used in AddContent message. |
| delay | NO | wait period between verifying encryption status |
| outputLocation | NO | Output directory for encrypted file |
| networkContentId | NO | Id the Network uses to reference the content |
| networkId | NO | Id of Network |
| networkContentType | NO | VOD or DTV. Default is VOD |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| percentComplete | Encryption % completion as integer |
| status | Human readable Verimatrix status |
| encryptedFilePath | Encrypted FilePath |
| encryptionKeyBlock | Encryption Key Block |
| © 2002 - 2016 Ericsson Television Inc. |
| All Rights Reserved. |