VideoFX Configuration Parameters - Evolphin Documentation

As part of installing the scripts needed by VideoFX for Zoom 7.2 or below, a configuration file needs to be set up for the installer, as described here. This file holds all parameters needed to be set up for the servers in a VideoFX setup.

These steps are only used for Zoom versions up to 7.2. These are not needed from Zoom 7.3 onwards.

Before updating this config.ini file, you need to make sure these are ready:

Your mounted paths and server environments are ready as described in this post.
New Zoom user accounts are ready to be used exclusively by each server in this setup (therefore, 3 accounts in all). These user accounts must be mapped to the superadmin role. Check this post for details about how to create a user.
File types, directory locations, and file sizes are decided on for use in high-res and direct ingest.
Vantage Server workflows are set up. Check here for details.
If you are setting up SSL on your servers, make sure to set up all servers as directed here. If you are using a commercial certificate, no other setup is needed. But, if you are using a self-signed SSL certificate, then copy this certificate to all your servers and the path to this certificate will be saved in this config.ini file.

If you are using Archive module, then you also need to create workflows in Zoom for Archive/Restore. Check here for information on creating these workflows.

While enabling SSL, Ingest Server is set up as a Preview Server, while the Vantage Server is set up as Zoom Client machine.

Remember, this configuration file hosts the whole lot of configurable parameters associated with the VideoFX setup. Some parameters will not apply to your setup. Any optional parameters will begin with “If you are using Archive Module with S3, then…..”. You may skip the optional parameters that are not needed.

Here is an overview of the steps we need to take with this config.ini file:

Update the config.ini file with values specific to your setup.
Copy this config.ini file along with the extracted scripts package over to all the three servers (Zoom MAM server, Ingest Server and Vantage Server).
Update a few server-specific parameters and run the installer script on each server.

Now, we are ready to update the configuration file!

Open config.ini file for editing on any one server machine. Now, we will set these values in the file:

Under the section [ZOOMSERVER], set these properties:
1. Set serverURL as your Zoom MAM Server’s URL including the port. For example, http://myZoomMAMServer:8880
2. Set webminURL as your Web Management Console’s URL including the port. For example, http://myZoomMAMServer:8443
3. Set serverUsername and serverPassword with the user credentials of the super admin account created for the current server.
Under the section [PREVIEWSERVER], set reviewServerURL as your Preview Server’s URL including the port.
For the Zoom MAM Server and the Ingest Server which are Linux boxes:
1. Under the section [ENVIRONMENT], set these properties:
  1. Set zmPath as the path to zm executable inside the bin directory in your Zoom Installation location. Usually, this path is /home/evolphin/zoom/bin/zm.
  2. Set zmInstallDir as the path where Zoom is installed. Usually, this is /home/evolphin/zoom.
  3. If you are using a self-signed SSL certificate, then set sslSeflSignCertPath as the path to your self-signed SSL certificate for the current server. For example, /home/evolphin/zoom/conf/trust.jks.
2. Under the section [MOUNTPREFIX], set these properties:
  1. Set TPMPrefix as the path to the root folder on a shared network location where the high-res assets will be saved after ingest. For example, /mnt/P-SAN.
  2. Set archivePrefix as the path to root folder for archive staging that is set up on a shared network location, where the assets are moved-to after archiving, before going to the permanent archive location. For example, /mnt/ES_SAN.
  3. Set zmInOutPrefix as the path to a folder that is used to share ingest related data between the client machines and script executors. For example, /Volumes/usan/.zoom-deploy/zoom-proxy-inout.
  4. Set workspaceRoot as the path to a shared network folder from where the high-res assets are checked-in from. For example, /Volumes/usan/hiresinput.
For the Vantage Server, which is a Windows box:
1. Under the section [WIN_ENVIRONMENT], set these properties:
  1. Set zmPath as the path to zm.exe inside bin directory in your Zoom Installation location. Usually, this path is C:\Program Files (x86)\Evolphin\DAM\bin\zm.
  2. If you are using a self-signed SSL certificate, then set sslSeflSignCertPath as the path to your self-signed SSL certificate for the current server. For example, C:\Program Files (x86)\Evolphin\DAM\conf\trust.jks.
2. Under the section [WIN_MOUNTPREFIX], set these properties:
  1. Set TPMPrefix as the path to the root folder on a shared network location where the high-res assets will be saved after ingest. For example, \\P-SAN.
  2. Set archivePrefix as the path to root folder for archive staging that is set up on a shared network location, where the assets are moved-to after archiving, before going to the permanent archive location. For example, \\ES_SAN.
If you are using high-res flow with Vantage, then under the section [VANTAGE - External], set these properties:
1. Set vantageServerURL as your Vantage Server’s URL including the port. If you wish to configure a Vantage Server per Brand Vault in Zoom, please contact Evolphin Support.
2. Set inPathPrefix as the path to the high-res files on the Ingest Server. This path is on the mounted network location. For example, /mnt/ES_SAN
3. Set outPathMount as the path to the high-res files on the Vantage Server. This path is on the mounted network location. For example, \\zoom.test.evolphin.com\ES_SAN
4. Set proxyOutDir as the path on the Vantage Server where proxies generated by the Vantage Server will be saved. This path is on the mounted network location. For example, Y:\zoom-deploy\vantage
5. Set workflowName as the Vantage Workflow to be used for proxy generation. The default workflow shipped with VideoFX is named HiRes Ingest.
6. Set pollDuration as the time duration in seconds after which the Ingest Server polls Vantage Server for status after submitting a transcoding request. The default value is 10.
7. Set sleepTime as the time duration in seconds for which the Ingest Server waits during polling. The default value is 2.
If you are using direct ingest flow with Vantage, then under the section [VANTAGE - Direct Ingested], set these properties:
1. Set vantageServerURL as your Vantage Server’s URL including the port. If you wish to configure a Vantage Server per Brand Vault in Zoom, please contact Evolphin Support.
2. Set inPathPrefix as the path to the direct ingested files on the Ingest Server. This path is on the mounted network location. For example, /mnt/ES_SAN
3. Set outPathMount as the path to the direct ingested files on the Vantage Server. This path is on the mounted network location. For example, \\zoom.test.evolphin.com\ES_SAN
4. Set proxyOutDir as the path on the Vantage Server where proxies generated by the Vantage Server will be saved. This path is on the mounted network location. For example, Y:\zoom-deploy\vantage
5. Set workflowName as the Vantage Workflow to be used for proxy generation. The default workflow shipped with VideoFX is named Direct Ingest.
6. Set pollDuration as the time duration in seconds after which the Ingest Server polls Vantage Server for status after submitting a transcoding request. The default value is 10.
7. Set sleepTime as the time duration in seconds for which the Ingest Server waits during polling. The default value is 2.
Under section [VANTAGECONFIG], set these properties (it is recommended to keep the default values unless you change the codecs used for encoding the proxies):
1. Set proResExt as the desired file format for pro-res files. Default mov
2. Set lowproxyExt as the desired file format for low-res files. Default mp4
3. Set thumbExt as the desired suffix and file format for the thumbnail file. Default _1.jpg
4. Set proResSuffix as the desired suffix to be attached to pro-res files. By default it is empty, so the generated pro-res mezzanine proxy will not have a suffix added to its filename.
The values in the section [METADATA] are the data-exchange metadata fields defined on the Zoom MAM Server as described here. Under this section, set the following properties:
1. Set mdGroupCodes as the list of all metadata group codes used in your Vantage workflow; one metadata group code on each line, starting with <<EOL and ending with EOL. For example,
  mdGroupCodes=<<EOL
  VDEO
  PRVP
  NVPR
  EOL
  
  Click here to know more about metadata group codes in your Vantage workflow.
2. Set proxy as the metadata field name (with group code) that indicates if this asset has a proxy; that means it is a high-res asset. For example, if the metadata field named Proxy under metadata group ZPIG is used to indicate proxy status then set proxy=ZPIG_Proxy.
3. Set hiResPath as the metadata field name (with group code) that stores the location of the high-res file. For example, ZPIG_NativeFilePath.
4. Set proResFilePathMDField as the metadata field name (with group code) that stores the location of the mid-res proxy file. For example, ZPIG_ProResFilePath.
5. If you are using Archive Module with VideoFX, then also set these properties, else skip this part:
  1. Set midresArchiveStatus as the metadata field name (with group code) that indicates if the mid-res proxy is archived or not. For example, ZPIG_MidResArchiveStatus.
  2. Set hiresArchiveStatus as the metadata field name (with group code) that indicates if the high-res asset is archived or not. For example, ZPIG_HighResArchiveStatus.
  3. Set directArchiveStatus as the metadata field name (with group code) that indicates if direct ingest asset is archived or not. For example, ZPIG_DirectArchiveStatus.
  4. Set lowresArchiveStatus as the metadata field name (with group code) that indicates if the low-res proxy is archived or not. For example, ZPIG_LowResArchiveStatus.
Under section [INGESTWORKFLOW], set these properties:
1. Set hiResFileNameSuffix as the suffix to be appended to high-res files after ingest. For example, _original.
2. Set nativefileTimeStampFormat as the timestamp format to be used with the ingested high-res files. For example, mmddyyyy-hh_mm_ss_mmm
3. Set defaultExtProxy as the default file extension to be used for proxy files. Default mp4.
4. Set placeHolderAsset as the path to the placeholder file as accessible from Zoom MAM Server. For example, /home/evolphin/zoom-deploy/PH.mov.
5. Set directIngestDirs as a list of either paths or patterns that resolve as paths (pattern in PCRE – Perl Compatible Regular Expression), one on each line and contained within <<EOL and EOL. These paths are on the Ingest Server. Each of these paths/directories will be monitored for direct ingest. For example, to monitor all directories matching Images, Vectors, Graphics, Music, or Exports for direct ingest on the Ingest Server, you could set this as
  directIngestDirs=<<EOL
  /.*/Images/ /.*/Vectors/ /.*/Graphics/ /.*/Music/
  /.*/Exports/
  EOL
6. For directIngestDirs, if you would like to include all directories for Direct Ingest except one (such as the hiresIngestDirs configured below), you could use a Perl Compatible Regular Expression like the below, where /zoom_video_ingest/ is the name of the high-res ingest directory
  directIngestDirs=<<EOL
  ^((?!/zoom_video_ingest/).)*$ EOL
7. Set directIngestFiles as a list of either file-types or patterns that resolve as file-types (pattern in PCRE – Perl Compatible Regular Expression), one on each line and contained within <<EOL and EOL. Each of these file-types will be considered for direct ingest. For example, to consider file-types, prproj, pdf, jpeg, jpg, mp3, psd, png, and tif for direct ingest, you could set this as
  directIngestFiles=<<EOL
  \.prproj$
  \.pdf$
  \.jpeg$
  \.jpg$
  \.mp3$
  \.psd$
  \.png$
  \.tif$
  EOL
8. Set hiresIngestDirs as a list of either paths or patterns that resolve as paths (pattern in PCRE – Perl Compatible Regular Expressions), one on each line and contained within <<EOL and EOL. These paths are on the Ingest Server. Each of these paths/directories will be considered for high-res ingest. For example, to monitor all directories matching zoom_video_ingest, After Effects Renders, Exports/For Review, Footage, and Media for high-res ingest on the Ingest Server, you could set this as
  hiresIngestDirs=<<EOL
  /.*/zoom_video_ingest/
  /.*/After Effects Renders/
  /.*/Exports/For Review/
  /.*/Footage/ /.*/Media/
  EOL
9. Set hiresIngestFiles as a list of file-types or patterns that resolve as file-types (pattern in PCRE – Perl Compatible Regular Expression), one on each line and contained within <<EOL and EOL. Each of these file-types will be considered for high-res ingest. For example, to consider file-types, mp4, mxf, mov, and mts for high-res ingest, you could set this as
  hiresIngestFiles=<<EOL
  \.mp4$
  \.mxf$
  \.mov$
  \.mts$
  EOL
10. Set fileSizeLimitOnDirectIngest as a flag to specify if a max file size limit should also be applied to direct ingest. If it is set to 1, the max file size limit is applied and if it is set to 0, the file size limit is not applied. See FILETYPESIZELIMIT section on how the max limit is enforced per file extension. This is used to avoid directly ingesting very large files in the Zoom MAM database.
11. The above settings should be used in conjunction with the ignore file patterns on Zoom Client machines to prevent from ingesting any file type/file patterns such as camera card manifest files.
If you are using Archive module, then under the section [JOBFORM], set the names of Archive and Restore jobs as defined above. If you are not using the Archive module, then skip this step. Set these properties as per the jobs created:
1. Set restoreHiresJobName as the restore job for high-res assets.
2. Set restoreProresJobName as the restore job for mid-res assets.
3. Set archiveHiresJobName as the archive job for high-res assets.
4. Set archiveProresJobName as the archive job for mid-res assets.
Under section [LEGACYINFO], set these properties:
1. Set doHiresMoveOnIngest as a flag to specify if high-res files should be moved to post ingest location after successful ingest. If it is set to 1, the high-res file is moved from the source path to that specified in the next property. If it is set to 0, the high-res file is not moved from the source path.
2. Set postIngestPath to the location of the path where the high-res files should be moved after successful ingest. This property is only needed if the above property is set to 1.
Under section [FILEFORMAT], set these properties:
1. Set nativeFileFormat as the suffix to be added to high-res files. For example, _original.
2. Set proresExt as the file format in which Vantage will generate the mid-res file. Default, mov.
3. Set proResSuffix as the suffix to be added to mid-res files. For example, _propres.
If you are using Archive Module with VideoFX, then also set these properties, else skip this part:
1. Under section [ARCHIVE STATUS], all properties are set to default values for captions used to show status of the archive. These may be updated:
  1. Set onArchiveFailure as the message to show that archive failed. For example, Archive failed.
  2. Set onRestoreFailure as the message to show that restore failed. For example, Restore failed.
  3. Set onArchiveStart as the message to show that archiving is starting. For example, Starting to archive.
  4. Set onRestoreStart as the message to show that restoring is starting. For example, Starting to restore.
  5. Set onArchiveFinish as the message to show that archiving is finished. For example, Copied to External System.
  6. Set onRestoreFinish as the message to show that restoring is finished. For example, Copied to External System.
  7. Set onPSANDelete as the message to show that the file is deleted from network share. For example, Archived.
  8. Set toSkipProRes as the message to show that mid-res asset was not generated. For example, Mid-res failed.
  9. Set inZoom as the message to show that the asset is now in Zoom repository. For example, Online.
2. Under section [ARCHIVE], set these properties:
  1. Set archiveModule as the archive module you would like to use. For AWS, set it is AWSS3. For SGL, set it as SGL.
  2. Set archiveOnIngest as a flag to specify if the high-res file should be archived after successful ingest. To archive from Vantage after ingest, set as 1. And, set as 0 for the asset to not archive from Vantage after ingest.
    This flag is important to decide the way archiving will work. When set to 1, the archiving will happen automatically right after ingest (for high-res and after creation for mid-res), so that archive auto tasks using Zoom’s internal archiving module are not triggered at all.
    When set to 0, archiving does not happen automatically after ingest. Rather, it is triggered manually by the user for specific assets. This flow uses the archive and restore auto tasks as defined here.
3. If you are using AWS for archiving, then under the section [AwsS3], set root_bucket_URL as the URL to be used as the root bucket in S3. For example, s3://deptRoot
4. If you are using AWS for archiving and your Vantage Server runs on Linux Server, then under the section [AwsS3], set parameters for AWS S3 in these properties:
  1. Set aws_cmd as per your AWS configuration.
  2. Set aws_config_file as per your AWS configuration.
  3. Set aws_archive_script as the name of the archive script created under the archive job as discussed above.
5. If you are using AWS for archiving and your Vantage Server runs on Windows Server, then under the section [WIN_AwsS3], set these properties:
  1. Set aws_cmd as per your AWS configuration.
  2. Set aws_config_file as per your AWS configuration.
  3. Set aws_archive_script as the name of the archive script created under the archive job as discussed above.
6. Under section [Bucket Map], set mapping between your project root folder and your root bucket URL. For example, set defproj to s3://deptRoot
Under the section [PATHTOMETADATAMAP], set levels starting from Level1 corresponding to metadata fields to be used as sub-directories while saving the high-res asset. For example, set this as:
Level1=CORP_Show
Level2=CORP_Season
Under the section [FILETYPESIZELIMIT], set size limits on different file types for direct ingest, as per your requirements. For example, set:
jpg = 500k
png = 1m
psd = unlimited
Save and close the config.ini file.
Go back to your script installer and follow the next steps here.