Differences

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

--- lite:config_file [2017/11/02 23:25] – Scott Cunliffe
+++ lite:config_file [2025/01/21 22:07] (current) – external edit 127.0.0.1
@@ Line 1: / Line 1: @@
 ====== Lite Configuration File ======
-The TMSSLite.cfg file allows TapeTrack administrators to customize the end-user experience for Lite users. You can insert, remove, and change the names  of the tasks in the Library Management Tasks menu, limit functions to a repository, and manage how log files are created and archived.
+The TMSSLite.cfg file allows TapeTrack administrators to customize the end-user experience for Lite users. You can insert, remove, and change the names  of the tasks in the **Tape Management Task Menu**, limit functions of a [[object:repository|Repository]], and manage how log files are created and archived.
-{{:lite:lite_config.png}}
+Any modifications made in the config file have only local effects not global.  If you have multiple installations of Lite any modifictions will need to be done on each computer.
+<code>
+//
+// Sample TapeTrack Lite Configuration File
+//
+options=
+{
+   menu=
+   (
+      {
+          filter="*Guide*";
+          hidden=true;
+      },
+      {
+          filter="*Users*";
+          hidden=true;
+      },
+      {
+          filter="*Upload*";
+          hidden=true;
+      },
+      {
+          filter="*Outlook*";
+          hidden=true;
+          // text="Alternate iCalendar text";
+      },
+      {
+          hidden=true;
+          text="Custom Command 1";
+          //sequence=100;
+          command="echo hello > out.txt";
+          filters=( "*this string will be excluded*", "*So will this string*" );
+      }
+   );
+   // file truncated for display purposes
+</code>
+===== Locating The Lite Config File =====
+The default installation location of TapeTrack Lite is at C:\Program Files\TapeTrack\TapeTrack Lite. This location can be modified at installation to suit your requirements if required.
+The Lite config file (TMSSLite.cfg) is located in the TapeTrack directory at \TapeTrack\TapeTrack Lite\TMSSLite.cfg
+<note important>Before modifying the file TMSSLite.cfg make a backup copy in case of any errors</note>
+Open the file in a plain text editor, such as Notepad.
 ===== Customizing the Library Management Tasks Menu =====
-The "menu =" command in the TMSSLite.cfg file can be used to customize the Library Management Tasks menu. Tasks can be added, hidden, reordered, and renamed to address the specific needs of an organization or individual.
+The ''menu ='' command in the TMSSLite.cfg file can be used to customize the Tape Management Task Menu.
+Tasks can be added, hidden, reordered, and renamed to address the specific needs of an organization or individual.
+<note tip>Modification of the configuration files alters settings for the local installation of TapeTrack Desktop software.
+Being a local modification, means it only affects the local installation so will need to be executed on all local machines you want to alter the display on.</note>
-{{:lite:lite_config_menu.png}}
+{{lite_config_menu.png}}
-There are several commands that can be used under the **menu** command:
+There are several commands that can be used under the ''menu'' command:
-  * **<nowiki>//</nowiki>** - a double forward slash indicates a comment. Because of this, anything following a double slash will not be included in the script and will not modify TapeTrack Lite.
+  * **<nowiki>//</nowiki>** - a double forward slash indicates a comment. Because of this, anything following a double slash will not be included in the script and will not modify [[desktop:lite|Lite]].
-  * **filter** - filter is used to isolate the pre-existing command that you would like to alter. TapeTrack Filters can be used in this section. For example, the above script uses " filter="*Outlook*"; " to isolate any variable in the Library Management Tasks Menu that has the word "Outlook" in it. Due to the fact that "Outlook Integration" is the only Library Management Task item that has "Outlook" in it, it is the only menu item that will be isolated and changed.
+  * **filter** - filter is used to isolate the pre-existing command that you would like to alter. TapeTrack Filters can be used in this section. For example, the above script uses " filter="*Outlook*"; " to isolate any variable in the Tape Management Task Menu that has the String "Outlook" in it. Due to the fact that "Outlook Integration" is the only Tape Management Task Menu item that has "Outlook" in it, it is the only menu item that will be isolated and changed.
-  * **hidden** - hidden can either be true or false and will dictate whether or not a Library Management Task appears in the menu.
+  * **hidden** - hidden can either be true or false and will dictate whether or not a Tape Management Task Menu appears in the menu.
-  * **text** - text indicates what will be displayed in the Library Management Tasks menu in TapeTrack Lite.
+  * **text** - text indicates what will be displayed in the Tape Management Task Menu in TapeTrack Lite.
-  * **sequence** - sequence indicates where in the Library Management Tasks menu the task will appear. The native sequence numbers are in tens. For example:
+  * **sequence** - sequence indicates where in the Tape Management Task Menu the task be displayed. The native sequence numbers are in tens. For example:
+===Default Menu View===
 {{lite:lite_config_default.png}}
-In this example, Scan-In would be the first option. It thus has a sequence number of 10. Likewise, List is the sixth option and thus has a sequence number of 60. To put a custom command between Recall and Manage, you could use the number "45" in the TMSSLite.cfg file to indicate that it is between the 4th and 5th option.
+In this example, [[lite:function_scanning_in|Scan-In]] would be the first option. It thus has a sequence number of 10. Likewise, List is the sixth option and thus has a sequence number of 60. To put a custom command between [[lite:function_recall|Recall]] and Manage, you could use the number "45" in the TMSSLite.cfg file to indicate that it is between the 4th and 5th option.
-  * **command** - command can be used to add a command line function to the Library Management Tasks menu. The most popular of these is TMSS10Ping.
+  * **command** - command can be used to add a command line function to the Tape Management Task Menu. The most popular of these is [[cli:tmss10ping|TMSS10Ping]].
 **Example**
-The following script was used to alter the displayed menu:
+The following script was used to alter the displayed Tape Management Task Menu:
+<code plain;>
-     menu=
+      menu=
-    (
+   (
-       {
+      {
-           filter="*Outlook*";
+          filter="*Guide*";
-           hidden=true;
+          hidden=true;
-           // text="iCalendar integration";
+      },
-       },
+      {
+          filter="*Users*";
+          hidden=true;
+      },
+      {
+          filter="*Upload*";
+          hidden=true;
+      },
+      {
+          filter="*Outlook*";
+          hidden=true;
+          // text="Alternate iCalendar text";
+      },
+      {
+             hidden=true;
+             text="Custom Command 1";
+             //sequence=100;
+             command="echo hello > out.txt";
+             filters=( "*this String will be excluded*", "*So will this String*" );
+      },
        {
            filter="*Send*";
            hidden=false;
-           text="Transmit to Offsite Vault";
+           text="Send to Offsite Vault";
            sequence=01;
        },
@@ Line 44: / Line 116: @@
            filter="*Recall*";
            hidden=false;
-           text="Return from Offsite Vault";
+           text="Recall from Offsite Vault";
            sequence=02;
        },
@@ Line 53: / Line 125: @@
            sequence=100;
        }
-    );
+   );
+   //
+   // If you specify a valid logfile value the logfile dialog will not be displayed
+   //
+   logfile="%HOMEDRIVE%HOMEPATH\\Documents";
+   </code>
 The above script provides the necessary components to:
- hide the outlook component
+  * Hide any command with the String Guide, Users, Upload, SCSI, Excel, Library Management, List or Outlook.
-change the name of the Send function to "Transmit to Offsite Vault"
+  * Change the displayed name of the **[[lite:function_send|Send]]** function to **Send to Offsite Vault**.
-place the Send function at the top of the list
+  * Place the **Send** function at the top of the drop-down list.
-change the name of the Recall function to "Return from Offsite Vault"
+  * Change the name of the **[[lite:function_recall|Recall]]** function to **Recall from Offsite Vault**.
-place the Recall function second in the list
+  * Place the **Recall** function second in the drop-down list.
-add a command to the Management Tasks menu that runs TMSS10Ping for the local TapeTrack Server with the text "Ping TapeTrack Server"
+  * Add a command to the Tape Management Task Menu that runs [[cli:tmss10ping|TMSS10Ping]] for the local TapeTrack Server with the text **Ping TapeTrack Server**.  Replace the server address ''localhost'' with your TapeTrack Framework Server address (dotted IP or DNS) to run the command against your server.
-place that command at a low location in the sequence.
+  * Place that command at a low location in the Tape Management Task Menu.
-**Note**: the sequence numbers 01 and 02 were used to indicate that they came before the default first sequence number of "10" that is typically assigned to "Scan-In".
+  * Change the Save Location for Log Files.
-Change the Save Location for Log Files
-{{:lite:lite_config_altered.png}}
+**Note**: the sequence numbers 01 and 02 were used to indicate that they came before the default first sequence number of "10" that is typically assigned to ''Scan-In''.
+===Modified Menu View===
+{{modified_menu.png}}
+===== Log Files =====
 Log files create a .txt read -file of all of the actions that are performed during a session. Using the TMSSLite.cfg file, you can change the location of where these files are saved.
-The default save location is " %HOMEDRIVE%HOMEPATH\\Documents "; however, this can be modified by changing the location variable in the script:
+The default save location is " %HOMEDRIVE%HOMEPATH\\Documents ";
-   logfile="PATH"
+To change where the log file is saved uncommented (remove <nowiki>//</nowiki> at the start of line) and set directory path where you want the file written to.  The directory specified must exist before running TapeTrack Lite.
+<code plain;> logfile="C:\Users\GazillaByte\Documents\TapeTrack Log Files";</code>
+Once the log file directory is specified in the configuration file, the log file location screen will no longer be displayed when selecting tasks in TapeTrack Lite.
 ===== Repository Filter =====
-Changing the "localrepositoryfilter" variable will limit TapeTrack Lite users to only see a specific repository within their customers. You can use TapeTrack Filters to facilitate this. For example, if you added the script:
+Changing the **localrepositoryfilter** variable will limit Lite users to only see a specific [[object:repository|Repository]] within their [[object:customer|Customers]].
-     localrepositoryfilter="*LIBR*";
-TapeTrack Lite will only display repository IDs containing "LIBR".
+For example, if you added the script:
+<code>     localrepositoryfilter="*LIBR*"; </code>
+TapeTrack Lite will only display [[object:repository|Repository-ID's]] containing the String **LIBR**.
 ===== Route Log Files to a Syslogd Service =====
-Additionally, if you have a syslogd service setup, you can use the TMSSLite.cfg file to send log files to your syslogd server using the  " syslogd = " command. The TMSSLite.cfg sample file has the following example:
+If you have a syslogd service setup, you can configure the TMSSLite.cfg file to have [[desktop:lite|Lite]] send log files to your syslogd Server using the **syslogd = ** command.
-     syslogd = { facility="local1"; server="192.168.10.1"; port=514; };
+The TMSSLite.cfg sample file has the following example:
+<code>syslogd = { facility="local1"; server="192.168.10.1"; port=514; };</code>
 <-  ^ lite:starting|Getting Started ^ lite:environmental_variables|Environmental Variables ->
+===== Disable Speech =====
+You can stop TapeTrack Lite verbalizing scanning errors by uncommenting (remove <nowiki>//</nowiki> at the start of line) the line
+Change code
+<code>
+   //
+   // If you're a little put off by a computer telling you about your mistakes you can set disablespeech to true.
+   //
+   // disablespeech=true;
+   </code>
+to
+<code plain;>
+   //
+   // If you're a little put off by a computer telling you about your mistakes you can set disablespeech to true.
+   //
+   disablespeech=true;
+</code>
+===== Variables =====
+===== Servers =====
+===== Allocation =====
+===== Routing =====
+===== Barcodes =====
+===== Notifications =====
+Lite will display various notifications in the lower right of your display at different times.
+For example when logging on to Lite, a notification will display a welcome message and the last IP address used to logon.
+{{logon_notification.png}}
+By default the notifications section of Lite blocks Library Health Warnings as this notification is more relevant in TapeMaster.
+<code>
+notifications =
+{
+   filters=
+   (
+      {
+    	    title="Library Health Warning"; line1="*"; line2="*"; disable=true;
+      }
+   )
+};
+</code>
+It is possible to block other notifications, if required, by adding additional blocks of code for the required notifications. For example to remove, or block, the ''Logged-On'' notification modify the ''notifications'' block of code to include the following code.
+<code>
+notifications =
+{
+   filters=
+   (
+      {
+    	    title="Library Health Warning"; line1="*"; line2="*"; disable=true;
+      },
+      {
+	    title="Logged-On"; line1="*"; line2="*"; disable=true;
+      }
+   )
+};
+</code>