Introduction

When you queue up tasks from various menus or tasks are queued up in response to a core event, SJQv4 will automatically attach metadata about the object associated with the event or menu from which the task was queued. This document lists all of the metadata that will be attached to tasks for specific events.

Accessing the Metadata

The metadata provided is accessed in one of two ways:

• If you're in an SJQ ScriptEnv script (i.e. Groovy script) then you access the metadata via the SJQ4_METADATA map. It's a map of string keys to string values. The keys of the map are the Variables in the tables below. Remember, that all values in the map are strings and need to be converted as required.
• If you're in an executable, shell script, batch file, etc. (i.e. anything other than a ScriptEnv script) then these maps are available as environment variables in your running process. Access to the values is implementation dependant. In a Windows batch file you'd access the env vars like %SJQ4_TYPE% and in a Linux shell script it would be like $SJQ4_TYPE. If you're in a Java program, C#, Perl, etc. then see your programming API for details on how to access environment variables within your programs.

Object Metadata Maps

The tables below describe the metadata attached for each of the supported Sage object types. For the values column, a fixed width string denotes a literal value (i.e. that's the actual value of the variable you will see at runtime). An italic value is a description of what the value will be (i.e. Integer means that the value will be an integer number). NOTE: All values in the map are actually strings and need to be converted as required. So even though the type may say Integer, it's only describing the format of the value. You must convert it to an integer within your Groovy script. Please be aware that only a limited subset of each object type's values are actually exposed in the metadata maps. If the data you need is not exposed then you simply have to access the object directly in your script and pull out whatever data you want. This is possible because the type of object and the unique id (key) will always be exposed to the metadata map (when possible).

Airing

To access more data from an Airing object in the SJQ ScriptEnv, simply access the object directly.

Object airing = AiringAPI.GetAiringForID(SJQ4_METADATA.get("SJQ4_ID").toInteger())
println AiringAPI.GetExtraAiringDetails(airing)

Show

To access more data from a Show object in the SJQ ScriptEnv, simply access the object directly.

Object show = ShowAPI.GetShowForExternalID(SJQ4_METADATA.get("SJQ4_ID"))
println ShowAPI.GetPeopleInShow(show)

Channel

To access more data from a Channel object on the SJQ ScriptEnv, simply access the object directly.

Object channel = ChannelAPI.GetChannelForStationID(SJQ4_METADATA.get("SJQ4_ID").toInteger())
println ChannelAPI.IsChannelViewable(channel)

MediaFile

To access more data from a MediaFile object in the SJQ ScriptEnv, simply access the object directly.

Object mediaFile = MediaFileAPI.GetMediaFileForID(SJQ4_METADATA.get("SJQ4_ID").toInteger())
println MediaFileAPI.GetSize(mediaFile)