====== TMSS10Sync ======
Synchronize an input file or ODBC connection data with a TapeTrack Framework Server.

<note tip>For further details including requirements, implementation and integration see the  [[:sync|TapeTrack Sync Guide]]</note>
===== Synopsis =====
''TMSS10Sync [-A attributeindex] [-F recordcount] [-M] [-S logonstring] [-T] [-a] [-c
configfile] [-d deffile] [-l] [-p] [-s] [-t]''
===== Description =====
''TMSS10Sync'' is a command-line utility that allows the user to run ad-hoc and automated synchronization
between text files, CSV files and ODBC connections to update commonly used TapeTrack database fields.

In addition to being able to synchronize data, the program can also perform complex date calculation and
String manipulation procedures to edit the data that is being synchronized.

The program relies on three separate software engines that are built one on top of the other.  

   - **INI Parse Engine** This component is responsible for reading the Definition File, parsing the processing directives, resolving variables, and including any embedded Definition File sections.
   - **Import Engine** This component is responsible for reading data from the import file or ODBC connection, extracting data into respective fields, and performing any data manipulation.
   - **Sync Engine** This component responsible for updating the TapeTrack Server with any fields which have been specified to be updated.
===== Options =====

The options which apply to the TMSS10Sync command are:  

  * ''-S'' The Logon String argument sets the [[cli:server_argument|Server Logon Information]].
   * ''-c'' The config file argument specifies the path to the Batch Configuration File.
   * ''-A'' Sets the Attribute index for any field imported as the ''DESCRIPTION'' field. The value of the Attribute index should be an Integer between 0 and 200. The default of 0 represents the inbuilt Description field. Values of 1 through 200 represent user-defined Extended Attribute values.
   * ''-F'' Instructs the program to simply read in the contents of ''stdin'' and write out a formatted report on ''stdout'' with a ruler every recordcount records. This can be helpful for establishing the offset and length of the fields that are being synchronized from a text file. No other processing will be performed.
   * ''-M'' Executes the program to run in Dump Mode. Dump mode processes the input synchronization as it would in the regular update mode but instead of performing any updates the program will write a list of proposed update fields for each record to the ''stdin''. 
   * ''-T'' Sets the Do Not Slot [[common:volume_flags|Flag]] for each updated Volume.
   * ''-a'' Adds any new Volumes to the TapeTrack database. In the event that this argument is not specified and newly encountered Volumes will be skipped and added to the Not-Added Count.
   * ''-d'' Sets the path to the Import Definition File. The Import Definition file is responsible for instructing the program on how to interpret the input file or ODBC connection. If not specified it defaults to the file default.ttidef in the current working directory.
   * ''-l'' Lists all of the supported processing directives, which will be written to ''stdout''. A list of valid ODBC Drivers and DSNs will also be listed. No further processing is performed.
   * ''-p'' Instructs to Sync Engine to pass the value in the VOLUME field to TapeTrack's Barcode Parsing Engine, where it will be split into the ''CUSTOMER'', ''MEDIA'' and ''VOLUME'' fields. Barcode Parsing can also be further managed using the Barcode section of the Configuration File.
   * ''-s'' Automatically sets the ''SLOT'' field to the relative record number of the record being processed.
   * ''-t'' Instructs the program to run in Test Mode. In Test Mode, all three engines will be invoked, but no updates will be performed. Test Mode differs from Dump Mode in that Dump Mode will not run the Sync Engine while Test Mode will, but without performing updates.

<note tip>
When running in Dump Mode the program will only run the INI Parse Engine and the Import
Engine. It will not run the Sync Engine. As a result, any functionality that relies on the Sync
Engine, such as the Barcode Parse Option will not be invoked. Further, functions that relate
to data interpretation such as date parsing will also not be run.

To run data through all three engines without performing updates, TMSS10Sync can be run in test mode (attribute -t). 
</note>
===== Exit Status =====

  * **zero** Program has ended successfully.
  * **non-zero** Program has not ended successfully.
===== Environment =====


===== Files =====

  * ''stdout'' Formatted output, Record Dump output or Scan-File Output.
  * ''stderr'' Diagnostic messages.
  * ''stdin'' Sync input file.

===== Examples =====

List supported Processing Directives.
<code plain;>
[jsmith@z1090 ~]$ TMSS10Sync -l < syntax.txt
</code>
Run program in Dump Mode.
<code plain;>
[jsmith@z1090 ~]$ TMSS10Sync -M < input.txt
</code>
Produce a formatted listing with a ruler every 10 records.
<code plain;>
[jsmith@z1090 ~]$ TMSS10Sync -F 10 < input.txt > output.txt
</code>

--> Changelog

[filterrss http://www.tapetrack.com/cgi/changelog.cgi?module=TMSS10Sync]
<--