Harmonic WFS encoding
This page provides details on how the OpenTV Platform integrates with Harmonic WFS 2.2 for the encoding workflow described here.
Interface description
The Harmonic WFS API provides SOAP as well as REST Interfaces. Only the SOAP interface is used for encoding.
The SOAP API methods that are used by the CMS Workflow Manager to interact with the Harmonic encoder are described below.
API: get workflow template
Call method |
|
Parameters |
|
Return | Workflow template. The template definition is itself an XML fragment supplied within the |
- Update the workflow template – before calling the
GenerateTemplateExJobByWorkflow
method, you must modify the Xpath in the previously-loaded workflow template with the proper target URL. - Create a
TemplateExXml
file. - Where encryption is required, update the
TemplateExXml
file withResourceID = "Generate DRM Content ID"
.
API: generate Job
Call method |
|
Parameters |
|
Return | The created Harmonic job along with the tasks. This takes the form of an XML file. The job and task GUIDs are assigned by JM (the Harmonic Job Manager). |
API: queue job
Call method |
|
Parameters |
|
Return | The queued Harmonic job along with the tasks. The job and task GUIDs are assigned by JM (the Harmonic Job Manager). |
API: get Harmonic job status
Call method | |
Parameters |
|
Return | Harmonic job status ( |
CMS configuration
Device
On the Harmonic_OriginServer
device, the WSAccessPoint
must be configured with the HTTP URL pointing to the Harmonic server where the API is hosted.
Profile
The encoding profile can be created by duplicating the corresponding profile template (as shown in the table below) and configuring the profile metadata as needed.
Currently, there are three encoding workflows for Harmonic. For each one, a different profile must be configured, as follows:
Service | Profile | Usage |
---|---|---|
Harmonic WFS Service | Template_PRM2.6_Harmonic | Encode/encrypt assets using Carbon Encoder. |
Harmonic WFS 1.6.x Xpress Service | Template_HarmonicWFS1.6.x_Xpress | Encode/encrypt assets using Xpress Encoder v1.6 and v1.7. |
Harmonic WFS 2.2.x Xpress Service | Template_HarmonicWFS2.2.x_Xpress | Encode/encrypt assets using Xpress Encoder v2.2. (v2.1 is not a stable release from Harmonic.) |
ESB service configuration
Parameter: 'Encoding Timeout'
Default value: one hour