7 Installing and Configuring TM Communicator

This chapter describes installation and configuration of TM Communicator. Installation and configuration of additional components is described only to the extent necessary to allow interaction with TM Communicator.

See Appendix A for Oracle DIVArchive options and licensing information.

The following information is included in this chapter:

Installing TM Communicator
- Installing the Transfer Manager Client
- TM Communicator Command Line Options
Configuring TM Communicator

Installing TM Communicator

You must complete separate configuration stages for DIVArchive, TM Communicator, and Avid Transfer Manager or Avid Interplay Transfer Engine to set up media transfers between DIVArchive and Avid Unity through the TM Communicator.

The following definitions apply when the term is used within this chapter:

$TMC_HOME: This term identifies the TM Communicator folder.
$TMC_HOST: This term identifies the DNS name or IP address of the computer where TM Communicator is installed.
$TMSERVER_HOST: This term identifies the DNS name or IP address of the computer where Avid Transfer Manager is installed.
$TMSERVER_HOME: This term identifies the Avid Transfer Manager (or Interplay Transfer Engine) folder on the Avid Server.
$WORKSPACE: This term identifies the Avid Unity workspace used for transfers.
$DIVA_HOME: This term identifies the DIVArchive folder created on the target computer during installation.
$WINDOWS_HOME: This term identifies the folder where Microsoft Windows is installed on the target computer.

You can install the TM Communicator on any computer accessible through the network from the DIVArchive Actor, DIVArchive Manager, and Avid Transfer Manager hosts. This option allows installation of TMC on its own computer, separate from any specific server, if you want it configured this way. See Appendix A for Oracle DIVArchive options and licensing information.

You use the following procedure to install TM Communicator:

Copy the files from the $DIVA_HOME/TMCommunicator/bin folder to the $TMC_HOME folder on the destination computer.

For installation in Interplay environments, you must use the appropriate /bin subfolder under the TMCommunicatorI22, TMCommunicatorI25, or TMCommunicatorI26 folder.
Rename the default configuration file, tmc.conf.ini, in the $DIVA_HOME/conf/tmc subfolder to tmc.conf. You must append the service name matching the SERVICE_NAME parameter value from the TMC configuration to the file name, if the SERVICE_NAME parameter value is set. That is, you must rename the file to tmc_{$SERVICE_NAME}.conf.
Change the parameter values in the TMC Configuration file. If you are only configuring the DHM or the DET workflow, you must only specify parameters related to the selected workflow.

The TM Communicator requires you to install and configure the Avid Transfer Manager Automation API and the Transfer Manager Client on the same computer. The TMC process must have permission to access the license registry keys.

Note:

TM Communicator requires you to install the MOG SDK license to provide support for the MXF format in the DHM Restore and Archive workflows. The license comes in the form of a file that must be merged into the Windows Registry. You must apply the license registry for MOG SDK Modules if you are using DNxHD or AVCIntra formats.

If you execute TM Communicator as a Windows system service, you must start it using the account of the user who installed the license. To verify the account being used, open the Services Window from Windows Control Panel and follow this procedure:

Right click the TM Communicator Service.
Select Properties.
Click the Log On tab.
Select the This Account option, and enter the corresponding user login and password.

Installing the Transfer Manager Client

Oracle highly recommends installing the Transfer Manager Client release that matches the release level of the Transfer Manager Server and Interplay Transfer Engine. Interplay components are not compatible with their Workgroup 4 counterparts, and often with other Interplay releases.

You sue the following procedure to install the Transfer Manager Client:

Execute the Transfer Manager Client software installation program.
Select the Client for Avid Editing Station option.
Follow the on screen instructions.

The Transfer Manager Client requires the TMClient.ini file on the target computer to be modified as follows:

TMClient.ini
[MyServer,MyWorkgroup]
MyServer = $TMSERVER_HOST, $WORKSPACE

If a domain name is used as the $TMSERVER_HOST value, it must correctly resolve to the corresponding IP address.

The $WORKSPACE value must match the value of the TM_WORKSPACE parameter from the TMC configuration file. See TM Communicator Configuration Parameters for detailed parameter descriptions.

The location of the TMClient.ini file depends on the Avid Transfer Manager Client release:

For non-Interplay environments, and Interplay releases before Interplay 1.6, the file is in $TMC_HOME.
For Interplay releases from 1.6 to 2.1, the location depends on the operating system release.

For example, on Windows 2008 and later, you must copy the file to the %ALLUSERSPROFILE%\Avid folder, and on Windows XP or 2003 you must copy it to the $TMC_HOME folder.
For Interplay 2.2 and later, the location depends on the operating system release:

For example, on Windows 2008 and later, you must copy the file to the %ALLUSERSPROFILE%\Avid\TMCService folder, and on Windows XP or 2003, you must copy it to the %ALLUSERSPROFILE%\Application Data\Avid\TMCService folder.

TM Communicator Command Line Options

You can start TM Communicator either as a Windows system service, or as a console application. Oracle recommends running TMC as a system service in production environments. However, console mode is useful when performing troubleshooting activities.

You can specify a fully qualified configuration file path in the command line using the -conf (or its alias -f) option.

For example, the following command starts a TMC instance using parameters from the configuration file named tmc_example.conf, and runs in console mode (the -d option). You must set the SERVICE_NAME parameter value to example for this sample. See TM Communicator Configuration Parameters for all TMC parameters.

TMCService -d -conf ../conf/tmc/tmc_example.conf

TMCommunicator supports the following command-line options:

install or -i: This option installs TMC as a Windows service using the provided command-line options as the default parameters. This option will not start the service, it only installs the service.
uninstall or -u: This option removes TMC from the Windows services. This option will stop the service automatically if it is running.
debug or -d: This option starts the TMC service in console mode. The console mode provides additional information as standard output.
version or -v: This option displays the TMC release level, and then exits.
help or -h: This option displays use information, and then exits.
conf or -f: This option specifies a fully qualified configuration file path for TMC to use instead of the default configuration file.

Configuring TM Communicator

The following sections describe the configuration procedures for TM Communicator.

Configuring the Transfer Manager Automation API

The configuration steps listed in this section are required only for the DHM Workflow and can be skipped in DET-Only environments.

The Transfer Manager Automation API is supplied with the TM Communicator in the form of the Avid TM Auto API DLL, and enables communication with the Avid Transfer Manager.

To process DHM Restore requests correctly, the Transfer Manager Automation API requires the following two configuration files:

AvidTMAAPI_Ingest_DeviceToSetupFile.txt

The contents of this file are as follows:

Avid TMAAPI_Ingest_HostToDevice.txt
#This is the default file for converting Ingest Host Name to Device #Name
#It needs to be in the following format (everything inside the #double-quotes on a new line):
# "[IngestHostName] [IngestDeviceName]"
# make sure you also set the other file - IngestDeviceName to #SetupDLL
#
$TMC_HOST FPDI_Ingest

AvidTMAAPI_Ingest_HostToDevice.txt

The contents of this file are as follows:

# This is the default file for converting Ingest Device Name to #Setup File Name
# It needs to be in the following format (everything inside the #double-quotes on a new line):
# "[IngestDeviceName] [IngestSetupFileName]"
# make sure you also set the other file - IngestHostName to #IngestDeviceName
#
FPDI_Ingest fpdisetup

You must only enter the correct value for $TMC_HOST. You must use the DNS name instead of the IP address as the $TMC_HOST value, and it must correctly resolve to the IP address entered as the TM_INGEST_IP value in the TMC Configuration File.

You must copy the previous two files to different locations depending on the environment release:

For Avid Transfer Manager 2.9.x and Interplay environments before Interplay 1.6, you copy the configuration files to the $WINDOWS_HOME folder on the target computer.
For Interplay 1.6 and later environments, you copy the configuration files to the %ALLUSERSPROFILE%\Application Data\Avid\TMAuto folder on Windows XP or 2003, and to the %ALLUSERSPROFILE%\Avid\TMAuto folder on Windows 2008 and later.

Configuring TM Communicator Source/Destinations in DIVArchive

Caution:

DHM and DET Source/Destinations must use different login and password parameter pairs. Entering the same values will lead to termination of all DET requests.

Also, Oracle strongly recommends matching Max Read Accesses/Max Write Accesses and Max Simultaneous Playback Transfers/Max Simultaneous Ingest Transfers parameter values from the Avid Transfer Manager configuration for DHM Source/Destinations, or Max DET Push Transfers/Max DET Pull Transfers for DET Source/Destinations.

You must configure two separate FTP Source/Destinations in DIVArchive, using the Configuration Utility, to enable TM Communicator DHM and DET workflows. Although these Source/Destinations have different types, AVID_DHM for DHM workflows and AVID_DET for DET workflows, both have the same set of parameters as follows:

Source Name

This parameter identifies the Source/Destination name for the TM Communicator.

For DHM workflows, the value must match the value of the DIVA_DHM_SRCDST parameter from the TMC configuration file for DHM workflows.

For DET workflows, the value must match the value of the DIVA_DET_SRCDST parameter from the TMC configuration file for DET workflows.

IP Address

This parameter identifies the IP address of the TM Communicator FTP computer. This value must be consistent with the value of the FTP_IP parameter from the TMC configuration file. This value is the same for both DHM and DET workflows.

Source Type

You select the correct source type from the list. You use AVID_DHM for DHM workflows, and AVID_DET for DET workflows.

Connect Options

This parameter identifies the TM Communicator FTP port, login, user name, and data socket buffer size (in kilobytes).

These values must match the values of the FTP_PORT, DHM_LOGIN, DHM_PASSWORD, and TM_BUFFER_SIZE from the TMC configuration file for DHM workflows.

These values must match the values of the FTP_PORT, DET_LOGIN, DET_PASSWORD, and TM_BUFFER_SIZE from the TMC configuration file for DET workflows.

An example entry in this field might be -login dhm -pass diva -port 6021 for a DHM workflow, or -login det -pass diva -port 6021 for a DET workflow.

TMC supports Passive Mode FTP for both DHM and DET workflows. To switch to Passive Mode FTP add the -PASV option to either string.For example, -login dhm -pass diva -port 6021 -PASV or -login det -pass diva -port 6021 -PASV.

Configuring Avid Transfer Manager

Avid provides a unified GUI to set both the DHM, and DET, related parameters of Transfer Manager and Interplay Transfer Engine.

You use the following procedure to configure the Transfer Manager server:

Open the Transfer Manager Server Configuration GUI.
Change the following settings under each section of the screen:
- Workgroups
  - Select the check box for the Workgroup transfers enabled option to enable the option.
  - Select the check box for the Incoming workgroup transfers enabled option to enable the option.
  - Enter the required value in the Max. simultaneous workgroup transfers field.
  - Leave the default value in the Directory for temporary composition files field.
  - Select the check box for the Delete temporary composition files after transfers option to enable the option.
  - Add 1 line to the Workgroup name field containing {Name of Workspace} {Name of Transfer Manager Server}.
- Playback (for DHM only)
  - Select the check box for the Playback transfers enabled option to enable the option.
  - Enter the required value in the Max. simultaneous playback transfers field.
  - Add the IP address of the computer where TM Communicator is installed to the Playback devices field. This value must be consistent with the PBP_IP parameter in the TMC configuration file.
- Ingest (for DHM only)
  - Select the check box for the Ingest transfers enabled option to enable the option.
  - Enter the required value in the Max. simultaneous ingest transfers field.
  - Add the DNS name of the computer where the TM Communicator is installed to the Ingest devices field. This value must be consistent with the TM_INGEST_IP parameter from the TMC configuration file; that is, the DNS name must either match the parameter value, or resolve to the IP Address specified by the parameter value.
    
    If the DNS name is used as the Ingest Device Name, it must correctly resolve to the IP address of the TM Communicator Ingest Listener (the value of the TM_INGEST_IP parameter in the TMC configuration file) from the Transfer Manager server. If necessary, add a corresponding line to the $WINDOWS_HOME\system32\drivers\etc\hosts file.
- Dynamically Extensible Transfers (DET) (for DET only)
  - Enter the required values in the Max. DET push transfers field, and the Max. DET pull transfers field.
After all other required parameters are defined, enter a value in the Max. simultaneous transfers field under the Total Transfers (All Types) area on the screen.

Oracle recommends setting a value that does not exceed the sum of the values of Max. simultaneous ingest transfers, Max. simultaneous playback transfers, Max. DET push transfers, and Max. DET pull transfers.
Click Save to save the configuration.

The settings are saved in the TMServer.ini file in $WINDOWS_HOME folder.

Remove the line HoldForPermission =1 if it is present in the TMServer.ini file. This line is added in standalone configurations, and disables transfers to Unity storage.
Restart the Transfer Manager server.

DHM Specific Configuration

You must use the following procedure to copy the DHM and Playback Sender implementations to the Avid Transfer Manager to enable DHM transfers:

Copy the Oracle Receiver DLL from the $TMC_HOME/fpdireceiver folder, and the Oracle Sender DLL from the $TMC_HOME/fpdisender folder, to the $TMSERVER_HOME folder on the Avid Transfer Manager host.
Set the Sample Bit Depth value in the Avid Transfer Manager as follows:

Note:
: If clips with 24-bit audio are ingested, or sent to playback, you must set the Sample Bit Depth value in Avid NewsCutter, or Media Composer, to 24-bit.
1. Select Edit, and then Preferences from the menu.
2. Click the Settings tab.
3. Select Audio Project.
4. Set the Sample Bit Depth to 24-bit from the list. If you do not set the value correctly, the DHM Archive request may fail with the error Audio with inconsistent sample sizes.

DET Specific Configuration

You must copy the DET Vendor DLL implementation to the Avid Transfer Manager, and perform the following additional configuration steps as required to enable DET transfers:

Copy the Oracle Transceiver DLL and all other files from the $TMC_HOME/fpditransceiver folder to the $TMSERVER_HOME folder on the Avid Transfer Manager server.

Caution:
In the next step, if the det subfolder already exists in the $TMSERVER_HOME folder, Oracle recommends creating a backup copy of its contents. Overwriting any of the files in the det folder may disable other vendor DET implementations configured in the environment.

Copy the $TMC_HOME/det folder, including all subfolders, to the $TMSERVER_HOME folder on the Avid Transfer Manager server.

The following structure is created:

/det
   /mappings
      DivaPullMap.xml
      DivaPushMap.xml
   /settings
      DivaPull.xml
      DivaPush.xml
   /temp
      /xmlcookies
   /vendors
      Move.xml

You must change the settings file XML parameter values so that DivaPullMap.xml points to the $TMSERVER_HOME/det/settings/DivaPull.xml file, and DivaPushMap.xml points to the $TMSERVER_HOME/det/settings/DivaPush.xml file.
You must change the vendor file XML parameter values so that DivaPullMap.xml and DivaPushMap.xml both point to the $TMSERVER_HOME/det/vendors/Move.xml file.
Change the TMC XML parameter value in Move.xml to define the correct TM Communicator DET parameters using the format {IP}:{Port}.

IP

This parameter is the IP address of the TM Communicator DET Listener. This must be consistent with the value of the TM_DET_IP parameter from the TMC configuration file.

Port

This parameter is the port number for the TM Communicator DET Listener. This must match the value of the TM_DET_PORT parameter from the TMC configuration file.
Set the MaxPullSessions and MaxPushSessions XML parameter values in the Move.xml file to be consistent with the Max. Read Accesses and Max. Write Accesses parameters of the DIVArchive DET Source/Destination.
Confirm that the HKEY_LOCAL_MACHINE\SOFTWARE\Avid Technology\DETMove\MoveCookiePath Windows Registry key exists, and that it points to the folder specified by the value for the Directory for temporary composition files parameter (see Configuring Avid Transfer Manager).

If the registry key does not exist, or points to a different location, edit the key value in the tm_regkey.reg file and merge the file into the registry.

If the specified folder does not exist, you must manually create it because TM Communicator will not create new directories.

Oracle recommends setting this to the $TMSERVER_HOME/det/temp folder.