Services

Manage services

A service is a set of parameters required for a given processing type. Services can be manually started and stopped.

You can access services from the Home page dashboard or the left-side menu panel.

Service processing types

Processing typeRequired Software
Live EncodingMediaKind Live Encoder
On-Demand EncodingMediaKind On-Demand Encoder
Live PackagingMediaKind Packager
On-Demand PackagingMediaKind Packager
CatalogMediaKind Packager
MultiplexingMediaKind Multiplexer
Stream PersonalizationMediaKind Prisma
Viewing Policy ManagerMediaKind Prisma
Manifest ConditioningMediaKind Prisma
Stream ConditioningMediaKind Prisma
Content DecisioningMediaKind Prisma
TS SplicerMediaKind Prisma
Reliable TransportMediaKind Reliable Transport
ReceiverMediaKind RX1, MediaKind CE1

Display services

Services are listed in a table and are associated to a specific processing type. Service parameters and options depend on the processing type.

At least one service is configured.

  1. Click Services in the left-side menu panel. The table of services displays.

  2. You can use the search bar, filter by specific fields (such as status, processing types, source, animation, alarm level), or sort the table using the up and down arrows next to each field to refine the display.

Edit a service

To edit a service, just cick the name. It takes you to the service editing page.

Create a service

Service configurations vary per processing type. See the specific component documentation for detailed information about service creation.

  1. From the Services page, click Add Service.

  2. Select a processing type. The service parameter options display.

  3. You can configure the service parameters.

  4. Once you have completed the service configuration, click Save and exit.

  5. You can assign a server to the service. Multiple servers may be assigned to a same service.

  6. You can use the buttons in the action column to start or stop the service.

Assign a server to run the service

Services require a server to run. Select a server for each service before starting the service.

For failover configurations:

  • Failover only applies to certain processing types and configurations.
  • Inactive backup servers (in a failover group) cannot be assigned to run a service.
  • A primary server (in a failover group) that is in failover, meaning that a backup server has taken over and it is no longer running services, cannot be assigned to run services.

Typical use case, a service is assigned to one or more servers

  1. From the Services page, click Add Server in the Resources column to display the available servers.

  2. Tick one or more servers from the list then click Save. The selected servers are shown in the Resources column.

  3. You can start the service.

In case of redundant outputs (Live Encoder)

  1. From the Services page, go to the Resources column then click Add Server to display the available servers.

  2. Select a server from the list then select either Set Primary or Set Secondary.

Related information
Create redundancy variants

In case of variants (Live Encoder)

  1. From the Services page, go to the Resources column.

  2. Only servers that match the server tags for subsets are offered.

  3. Select a server from the list.

Related information
Create server variants

In case of variants and redundant outputs (Live Encoder)

  1. From the Services page, go to the Resources column.

  2. Only servers that match the server tags for subsets are offered.

  3. Select a server from the list then select either Set Ptrimary or Set Secondary.

Related information
Create server variants Create redundancy variants

In case of load balancing (On-demand Encoder)

You can assign additional servers to a service to help with load balancing. Encoding services are launched on the first server. When the first server in the pool of servers becomes saturated, the additional servers are used for encoding and job processing. When used with multiple servers, jobs are allocated on servers depending on their CPU usage.

  1. From the Services page, go to the Resources column.

  2. Select two or more servers from the list.

The service runs processes on the first server in the pool. Then, uses any additional resources in the pool job depending on their CPU usage.

Unassign a server from a service

  1. From the Services page, go to the Resources column.

  2. Select a server then click X next to the server name. The server is removed and is unassigned from the service.

Jobs that are running on an unassigned server are canceled and put back in the queue to be started again on another server.

Export a service configuration

Exported service configurations are for importing onto a different MediaKind system. This is useful for component or production support, or testing (parameters and expected function).

Export is available for Live Encoding services, On-Demand Encoding services, Live Packaging services, On-Demand Packaging services and Catalogs. Exports exclude the service state (started or stopped). Importing service configurations may require manually starting or stopping other services.

From the Services page, click in the Actions column then click to export. A file will download in your browser's default location.

The download date in the file name is in the following format: YYYY/MM/DD.

Import a service

You can import a single service to a different server where the service is not currently configured. Import files must match expected formatting requirements.

Before you start, ensure that a .json for the service is available. (See the Export a service configuration section)

⚠️

Services on a same server require unique service names. Only import the service to a server where the service DOES NOT currently exist.

  1. From the Services page, click the Import service... button.

  2. Click Select file to browse for the .json file previously exported for this service.

  3. Click Import. The service imports and appears in the list of services.

Start a service

Services can be started and stopped manually from the Services page.

Before you start: At least one service has been created and is available in the list of services, and at least one server is assigned to run the service.

From the Services page, click in the Actions column to launch the service. The Status changes to started.

If an alarm is raised, click to display all alarms. Alarm colors are based on severity.

Stop a service

Stop a service manually for support, testing or for general system administration purposes. Once stopped, the assigned server no longer executes the service.

⚠️

Stopping a service cancels any jobs in progress.

  1. From the Services page, click in the Actions column to stop the service. You are prompted to confirm.

  2. Click Yes, Stop it!. The service status changes to stopped. The service stops running.

With On-Demand encoder, jobs that are running on an unassigned server are canceled and put back in the queue to be started again on another server.

Delete a service

Deleting a service removes a service from the list of available services.

For detailed information regarding a Live Packaging service deletion, see Deleting a Live Packaging service and managing DVR.

  1. From the Services page, click in the Actions column then select the to delete the service.

  2. Click Yes, delete it! to confirm. The service is removed from the services table and is no longer available.

Bulk Actions

Some operations support bulk actions. You can select multiple services by ticking the corresponding boxes, or you can select all services on the page by ticking the box next to the Name column. Then, you can apply bulk operations such as start, stop, and delete. Stopping or deleting multiple services will prompt a warning message.

You can use the search bar, filter by specific fields, or sort the table using the up and down arrows to refine the services displayed before performing a bulk action..

Configure advanced parameters for an existing service

  1. From the Services page, click the service name to edit the service then click the Advanced parameters tab.

  2. Click Add then enter the parameter name and value. You can add multiple advanced parameters to the service.

  3. Click Save and continue before continuing in order to avoid losing the configuration.