Service: BXF Manager - EyevinnOSC/community GitHub Wiki

BXF Manager

BXF Manager (serviceId joeldelpilar-bxf-manager) is a tool for working with BXF (Broadcast Exchange Format) files, the XML-based standard used in broadcast scheduling to exchange programme and traffic data between playout systems, traffic systems and EPGs. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance (web service). Source: JoeldelPilar/bxf-manager.

What it can do

  • Edit and format BXF files in a web interface.
  • Optionally persist BXF files in an S3-compatible bucket, for example MinIO on OSC.

Creating an instance

Create the instance with create-service-instance using serviceId: "joeldelpilar-bxf-manager" and a config object. The instance name must be alphanumeric and at most 20 characters. BXF Manager has no dependencies on other OSC services. S3 storage is optional; if you want it, create the bucket (for example on a MinIO instance) first and confirm it is running.

Minimal example, without S3 storage:

{ "name": "mybxfmgr" }

Example with S3 storage:

{
  "name": "mybxfmgr",
  "s3Endpoint": "https://<minio-instance>.auto.prod-se.osaas.io",
  "s3Region": "us-east-1",
  "s3AccessKeyId": "{{secrets.bxfaccesskey}}",
  "s3SecretAccessKey": "{{secrets.bxfsecretkey}}",
  "s3BucketName": "bxf-files"
}

Wait for the instance to become ready with wait-for-service-ready (or check get-instance-status), then use describe-service-instance to read the instance URL. Open the URL to use BXF Manager.

Options

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric/underscore only (^\w+$), at most 20 characters.
s3Endpoint No string URL of the S3-compatible endpoint used to persist BXF files, for example https://<minio-instance>.auto.prod-se.osaas.io.
s3Region No string Region of the S3 service, for example us-east-1 for MinIO.
s3AccessKeyId No string, sensitive Access key ID for the S3 bucket.
s3SecretAccessKey No string, sensitive Secret access key for the S3 bucket.
s3BucketName No string Name of the bucket where BXF files are stored.

Store the two S3 credentials as service secrets with create-service-secret (serviceId: "joeldelpilar-bxf-manager", a secret name and its value) and reference them as {{secrets.NAME}}. A reference must be the entire field value. Overwriting a secret does not restart a running instance.

Using the instance

Open the instance URL from describe-service-instance to work with BXF files. Use get-logs-for-instance if S3 persistence does not work and check the endpoint, region and credentials.

Resources

⚠️ **GitHub.com Fallback** ⚠️