Media Server 23.3

# Send Documents to IDOL

Media Server's IDOL output engine transforms metadata produced by Media Server into IDOL documents and indexes the documents into an IDOL Server.

The IDOL output engine uses an XSL template to transform records into IDX files. To modify the structure of the IDX file, modify the XSL template. For more information about indexing content into IDOL Server, refer to the IDOL Server Administration Guide.

To index information into IDOL Server

1. Create a new configuration to send to Media Server with the `process` action, or open an existing configuration that you want to modify.

2. In the `[Session]` section, add a new task by setting the `EngineN` parameter. You can give the task any name, for example:

       [Session]
       Engine0=IDOL

3. Create a new configuration section to contain the task settings, and set the following parameters:

   `Type` | The output engine to use. Set this parameter to `IDOL`.
   `Input` | (Optional) A comma-separated list of the tracks that you want to output. Specify one or more tracks. If you do not set this parameter, the engine outputs all tracks that are configured by default as 'output' tracks. For information about whether a track is considered an 'output' track, refer to documentation for your analysis, encoding, and ESP engines in the Media Server Reference.
   IDOLHost | (Optional) The host name or IP address of the IDOL Server. This overrides the IDOL Server host specified by the `IdolServer` parameter in the `[Resources]` section, if it has been set.
   IDOLPort | (Optional) The ACI port of the IDOL Server (by default, `9000`). This overrides the port specified by the `IdolServer` parameter in the `[Resources]` section, if it has been set.
   IDOLDb | (Optional) The IDOL database to index documents into. This overrides the database specified by the `IdolServer` parameter in the `[Resources]` section, if it has been set. If you do not set this parameter, documents are indexed into the database specified by their `DREDBNAME` metadata field. You can modify your XSL template to create this field. If a document does not specify a database it is indexed into the default database specified by the `DefaultDatabase` parameter, in the `[Databases]` section of the IDOL Server configuration file.
   IDOLParams | (Optional) Additional IDOL index action parameters. The IDOL output engine sends the `DREADDDATA` action to IDOL Server, which instructs the server to index the data contained in the request. You can send additional parameters with this action. For information about the available index action parameters, refer to the IDOL Server Reference.
   XSLTemplate | The path to the XSL template to use to transform records into documents in IDX format. You can modify the default XSL template as required - for example to produce XML rather than IDX files.
   `SavePostXML` | (Optional) Specifies whether to save IDX files produced by the IDOL output engine. If this parameter is set to `true`, you must also set the `XMLOutputPath` parameter.
   `SavePreXML` | (Optional) Specifies whether to save records received by the IDOL output engine. This might be useful if you want to customize your XSL template. If this parameter is set to `true`, you must also set the `XMLOutputPath` parameter.
   `XMLOutputPath` | (Optional) The path and file name of the file to save pre-XML and post-XML output to. Specify the path as an absolute path or relative to the Media Server executable file.

4. Configure how to combine records into documents. For information about how you can combine records, see Choose How to Output Data.

   - To output data in single record mode, set `Mode=SingleRecord`.
   - To output data in time mode, set `Mode=Time` and use the `OutputInterval` parameter to specify the amount of video content represented by each document.
   - To output data in event mode, set `Mode=Event` and use the `EventTrack` parameter to specify the event track. The event track must also be an input track, so include it in the list of tracks specified by the `Input` parameter.
   - To output data in bounded event mode, set `Mode=Bounded` and use the `EventTrack` parameter to specify the event track. The event track must also be an input track, so include it in the list of tracks specified by the `Input` parameter.
   - To output data in at-end mode, set `Mode=AtEnd`.
   - To output data in page mode, set `Mode=Page`.

5. Save and close the configuration file. OpenText recommends that you save your configuration files in the location specified by the `ConfigDirectory` parameter.

Example

The following is an example configuration to output data using the IDOL output engine.

    [IDOLOutput]
    Type=IDOL
    IdolHost=localhost
    IdolPort=9000
    IdolDB=BroadcastVideo
    Mode=Time
    OutputInterval=30s
    XslTemplate=toIDX.xsl
    SavePreXML=true
    SavePostXML=true
    XMLOutputPath=./Output/%segment.type%_%segment.sequence%_%segment.timestamp%.xml

Copyright 2023 Open Text
Version 23.3 | Last updated June 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to swpdl.idoldocsfeedback@microfocus.com.

We appreciate your feedback!

Product: IDOL Media Server 23.3

Topic Title: Send Documents to IDOL