[verimatrix-omi] Verimatrix adaptor for encryption
PROPERTIES
| Name | VerimatrixOMI |
| System ID | VO |
| Connection String | null |
| Heartbeat Connection String | null |
SUPPORTED NODE
DEFINITIONS
* 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. |
| encryptionMode | NO | AES or RC4. Default is AES |
| outputLocation | NO | Output file directory |
| keyInsertionInterval | NO | Control word insertion interval for NULLS or ECMs (range: 0 - 2147483647). Default is 0 |
| audioEncryptionLevel | NO | Audio encryption percentage (range: 0 - 100%). The larger the number, greater the encryption. default is 0 |
| videoEncryptionLevel | NO | Video encryption percentage (range 0 - 100%). The larger the number, the greater the encryption. Default is 0 |
| ccCGMS_A | NO | Possible values are: 0 = Copy Freely, 1 = Copy No More, 2 = Copy Once, 3 = Copy Never defines the content protection. Default is 0 |
| ccACP | NO | Possible values are: 0 = Copy protection encoding off, 1 = AGC process on. Split burst off, 2 = AGC process on. 2 line split burst on, 3 = AGC process on. 4 line split burst on. Default is 0 |
| pcrCorrection | NO | PCR correction to correct jitter in a movie, true or false. Default is false |
| videoMark | NO | true = VideoMark enabled, false = VideoMark disabled. Default is false |
| ecmControlWord | NO | true = ECM, false = NULL. default is false |
| ccDwightCavendish | NO | true enables Dwight Cavendish protection.Default value is false |
| ccHDCP | NO | true enables HDCP high-bandwidth Digital Content Protection. Default value is false |
| ratingLevel | NO | Rating level value (range 1 - 255). Default is 1 |
| encryptionDescription | NO | Description related to encryption |
| keyMutationInterval | NO | Number of packets in which to modify a key (range: 1 - 2147483647). Default is 1 |
| movieName | NO | Name of the movie |
| tag1 | NO | first tag for the movie |
| tag2 | NO | Second tag of the movie |
| tag3 | NO | Third tag for the movie |
| fileSize | NO | file size of the movie |
| fileType | NO | file type of the movie |
| networkId | NO | Id of Network |
| contentType | NO | VOD or DTV. Default is VOD |
| inputFilePath | NO | for iptv case, inputFilePath MUST NOT null; otherwise, it means ott case. |
| networkContentIdOtt | NO | for ott case, networkContentIdOtt is required. it is the resourceId from the key block. networkContentIdOtt is not used in iptv case. |
| valueTypeList | NO | |
| keyList | NO | |
| valueList | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of Start Encryption, 'Success' if successful |
| networkContentId | Id the Network uses to reference the content |
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: LEGACY, STB_IPTV, DESKTOP_PC, DESKTOP_MAC, RSM, RKE, PROF_RECEIVER, STB_DVB_STB, STB_DVB_SC, STB_DVB_NSC1, STB_DVB_NSC2, WEB_PC, WEB_MAC, WEB_IPHONE, WEB_ANDROID, WEB_STB, PLAYREADY_PC, PLAYREADY_MAC, PLAYREADY_IPHONE, PLAYREADY_ANDROID, PLAYREADY_STB |
| 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. Format: YYYY-MM-DDThh:mm:ss |
| 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. Format: YYYY-MM-DDThh:mm:ss |
| 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. According to the documentation preStartDuration is not currently supported but maybe in the future. |
| 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 |
| 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. 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. |
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 |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| handle | |
| networkId | |
| contentId | |
| networkContentId | |
| contentDescription | |
| contentTag | |
| response | |
| keyList | |
| valueList | |
| valueTypeList | |
| existingNetworkContentIds | |
| ratingLevel | |
| networkContentType | |
| defaultS | |
| defaultB | |
| defaultI | |
| result |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| handle | |
| contentId | |
| contentDescription | |
| contentTag | |
| response | |
| encryptionMode | |
| outputLocation | |
| inputFilePath | |
| keyInsertionInterval | |
| audioEncryptionLevel | |
| videoEncryptionLevel | |
| ccCGMS_A | |
| ccACP | |
| pcrCorrection | |
| videoMark | |
| ecmControlWord | |
| ccDwightCavendish | |
| ccHDCP | |
| ratingLevel | |
| encryptionDescription | |
| keyMutationInterval | |
| movieName | |
| tag1 | |
| tag2 | |
| tag3 | |
| fileSize | |
| fileType | |
| networkId | |
| contentType | |
| networkContentId | |
| networkContentType | |
| delay | |
| percentComplete | |
| status | |
| encryptedFilePath | |
| encryptionKeyBlock | |
| localOutputLocation | |
| existingNetworkContentIds | |
| keyList | |
| valueList | |
| valueTypeList | |
| networkContentIdOtt |
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 |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| handle | |
| keyList | |
| valueList | |
| valueTypeList | |
| networkContentId | |
| networkContentType | |
| networkId | |
| ratingLevel | |
| response | |
| smsContentId | |
| result |
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. true: operation sucess false: operation fail |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| handle | |
| contentId | |
| response | |
| result |
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 |
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 - 2012 Ericsson Television Inc. |
| All Rights Reserved. |