C AMC and TMC Configuration Parameters

This appendix describes the AMC and TMC configuration parameters and includes the following information:

AM Communicator Configuration Parameters

This section identifies the AM Communicator parameters located in the AMC configuration file. Any parameter not specifically mentioned in the following table is used solely for debugging purposes and should not be modified from its default value.All listed parameters must be defined even if the default values are not provided in the configuration file.

All IP addresses mentioned in this section can be replaced by corresponding DNS names, provided the DNS service functions properly. If the Listener's IP address has the default value 0.0.0.0, then AM Communicator listens to all configured network interfaces on the given computer.

Table C-1 AM Communicator Configuration Parameters

Parameter Description Default Value

SERVICE_NAME

This parameter specifies the Windows service name for the AMC service. This option is required to run multiple AMC instances on a single computer.

If not specified, the default service name, DIVArchive AMCommunicator, is used.

DIVArchive AMCommunicator

AM_IP

This parameter identifies the IP address of the AM Communicator PBP (Play Back Protocol) Listener.

0.0.0.0

AM_PORT

This parameter identifies port number of the AM Communicator PBP Listener

6101

AM_TIMEOUT

This parameter identifies the time (in seconds) that AM Communicator waits for a connection from the DIVArchive Actor.

30

AM_MAX_CONNECTIONS

This parameter identifies the maximum simultaneous number of requests submitted by Avid.

This is present only in the 2.0.x packages.

100

AM_BUFFER_SIZE

This parameter identifies the size of the network I/O Buffer in kilobytes.

The valid value range for this parameter is from 8 to 2048 kilobytes. Oracle recommends keeping the default value for environments with high speed networks.

2048

AM_SOCKET_BUFFER_SIZE

This parameter identifies the socket receive and send buffer sizes in kilobytes. If this is set to 0, the system default values are used.

You can use this parameter to enable TCP/IP scaling if it is supported by the installed hardware and operating system.

0

AM_SOCKET_LINGER

This parameter identifies the maximum time (in seconds) the FTP Data Socket remains open during a Socket Close call to enable sending of queued data.

1

AM_MODE

This parameter identifies the AMC operation mode as follows:

1 - All clip or sequence files are archived as single DIVArchive object.

2 - Each clip or sequence file is archived individually.

3 - All files are archived as one DIVArchive object, but AMC tries to restore clips and sequences from individual files if an object containing all files does not exist. This is useful for migration purposes.

See Appendix A for Oracle DIVArchive options and licensing information.

1

AM_OPTIMIZE_FOR_MIGRATION

This parameter notifies AMC to restore the content in Single File Per Object Mode before searching for objects by file name.

You should set this parameter to 1 only when content archived in Single File Per Object Mode is used; that is, most often to speed up content migration to Multiple File Per Object format.

0

AM_READABLE_NAMES

When this parameter is set to 1, the original clip or sequence name is used as the DIVArchive object name rather than the Metadata MOB ID.

This parameter does not affect Single File Per Object Mode.

0

AM_OVERWRITE

This parameter identifies whether AMC attempts to delete an existing DIVArchive object, or returns an error if an object with the same name already exists in DIVArchive.

This parameter does not affect Single File Per Object Mode.

0

FTP_IP

This parameter identifies the IP address of the AM Communicator FTP interface.

You must set this parameter value to the IP address or DNS name visible from the DIVArchive Actor computers if the partition parameter from the Avid profile is interpreted as the DIVArchive Source/Destination, and multiple Archive, Restore, or both providers are used.

0.0.0.0

FTP_PORT

This parameter identifies the port of the AM Communicator FTP interface.

6121

FTP_LOGIN

This parameter identifies the login required to access AM Communicator through an FTP interface.

amc

FTP_PASSWORD

This parameter identifies the password required to access AM Communicator through an FTP interface.

diva

DIVA_MANAGER_ADDRESS

This parameter identifies the IP address of the DIVArchive Manager where AM Communicator sends requests.

You can specify multiple Manager IPs separated by commas. AMC will attempt to connect to the second IP if it cannot connect to the first, and so on. You must configure the same port number on all DIVArchive Managers.

localhost

DIVA_MANAGER_PORT

This parameter identifies the DIVArchive Manager port where AM Communicator sends requests.

9000

DIVA_REQUEST_RETRY

This parameter identifies the number of reconnect attempts made if a request sent by AM Communicator fails due to a lost connection with the DIVArchive Manager.

Oracle recommends leaving this value at the default setting.

1

DIVA_MONITOR_INTERVAL

This parameter identifies the request status polling interval (in seconds).

10

DIVA_SRCDST

This parameter identifies the name of the AMC Source/Destination configured in DIVArchive.

 

AM_CATEGORY_DELIMITER

This parameter identifies the delimiter separating the base category from the appended resolution, and optional index.

Changing this parameter after it has been set may prevent previously archived objects from being successfully restored.

~

AM_CATEGORY_IGNORE_LIST

This parameter identifies a comma separated list of resolution values that do not affect object category selection.

Metadata, PCM, WAVE, AIFC, MPEG1Layer2

AM_CATEGORY_MIXED_RESOLUTION

This parameter identifies a special resolution value to construct the category for multi-resolution content.

Oracle strongly recommends keeping this parameter value empty if AMC is upgraded from an earlier implementation.

 

DIVA_DEFAULT_CATEGORY

This parameter identifies the base category of DIVArchive objects created by AM Communicator.

 

DIVA_ARCHIVE_PRIORITY

This parameter identifies the priority of DIVArchive requests initiated by AM Communicator.

-1

DIVA_ARCHIVE_QOS

This parameter identifies the value of the Quality Of Service parameter for Archive requests initiated by AM Communicator.

0

DIVA_RESTORE_QOS

This parameter identifies the value of the Quality Of Service parameter for Restore, and Partial File Restore requests initiated by AM Communicator.

0

PARTITION_IS_MEDIA

When you set this parameter to 1, the partition parameter from the Archive Profile specifies the destination DIVArchive media. When the value is set to 0, the partition parameter value specifies the DIVArchive Source/Destination name.

1

DIVA_ARCHIVE_MEDIA

This parameter identifies the name of the DIVArchive media where objects are archived.

You use this parameter in configurations where the partition parameter value identifies the Source/Destination, and when the archive is submitted with no profile selected.

 

AM Communicator Default Configuration File

The following file is the default AMC configuration file delivered with Avid, and is named amc.conf.ini. See the previous section for parameter descriptions and default values.

#########################################
# AM Communicator network interfaces
#########################################

# AMC service name
SERVICE_NAME =

# AMC listener ip and port (default 6101)
AM_IP =
AM_PORT = 6101

# Time in seconds AM Communicator waits
# for connection from Diva Actor
AM_TIMEOUT = 14400

# Network I/O buffer size in kilobytes
AM_BUFFER_SIZE = 2048

# Socket receive and send buffer sizes in kilobytes
# If set to 0 system default values are used
AM_SOCKET_BUFFER_SIZE = 0

# Maximum time in seconds FTP data socket remains open
# on socket close call to enable sending of queued data
AM_SOCKET_LINGER = 1

# Maximum simultaneous number of requests submitted by AVID
# default is 100
AM_MAX_CONNECTIONS = 100

# Hints AMC to restore content in single file
# per object mode before searching for objects
# by file name
AM_OPTIMIZE_FOR_MIGRATION = 0

##########################################
# Parameters from the block below affect
# only multiple files per object modes
##########################################

# Indicates whether existing DIVA object
# is deleted as a result of archiving an
# object under the same name
AM_OVERWRITE = 0

# Indicates whether metadata mob id or
# clip/sequence name is used as DIVA
# object name
AM_READABLE_NAMES = 0

# Delimiter used to separate default category from
# appended resolution and optional index
AM_CATEGORY_DELIMITER = ~

# A comma separated list of resolution values that
# do not affect object category selection
AM_CATEGORY_IGNORE_LIST = Metadata, PCM, WAVE, AIFC, MPEG1Layer2

# A special resolution value used to construct
# category for multi resolution content
AM_CATEGORY_MIXED_RESOLUTION =

#########################################
# Diva connectivity parameters
#########################################

# A comma separated list of Diva Manager IPs/DNS names AMC tries to connect to DIVA_MANAGER_ADDRESS = localhost
# Diva Manager port
DIVA_MANAGER_PORT = 9000

# Number of retry attempts made when
# connection to Diva Manager fails
DIVA_REQUEST_RETRY = 1

# Request status polling interval
# in seconds
DIVA_MONITOR_INTERVAL = 10

#########################################
# Diva request parameters
#########################################

# AMC source name in DIVA
DIVA_SRCDST =

# Category set for archived objects
# in single file per object mode
DIVA_DEFAULT_CATEGORY =

# Priority of submitted requests
DIVA_ARCHIVE_PRIORITY = -1

# Values for DIVA_ARCHIVE_QOS:
# 0 => DIVA_QOS_DEFAULT      // Direct and Cache
# 1 => DIVA_QOS_CACHE_ONLY     // Cache only
# 2 => DIVA_QOS_DIRECT_ONLY    // Direct only
# 3 => DIVA_QOS_CACHE_AND_DIRECT  // Cache and direct (if cache n/available)
# 4 => DIVA_QOS_DIRECT_AND_CACHE  // Direct and cache (if direct n/available)
DIVA_ARCHIVE_QOS = 0

# Values for DIVA_RESTORE_QOS:
# 0 => DIVA_QOS_DEFAULT      // Direct and Cache
# 1 => DIVA_QOS_CACHE_ONLY     // Cache only
# 2 => DIVA_QOS_DIRECT_ONLY    // Direct only
# 3 => DIVA_QOS_CACHE_AND_DIRECT  // Cache and direct (if cache n/available)
# 4 => DIVA_QOS_DIRECT_AND_CACHE  // Direct and cache (if direct n/available)
DIVA_RESTORE_QOS = 0

# Indicates whether partition parameter from
# archive profle is used as destination media
# name or source/destination name
PARTITION_IS_MEDIA = 1

# If PARTITION_IS_MEDIA parameter is set to 0
# this parameter specifies destination media
# name. Otherwise it is used only if archive
# is submitted with no profile selected on
# Avid side
DIVA_ARCHIVE_MEDIA =

TM Communicator Configuration Parameters

This section describes the TM Communicator parameters in the TMC configuration file. Any parameter not specifically mentioned in the following tables is used solely for debugging purposes and must not be modified from its default value.

The parameters are logically split into three groups:

  • Common Parameters (required for both DHM and DET workflows)

  • DHM Related Parameters

  • DET Related Parameters

When you configure the TM Communicator to support any of the two workflows, you must define all common parameters, and parameters pertaining to the corresponding workflow. All listed parameters must be defined even if default values are not specified in the configuration file.

You can replace all IP addresses mentioned in this section with the corresponding DNS names, provided the DNS service functions properly. If the Listener's IP address has the default value 0.0.0.0, the TM Communicator listens to all configured network interfaces, and passes the DNS name of its host to the Oracle Sender, Oracle Receiver, or both.

Setting values of the timeout parameters, PLAYBACK_TIMEOUT, INGEST_TIMEOUT, and DET_TIMEOUT greater than 120 seconds is impractical and leads to increased memory consumption because the DIVArchive Actor closes inactive TM Communicator connections in 120 seconds. Oracle recommends keeping these parameters at the default values.

Table C-2 Common TM Communicator Parameters

Parameter Description Default Value

SERVICE_NAME

This parameter identifies the Windows service name for the TMC service.

If not specified, the default Service Name DIVArchive TMCommunicator is used.

DIVArchive TMCommunicator

TM_WORKSPACE

This parameter identifies the Avid Unity Workspace (logical storage unit).

 

TM_USER

This parameter identifies the Avid Unity user name.

This user must have write access to TM_WORKSPACE.

 

DIVA_MANAGER_ADDRESS

This parameter identifies the IP address of the DIVArchive Manager where TM Communicator sends Archive requests.

You can specify multiple Manager IPs separated by commas. TMC will attempt to connect to the second IP if it cannot connect to the first, and so on. You must configure the same port number on all DIVArchive Managers.

localhost

DIVA_MANAGER_PORT

This parameter identifies the port of the DIVArchive Manager where TM Communicator sends Archive requests.

9000

DIVA_REQUEST_RETRY

This parameter identifies the number of reconnect attempts made if the request sent by TM Communicator fails due to a lost connection with the DIVArchive Manager.

Oracle recommends leaving this parameter value set to the default.

1

DIVA_MONITOR_INTERVAL

This parameter identifies the request status polling interval (in seconds).

10

FTP_IP

This parameter identifies the TM Communicator FTP interface IP address.

0.0.0.0

FTP_PORT

This parameter identifies the TM Communicator FTP interface port.

6021

TM_BUFFER_SIZE

This parameter identifies the size of the network I/O Buffer (in kilobytes).

The valid value range for this parameter is from 8 to 2048 kilobytes. Oracle recommends keeping the default value for environments with high speed networks.

2048

TM_SOCKET_BUFFER_SIZE

This parameter identifies the socket receive and send buffer sizes (in kilobytes). If set to 0, the system default values are used.

You can use this parameter to enable TCP/IP scaling, if it is supported by installed hardware and operating system.

0

TM_SOCKET_LINGER

This parameter identifies the maximum time (in seconds) that the FTP data socket remains open in a Socket Close call to enable sending of queued data.

1


Table C-3 TM Communicator DHM Related Parameters

Parameter Description Default Value

DHM_LOGIN

This parameter identifies the login required to access TM Communicator through an FTP interface in the DHM workflow.

dhm

DHM_PASSWORD

This parameter identifies the password required to access TM Communicator through an FTP interface in the DHM workflow.

diva

PBP_IP

This parameter identifies the IP address of the TM Communicator Receiver that accepts PBP contacts from the Transfer Manager (DHM Archive workflow).

0.0.0.0

PBP_PORT

This parameter identifies the port of the TM Communicator Receiver that accepts PBP contacts from the Transfer Manager (DHM Archive workflow).

6535

TM_PLAYBACK_IP

This parameter identifies the IP address of the TM Communicator Receiver that listens for connections from the Oracle Sender (DHM Archive workflow).

0.0.0.0

TM_PLAYBACK_PORT

This parameter identifies the port of the TM Communicator Receiver that listens for connections from the Oracle Sender (DHM Archive workflow).

6001

PLAYBACK_TIMEOUT

This parameter identifies the time (in seconds) that TM Communicator waits for a connection from the DIVArchive Actor (DHM Archive workflow).

30

TM_INGEST_IP

This parameter identifies the IP address of the TM Communicator Receiver that listens for connections from the Oracle Receiver (DHM Restore workflow).

0.0.0.0

TM_INGEST_PORT

This parameter identifies the port of the TM Communicator Receiver that listens for connections from the Oracle Receiver (DHM Restore workflow).

6002

INGEST_TIMEOUT

This parameter identifies the time (in seconds) that TM Communicator waits for a connection from the Oracle Receiver (DHM Restore workflow).

30

AVID_METADATA_FORMAT

This parameter identifies the format of the Avid composition submitted to initiate ingest (DHM Restore workflow).

You must set this parameter to AAF if Avid Media Manager is set to MXF/AAF mode, otherwise it should be set to OMFI (Open Media Framework Interchange).

OMFI

INGEST_QUEUE_SIZE

This parameter identifies the maximum number of video frames and audio chunks per clip stored in memory on the Avid Transfer Manager side during a DHM Restore.

100

INGEST_SET_TAPE

Setting this parameter to 0 forces TM Communicator to use an empty string rather than the clip name or title (if present) for the Tape field in the Avid Metadata.

1

MUXER_TYPE

This parameter identifies the format of clips stored in DIVArchive (DHM Archive workflow).

This parameter must be set to either GXF or MXF.

GXF

MUXER_SMPTE386M

Setting this parameter to 1 forces TM Communicator to generate MXF D-10 clips compliant with the SMPTE 386M standard (DHM Archive workflow).

Oracle recommends keeping the default value for this parameter.

1

MUXER_DV_AES3

Setting this parameter to 1 forces TM Communicator to generate MXF DV-25 and DV-50 clips with AES3 audio rather than WAV audio (DHM archive workflow).

Oracle recommends keeping the default value for this parameter.

0

DEMUXER_TYPE

This parameter identifies whether ingested clips are considered to be GXF or MXF when the clip type is not explicitly defined by the file extension (DHM Restore workflow).

This parameter must be set to either GXF or MXF.

GXF

DEMUXER_D10_STRIP

Setting this parameter to 1 enables stripping of MPEG user data from D10 frames of restored clips (DHM Restore workflow).

Oracle strongly recommends keeping the default value of this parameter, unless changing it is absolutely required to enable DHM restore of D10 clips.

0

DEMUXER_D10_STRICT

Setting this parameter to 0 disables checking of restored D10 clips for frame size compliance (DHM Restore workflow).

Oracle does not recommend disabling the check permanently because it might lead to creation of non-playable clips in Avid Unity.

1

DEMUXER_UMF_TIMECODE

Setting this parameter to 0 forces the GXF demuxer to retrieve the timecode from the MAP packet, rather than the UMF packet, during GXF clip restore (DHM Restore workflow).

Oracle strongly recommends keeping the default value of this parameter.

1

CONVERT_24BIT_AUDIO

Setting this parameter to 1 enables conversion of 24-bit audio to 16-bit during DHM Archive and Restore.

Oracle recommends keeping the default value of this parameter, and enabling the conversion only if it is required for software or hardware compatibility.

0

IGNORE_FILL_TRACKS

This parameter identifies whether TMC ignores audio tracks composed entirely of fill (reserved) segments, or terminates the corresponding DHM Archive request (DHM Archive workflow).

If you set this parameter to 1, fill tracks are removed, and subsequent audio tracks are shifted.

1

CHECK_AUDIO_TRACKS

This parameter identifies whether TMC terminates the DHM Archive request when it cannot obtain an audio sample size for an audio track, or assumes that the sample size in question is consistent with that of other audio tracks from the same sequence (DHM Archive workflow).

1

DIVA_DHM_SRCDST

This parameter identifies the name of the TM Communicator DHM Source/Destination configured in DIVArchive.

 

DIVA_DHM_ARCHIVE_MEDIA

This parameter identifies the name of the DIVArchive media where objects archived through TM Communicator in the DHM workflow are stored.

 

DIVA_DHM_ARCHIVE_CATEGORY

This parameter identifies the category of DIVArchive objects archived through TM Communicator in the DHM workflow.

 

DIVA_DHM_ARHIVE_PRIORITY

This parameter identifies the priority of DIVArchive Archive requests initiated by TM Communicator in the DHM workflow.

-1

DIVA_DHM_ARCHIVE_QOS

This parameter identifies the value of the Quality Of Service parameter for DHM Archive requests initiated by TM Communicator.

0


Table C-4 TM Communicator DET Related Parameters

Parameter Description Default Value

DET_LOGIN

This parameter identifies the login required to access TM Communicator through an FTP interface in the DET workflow.

det

DET_PASSWORD

This parameter identifies the password required to access TM Communicator through an FTP interface in the DET workflow.

diva

TM_DET_IP

This parameter identifies the IP address of the TM Communicator Receiver that listens for connections from the Oracle Transceiver (DET Archive and Restore workflows).

0.0.0.0

TM_DET_PORT

This parameter identifies the TM Communicator Receiver port that listens for connections from the Oracle Transceiver (DET Archive and Restore workflows).

6003

DET_TIMEOUT

This parameter identifies the time (in seconds) that TM Communicator waits for a connection from the Oracle Transceiver (DET Archive and Restore workflows).

30

DET_PULL_NAME

This parameter identifies the name of the DET Pull Device configured on the Avid Transfer Manager side for DET Restore requests.

DivaPullTransfer

DET_XML_DUMP

If this parameter is set to 1, TM Communicator stores incoming XML Metadata on the local disk (DET Archive workflow).

0

DET_XML_PATH

This parameter identifies the full path on the local disk where TM Communicator stores incoming XML Metadata (DET Archive workflow).

You must manually create directories that compose a defined path. TM Communicator will not attempt to create the specified path, and will not verify its accuracy.

 

DIVA_DET_SRCDST

This parameter identifies the name of the TM Communicator DET Source/Destination configured in DIVArchive.

 

DIVA_DET_ARCHIVE_MEDIA

This parameter identifies the name of the DIVArchive media where objects archived through TM Communicator in the DET workflow are stored.

 

DIVA_DET_ARCHIVE_CATEGORY

This parameter identifies the category of the DIVArchive objects archived through TM Communicator in the DET workflow.

-1

DIVA_DET_ARCHIVE_PRIORITY

This parameter identifies the priority of the DIVArchive Archive requests initiated by TM Communicator in the DET workflow.

0

DIVA_DET_ARCHIVE_QOS

This parameter identifies the value of the Quality Of Service parameter for DET Archive requests initiated by TM Communicator.