Differences

This shows you the differences between two versions of the page.

--- cli:tmss10sync [2017/06/17 20:03] – created Gerard Nicol
+++ cli:tmss10sync [2025/01/21 22:07] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== 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 adhoc and automated synchronization
+''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.
+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 program relies on three separate software engines that are built one on top of the other.
-the processing directives, resolving variables and including any embedded
-Definition File sections.
+   - **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
+   - **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.
-connection, extracting data into respective fields and performing any data
+   - **Sync Engine** This component responsible for updating the TapeTrack Server with any fields which have been specified to be updated.
-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 logonstring argument sets the Server logon information in the format
-user:password@server:port.
+  * ''-S'' The Logon String argument sets the [[cli:server_argument|Server Logon Information]].
-In the event that this argument is not passed the default will be batch:batch@localhost:5000.
+   * ''-c'' The config file argument specifies the path to the Batch Configuration File.
-By default the password value will be treated as the path to a file which contains a single record
+   * ''-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.
-representing the password, rather than the password itself.
+   * ''-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.
-If you wish the password value to be the literal password (rather than a file) the password should be
+   * ''-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''.
-prepended with a dash (fred:-fredspassword@server).
+   * ''-T'' Sets the Do Not Slot [[common:volume_flags|Flag]] for each updated Volume.
-You can also have the program read the password as the first record of stdin by prepending the
+   * ''-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.
-password with a plus symbol (fred:+@server).
+   * ''-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.
-In the event that the password is all upper case and 32 characters in length, the password will be
+   * ''-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.
-considered an MD5 hash of the password and passed to the server without subsequent MD5 hashing.
+   * ''-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.
--c The configfile argument specifies the path to the Batch Configuration File.
+   * ''-s'' Automatically sets the ''SLOT'' field to the relative record number of the record being processed.
-The Batch Configuration File allows you to perform advanced traversal of Customer, Media and
+   * ''-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.
-Volumes, perform advanced barcode pre and post processing and route program output to syslogd.
-Configuration File capabilities vary from program to program but the syntax remains the same. In
+<note tip>
-the event that logic is not supported it will simply be ignored.
-TMSS10Sync
-The following example will set the default Customer-ID and Media-ID for all scanned barcodes:
-barcodes =
-{
-defaults={ customer-id="ACME"; media-id="LTO"; };
-};
--A This argument sets the attribute index for any field imported as the DESCRIPTION field. The value
-of attributeindex should be an integer between 0 and 200. The default of 200 represents the
-inbuilt Description field. Values of 1 through 200 represent user-defined Extended Attribute values.
--F This argument 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 preformed.
--M This argument instructs 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.
-Special Note
 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.
--T This argument instructs the program to set the Do Not Slot flag for each updated Volume.
--a This argument instructs the program to add any new Volumes to the TapeTrack database. In the event
+To run data through all three engines without performing updates, TMSS10Sync can be run in test mode (attribute -t).
-that this argument is not specified and newly encountered Volumes will be skipped and added to
+</note>
-the Not-Added Count.
--d This argument 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. This argument is
-required and defaults to the file default.ttidef.
--l This argument instructs the program to list 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 This argument instructs to Sync Engine to pass the value in the 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 This argument instructs the program to automatically set the SLOT field to the relative record number
-of the record being processed.
--t This argument 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.
 ===== Exit Status =====
-zero Program has ended successfully.
+  * **zero** Program has ended successfully.
-TMSS10Sync
+  * **non-zero** Program has not ended successfully.
-non-zero Program has not ended successfully.
 ===== Environment =====
-TMSSSERVERPROXY If defined the program will route all TapeTrack TCP/IP traffic through
-a HTTPS proxy. The value of the variable should be in the format
-user:password@host:port. To debug the proxy connection use variable
-TMSSAPILOGDIR.
-TMSSAPILOGDIR If defined the program will write out a trace file to this directory.
-TMSSPWPATH When no password value is passed in the logon string the program will look for
-the password in file \etc\tapetrack\user, where user is the user value
-passed in the logonstring. If you wish to change this default path, you can
-set the path in TMSSPWPATH.
-TMSSNOMD5 If defined the program will not MD5 hash passwords before sending them to the
-TapeTrack Server. This is required when relying on Windows Active Directory
-authentication. It should be noted that although the password is not being hashed,
-it is still being encrypted during transmission.
 ===== Files =====
-stdout Formatted output, Record Dump output or Scan File Output.
+  * ''stdout'' Formatted output, Record Dump output or Scan-File Output.
-stderr Diagnostic messages.
+  * ''stderr'' Diagnostic messages.
-stdin Sync input file.
+  * ''stdin'' Sync input file.
 ===== Examples =====
-Example 1. TMSS10Sync: List supported Processing Directives.
+List supported Processing Directives.
-[gnicol@z1090 ~]$ TMSS10Sync -l < syntax.txt
+<code plain;>
-Example 2. TMSS10Sync: Run program in Dump Mode.
+[jsmith@z1090 ~]$ TMSS10Sync -l < syntax.txt
-[gnicol@z1090 ~]$ TMSS10Sync -M < input.txt
+</code>
-Example 3. TMSS10Sync: Produce a formatted listing with a ruler every 10 records.
+Run program in Dump Mode.
-[gnicol@z1090 ~]$ TMSS10Sync -F 10 < input.txt > output.txt
+<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]
+<--