Signiant Support

12.0 Nexguard Integration User's Guide Print



Nexguard Integration

The NexGuard component enables a Signiant workflow to submit files to a NexGuard system for watermarking. The component then monitors the watermark operation, reporting the results. The Signiant agent on which the NexGuard component is executed does not have to be installed on the NexGuard system, but must be able to communicate with it.

The NexGuard sample workflow allows users to employ Signiant media transfer technology with NexGuard to transfer media files from a Signiant agent to the NexGuard Manager, where the files are watermarked, then transferred to another user-specified Signiant Agent.

Nexguard Configuration

In order to integrate with the Signiant-NexGuard integration system, ensure that NexGuard is installed, licensed, and in working order for integration with Signiant.

A typical NexGuard setup includes the following:

  • NexGuard Manager (note this must be a Windows XP machine, running the NexGuard software)
  • NexGuard Embedder
  • NexGuard File Reader

Create network shared input and output directories on the NexGuard Manager. These are the directories to and from which the files will be transferred. They must be shares because UNC paths are required for NexGuard.

Nexguard Components

The following graphic illustrates the sample NexGuard Workflow components:

nexGuard_workflow.jpg

The NexGuardDropBox component specifies the parameters relating to scheduling the workflow, such as when and how the job should run. The SigniantAggregate, NexGuard and SigniantDistribute components are grouped together as part of the execution sequence that transfers files from one or more Signiant agents to the NexGuard Manager, then transfers the watermarked files to one or more Signiant Agents.

The DropBoxJobReport component specifies information relating to a job report about the NexGuard job, including recipients, email subject line, number of report versions to maintain, and so on. An exception hierarchy allows you to specify conditions under which the report is sent (for example, if one of the components fails, the report may go to a different recipient than if the entire job succeeds).

The NexGuard component specifies information, such as the agent, server, port, files and target directory for the transfer, required for the NexGuard Watermark Manager to perform the transcode.

The following describe the input and output properties of the NexGuard component:

Inputs

  • Target Agent

    The Signiant agent on which the component is to be executed.

  • Source Data

    List of specific files to be transcoded.

  • Server

    Server

  • Source Directory

    Specifies the directory where the transferred media files are located to be transferred.

  • Target Directory

    Specifies the directory to which the resulting watermarked files will be copied. This directory must be specified.

  • Operator

    Name of the current operator. This metadata is applied to every file the job watermarks.

  • Name

    The Work Order that identifies the job. This metadata is applied to every file the job watermarks.

  • Description

    A description of the job. This metadata is applied to every file the job watermarks.

  • Location

    Location

  • Stream Processing

    Applies to Windows Media files. The values are the following:

    • 0 - All
    • 1 -  First Video Stream

    This metadata is applied to every file the job watermarks.

  • Priority

    This metadata is applied to every file the job watermarks.

  • Copies

    Number of copies of the source file. This metadata is applied to every file the job watermarks.

  • Customer

    The name of the customer, which will be checked into the manager database. This metadata is applied to every file the job watermarks.

  • Recipient

    The name of the customer receiving the files. This name is checked into the Manager database, and applied to every file the job watermarks.

  • Post Processing

    Actions to be applied to file after processing. The values are the following:

    • 0 - Delete after process
    • 1 - Move after process
    • 2 - Do nothing after process

    This metadata is applied to every file the job watermarks.

  • Watermark List Failure Option

    Returns the list of files watermarked even if there is a failure.

  • No File Failure Option

    If set, will not return an error if there are no files to watermark.

  • Timeout

    Timeout

Outputs

  • Summary Stats

    Summary of statistics from the transfer in an internal format. Not used by any other component.

  • Detail Stats

    Detailed statistics from the transfer in an internal format. Not used by any other component.

  • Transferred File List

    The list of files which were successfully transcoded.

  • Output File List

    The list of files which were successfully watermarked.

  • Return Message

    A short message indicating the overall result of the component.

NexGuard Prompts

The NexGuard sample workflow included with Signiant enables users to transfer media files from a Signiant agent to a NexGuard Manager, watermark the files, and have the watermarked files sent to another Signiant Agent. This workflow is located in the NexGuard _Workflows job template library.

The following table describes the prompts associated when creating a NexGuard job. Mandatory prompts are indicated with an asterisk.

Prompt Description
Job Name

A unique name for this job. This must start with a letter and can only contain underscores to separate words. This name should help operators to recognize the functions of this job (e.g., Send_Media_to_Site2).

Source
Source Agent/Drop Box Agent

The agent(s) from which you are transferring the data.

Source Directory

Folder from which to transfer files. Type the folder in the prompt, or click the computer icon to browse and select an agent folder. The Source folder specified may be in the following format:

  • Windows root drives, e.g., C:\ApplicationData
  • Unix root drives, e.g., /home
  • Windows UNC names, e.g., \\machine1\applicationdata

If these exact paths are not visible to the Agility Server, use the UNC Path Mapping input. Make sure that the usual permissions and sharing set up exist with UNC paths.

Source File Filter
Source Include File Names Types

Allows users to specify which files are transferred by filtering on the names to include. Use a comma to separate multiple filters. By default, an asterisk appears in the prompt, to include all file names/types. For example, if you type *.doc, *.ppt, in the prompt, the transfer wills include files with these extensions.

Source Exclude File Names Types

Allows users to specify which files are excluded from transfer. Use a comma to separate multiple filters. If the source directory for this jobs is also being used as the target directory for another job, you should add #work_file#* and #chkpt_file#*.

Source Exclude Subdirectories

To exclude sub-folders, choose from the following options:

  • None (all sub-folders will be transferred - none will be excluded)
  • All (no sub-folders will be transferred - all of them will be excluded)
  • Specified (a list of sub-folders to exclude - type sub-folders in the Subdirectories to Exclude prompt, described below)
Source Subdirectories to Exclude

Sub-folders may be excluded by specifying them in this prompt. Multiple entries must be separated with a comma. When the job runs, all folders that match those specified in the Subdirectories to exclude prompt will be excluded. Note that normal behavior is to exclude sub-folders that match regardless of where they appear in the folder path. Using the anchoring expression (@) changes this behavior to anchor the exclude folder path.

For example, if you specify a source folder of C:\data\docs, and an exclude folder of temp, any sub-folders called temp will be excluded, even those nested within another sub-folder. (For example the sub-folder C:\data\docs\publish\release\temp would be excluded as well.)

If you who want to exclude a folder only at a certain level can use the @ symbol to anchor the exclude folder path at the starting source folder level. For example, specifying @temp in the above example would mean that the C:\data\docs\temp folder would be excluded, but the C:\data\docs\publish\release\temp folder would be included.

If you instead wanted to make sure just the C:\data\docs\publish\release\temp folder was excluded, but wanted to have a source folder path of c:\data\docs, the user would need to type C:\data\docs in the source folder prompt and @publish\release\temp in the exclude prompt. Special characters allow you to make use of pattern matching on the folder path. You must escape special characters with a backslash to be matched literally. Characters include the following:

  • * (matches zero or more characters)
  • ? (matches any single character)
  • [...] (matches any one of the enclosed characters - for example, [ch] would match the characters "c" or "h")
  • A pair of digit, lowercase or uppercase characters separated by a hyphen '-' denotes a range set and matches any character sorted in the range. If the first character following the '[' is '^' or '!', then any character not enclosed is matched.
  • Use commas to specify multiple distinct patterns.
Source File Readiness and Delivery Options
Source File Readiness Check Type

Specify the kind of check type an agent uses to determine if a file is ready to be transferred (i.e., the file is not in use). For some configurations, you may or may not wish to select the file readiness check option:

  1. For Windows agents and local Windows file systems, there is no need to use the file readiness check, as the core file in use behavior is sufficient.
  2. For Windows agent and NAS Windows file system, as long as the NAS file system properly supports file locking for in-use files, the readiness check is unnecessary. However, it is still available in case the NAS file system does not properly support file locking.
  3. For non-Windows agents of any kind (Linux, UNIX, MacOS). If the local or network file system supports file locking, the readiness check is not required. Determine this on a case-by-case basis.

Choose one of the following:

  • None - Files that are in use are skipped by default.
  • Consecutive Seek (recommended) - Reads the last few bytes at the end of the file, waits for delay period number of seconds and checks again. If the last few bytes match in both cases the file is sent. Very useful on large files where the MD5 option would simply take too long. 
  • MD5 Hash - Use an MD5 hash to compute a hash on all files under the drop-box folder. After the wait time specified in the Readiness Check Delay prompt, the hashes are recomputed. Only files with identical hashes are transferred. Note that job initialization may take a great deal of time if large files are present.
  • Date/Time & Size - Use a difference in date/time or size on the file to compare its readiness. Only files that have identical date/time & size are transferred.
Source Readiness Check Delay

The amount of time (in seconds) to pause between the two phases of the specified file readiness check type ("MD5 Hash", "Consecutive Seek", or "Date/Time & Size") for an open file. The file is transferred only if the results of the two checks are identical. The default value is 10 seconds. If a large number of files are being checked, a value of 0 seconds may be sufficient, since there will likely be sufficient time between the first and second checks of a given file to determine if its content has changed without inserting an additional delay.

Source Delivery Mode

Specifies the mode to transfer files:

  • Fast - Do not create temporary work files. This mode is optimized for speed.
  • Normal - Use temporary work files during transfer. Temporary files allow an interrupted transfer to resume from where the interruption occurred. The creation of temporary files adds time to the transfer, but provides resiliency.
  • Log File Name - Log file names transferred. Logs are stored on the Manager.
  • Certify File Delivery - Create agent certified delivery log of files transferred.
Source "Source" Deletions After Successful Transfer

Specifies removal of files or folders from the dropbox folder after a successful transfer. Choose from one of the following:

  • None (do not delete any source files or empty folders)
  • Transferred Files (remove the files)
  • Empty folders (remove folders that are left over after the source files have been removed)
  • Transferred Files and Empty Directories (remove both transferred files and empty folders)
  • Transferred Files and Directories ( remove both transferred files and all folders immediately after transfer)

There are certain requirements with the empty folders options: the folders must contain no files (they may contain other empty folders that will be removed as well). The folder cannot have been modified within the previous 5 minutes; if it has, it will not be removed.

Source "Source" Directories to Exclude from Deletion Scan

Allows you to specify a comma-separated list of directories that you do not want to delete.

NexGuard
*NexGuard Agent

Defines the Signiant agent associated with the NexGuard server. The agent will receive the files to be watermarked.

Note that it is possible to specify a remote agent as the NexGuard agent. The specified remote agent must be a Windows agent, and the default user for that agent must be someone other than NTAuthority\System. The NexGuard manager requires UNC paths for its input/output directories, and the NT Authority\System cannot access UNC paths.

Server

Specifies the server where the NexGuard manager is running. This may be different from the agent specified in the NexGuard Agent field.

*Input Directory

The NexGuard agent uses this directory for delivering the input files to a location accessible to the NexGuard server. This directory must be specified as a UNC path.

*Output Directory

Specifies the directory to which the resulting watermarked files will be copied. This directory must be specified as a UNC path. Note that all files in the output directory are moved to the destination directory as part of job post-processing.

Operator

Name of the current operator. This metadata is applied to every file the job watermarks.

Name

The Work Order that identifies the job. This metadata is applied to every file the job watermarks.

Description

A description of the job. This metadata is applied to every file the job watermarks.

*Location

This metadata is applied to every file the job watermarks.

Stream Processing

Applies to Windows Media files. The values are the following:

  • 0 - All
  • 1 - First Video Stream

This metadata is applied to every file the job watermarks.

Priority

This metadata is applied to every file the job watermarks.

*Copies

Number of copies of the source file. This metadata is applied to every file the job watermarks.

Customer

The name of the customer. This metadata is applied to every file the job watermarks.

Recipient

The name of the customer receiving the files. This metadata is applied to every file the job watermarks.

Destination
Destination Agent

The agent to which you want to transfer the files.

Destination Directory 

Folder to which to transfer files. Type the folder in the prompt, or click the computer icon to browse and select an agent. Source folder specified may be in the following format:

  • Windows root drives, e.g., C:\ApplicationData
  • Unix root drives, e.g., /home
  • Windows UNC names, e.g., \\machine1\applicationdata folder.

Make sure that the usual permissions and sharing set up exist with UNC paths. Note that the source of these files is specified on the Anystream Agility Encoding Platform. For more information, see the note at the start of this procedure.

Destination File Filter
Destination Include File Names Types

Allows users to specify which files are transferred by filtering on the names to include. Use a comma to separate multiple filters. By default, an asterisk appears in the prompt, to include all file names/types. For example, if you type *.doc, *.ppt, in the prompt, the transfer wills include files with these extensions.

Destination Exclude File Names Types

Source Exclude File Names Types

Destination Exclude Subdirectories

To exclude sub-folders, choose from the following options:

  • None (all sub-folders will be transferred - none will be excluded)
  • All (no sub-folders will be transferred - all of them will be excluded)
  • Specified (a list of sub-folders to exclude - type sub-folders in the Subdirectories to Exclude prompt, described below)
Destination Subdirectories to Exclude

Sub-folders may be excluded by specifying them in this prompt. Multiple entries must be separated with a comma. When the job runs, all folders that match those specified in the Subdirectories to exclude prompt will be excluded. Note that normal behavior is to exclude sub-folders that match regardless of where they appear in the folder path. Using the anchoring expression (@) changes this behavior to anchor the exclude folder path.

For example, if you specify a source folder of C:\data\docs, and an exclude folder of temp, any sub-folders called temp will be excluded, even those nested within another sub-folder. (For example the sub-folder C:\data\docs\publish\release\temp would be excluded as well.)

If you who want to exclude a folder only at a certain level can use the @ symbol to anchor the exclude folder path at the starting source folder level. For example, specifying @temp in the above example would mean that the C:\data\docs\temp folder would be excluded, but the C:\data\docs\publish\release\temp folder would be included.

If you instead wanted to make sure just the C:\data\docs\publish\release\temp folder was excluded, but wanted to have a source folder path of c:\data\docs, the user would need to type C:\data\docs in the source folder prompt and @publish\release\temp in the exclude prompt. Special characters allow you to make use of pattern matching on the folder path. You must escape special characters with a backslash to be matched literally. Characters include the following:

  • * (matches zero or more characters)
  • ? (matches any single character)
  • [...] (matches any one of the enclosed characters - for example, [ch] would match the characters "c" or "h")
  • A pair of digit, lowercase or uppercase characters separated by a hyphen '-' denotes a range set and matches any character sorted in the range. If the first character following the '[' is '^' or '!', then any character not enclosed is matched.
  • Use commas to specify multiple distinct patterns.
Destination File Readiness and Delivery Options
Destination File Readiness Check Type

Specify the kind of check type an agent uses to determine if a file is ready to be transferred (i.e., the file is not in use). For some configurations, you may or may not wish to select the file readiness check option:

  1. For Windows agents and local Windows file systems, there is no need to use the file readiness check, as the core file in use· behavior is sufficient.
  2. For Windows agent and NAS Windows file system, as long as the NAS file system properly supports file locking for in-use files, the readiness check is unnecessary. However, it is still available in case the NAS file system does not properly support file locking.
  3. For non-Windows agents of any kind (Linux, UNIX, MacOS). If the local or network file system supports file locking, the readiness check is not required. Determine this on a case-by-case basis.

Choose one of the following:

  • None - Files that are in use are skipped by default.
  • Consecutive Seek (recommended) - Reads the last few bytes at the end of the file, waits for delay period number of seconds and checks again. If the last few bytes match in both cases the file is sent. Very useful on large files where the MD5 option would simply take too long. 
  • MD5 Hash - Use an MD5 hash to compute a hash on all files under the drop-box folder. After the wait time specified in the Readiness Check Delay prompt, the hashes are recomputed. Only files with identical hashes are transferred. Note that job initialization may take a great deal of time if large files are present.
  • Date/Time & Size - Use a difference in date/time or size on the file to compare its readiness. Only files that have identical date/time & size are transferred.
Destination Readiness Check Delay (seconds)

The amount of time (in seconds) to pause between the two phases of the specified file readiness check type ("MD5 Hash", "Consecutive Seek", or "Date/Time & Size") for an open file. The file is transferred only if the results of the two checks are identical. The default value is 10 seconds. If a large number of files are being checked, a value of 0 seconds may be sufficient, since there will likely be sufficient time between the first and second checks of a given file to determine if its content has changed without inserting an additional delay.

Destination Delivery Mode

Specifies the mode to transfer files:

  • Fast - Do not create temporary work files. This mode is optimized for speed.
  • Normal - Use temporary work files during transfer. Temporary files allow an interrupted transfer to resume from where the interruption occurred. The creation of temporary files adds time to the transfer, but provides resiliency.
  • Log File Name - Log file names transferred. Logs are stored on the Manager.
  • Certify File Delivery - Create agent certified delivery log of files transferred.
Destination Source Deletions After Successful Transfer

Specifies removal of files or folders from the dropbox folder after a successful transfer. Choose from one of the following:

  • None (do not delete any source files or empty folders)
  • Transferred Files (remove the files)
  • Empty folders (remove folders that are left over after the source files have been removed)
  • Transferred Files and Empty Directories (remove both transferred files and empty folders)
  • Transferred Files and Directories ( remove both transferred files and all folders immediately after transfer)

There are certain requirements with the empty folders options: the folders must contain no files (they may contain other empty folders that will be removed as well). The folder cannot have been modified within the previous 5 minutes; if it has, it will not be removed.

Destination Source Directories to Exclude from Deletion Scan

Allows you to specify a comma-separated list of directories that you do not want to delete.

Job Schedule
Start Date/Time

The date and time at which you want the job to run.

Note that editing the start date/time of a job that is currently in a queued state within a queued job group will have no effect on the job until the next time the job is run.

Frequency

Specifies how often the job runs. Users can choose from the following options:

  • None - Use for jobs that run only at irregular, user-defined times.
  • Hourly, Daily, Weekly, Monthly, Yearly - Run the job once every selected interval.
  • Monthend - Run the job once every last day of the month.
  • Once - Run the job only once, when first created.

Note that editing the frequency of a job that is currently in a queued state within a queued job group will have no effect on the job until the next time the job is run.

Time Zone

Specifies the time zone in which the displayed times are set. For example, if an Eastern Time zone specifies a start time of 9:00 am and a time zone of PST, the job runs at 9:00 am Pacific Standard Time or noon Eastern Standard Time.

Job Options
Log Detail Level

The type of logging information for this job. Choose from Error, Warn (warning), Info (Information) or Debug. Debug provides the greatest level of detail while Error provides the least.

Notification
Email Job Report

Specifies when a job report is emailed to users specified in the Email Job Report To prompt. Choose from the following:

  • Always - Users receive a job report after every job run.
  • On Error - Users receive a job report after a job run that reports an error exit code.
  • Never - Users never receive job reports.
Email Job report To

The email address of the person who you want to receive the logging report. Separate multiple addresses with a comma.

Email Subject

Text that appears in the subject prompt of the report email message.

Job Report Versions to Maintain Online

The number of job report versions. These reports are stored on <manager_install_directory>\log\job_reports\NexGuardDropBox_job_name\<reportname>.html.

The minimum number of versions maintained is 0 (meaning none), the maximum is 1000. When the specified number of versions to store is reached, the oldest version is deleted and the newest version is added.