Harmonic PMOS content purge workflow
This page provides details on how the OpenTV Platform integrates with Harmonic® ProMedia® Origin Server (PMOS) for the content purge workflow described here. The workflow was validated against Harmonic PMOS version 1.2.
Compliance
The only dependency is Harmonic ProMedia Asset Management Interface (AMI) v0.21.
Interface description
REST structure
The Harmonic ProMedia Origin Server allows you to get content status and to delete content from the origin server via the HTTP GET and DELETE methods.
Base URL: http_URL = "http://" + <host> + ":" + <port> + "/ami/" + <resource>
The Harmonic AMI Interface returns an HTTP 200 response code in case of success and 400, 404, 500, or 503 in case of failure.
Sample GET request to get content status
GET /ami/vod/<asset_type>/asset/<asset_name>No payload is required for this request.
Sample DELETE request to purge content
DELETE /ami/vod/<asset_type>/asset/<asset_name>No payload is required for this request.
Parameter details
This applies to both GET and DELETE.
asset_name
asset_name is the name of the playable asset that is generated after processing the content.
In the CMS model, this is the Asset object's filename property.
This is configured on the Harmonic Encoder during the content processing phase and is also available in the CMS. It is a relative path on the Harmonic Origin Server that points to the location of the encoded asset.
Examples
For HLS encryption: HarmonicEx1_LYS000006188_20150804_121410/index/index.m3u8.
For SS encryption: HarmonicEx1_LYS000006188_20150804_121410/index/index.ismc.
When building the asset name for the REST call (see the REST section), the relativePath field of the Asset Device Link (ADL) stored in the CMS database is not taken into account.
This is because for the companion Harmonic Encoding workflow we store the fullpath in the playable asset name field itself.
asset_type
asset_type is extracted from the purge profile.
The following asset types are accepted by the Harmonic interface.
There are several asset types that are supported by the Harmonic PMOS 1.2 Origin Server, but some of them will not be used within the workflow as CMS is not able to produce and publish such types of files.
Asset type | Description | Supported |
|---|---|---|
| HLS | Apple IETF draft v0.4 |  |
| SS | Microsoft Smooth Streaming (Silverlight) | |
| PDL | HTTP Progressive Download of HTTP object |  |
| HDS | Adobe HTTP Dynamic Streaming | |
Harmonic AMI 0.21 interface response status codes
Status code | HTTP operation | Description |
|---|---|---|
200 OK | GET | The operation was successful. |
200 OK | DELETE | The VOD asset delete command hs been received and is being processed. The asset might remain in the Pending Delete state up to one hour before it is deleted. The asset will immediately go into an offline administrative state to prevent further downloads of the content. |
400 Bad Request | GET, DELETE | The request contains invalid syntax or cannot be fulfilled. |
500 Internal Server Error | GET, DELETE | The Origin Server is in error state. |
503 Service Unavailable | GET, DELETE | The Origin Server is not ready to process the request. |
CMS Configuration
Device
On the Harmonic_OriginServer device, configure the WSAccessPoint with the HTTP URL pointing to the Harmonic server where the API is hosted.
If you have already published assets on the Harmonic Origin Server and want to add a new purge workflow, you must configure the new WSAccessPoint field on the existing device. Do not create a new device.
Profile
The purge profile can be created by duplicating Template_Purge_Asset_On_Harmonic_OriginServer and then configuring profile metadata as needed.
ESB service configuration
Parameter: 'Purge Timeout'.
Default value: one hour.