variable:start
This is an old revision of the document!
Table of Contents
Environmental Variables
The TapeTrack Desktop and Command Line Programs can be influenced in their behavior by setting Environmental Variables.
For more information on setting Environmental Variables see this Technical Note.
Environmental Variables
| Setting Environmental Variables The default behavior of TapeTrack programs can be changed by setting Environmental Variable. These Environmental Variable can be set using the following methods. Windows Command Line set VARIABLE=VALUE Where VARIABLE is the Environmental Variable name, and VALUE is the Environmental Variable value. | |
| TMSS10BACK The Environmental Variable TMSS10BACK specifies the full path to a directory that can be used to backup the TapeTrack Database. This location is set when the TapeTrack Framework Server is installed. If the database relocated this Environmental Variable value will need to be reset to the new location. | |
| TMSS10DB The Environmental Variable TMSS10DB specifies the full path to the TapeTrack Database. setTMSS10DB See Also Setting Environmental Variables Introduction environmental_variables path | |
| TMSS10REPORTS The Environmental Variable TMSS10REPORTS specifies the full path to a directory that can be used for writing TapeTrack Reports to. setTMSS10DB See Also * Variables * Setting Environmental Variables Introduction environmental_variables paths reports pdf csv html excel | |
| TMSS10SCRIPTS The Environmental Variable TMSS10SCRIPTS contains the full path to a directory that can be used to access TapeTrack Scripts. setEnvironmental VariableTMSS10DB See Also Setting Environmental Variables Introduction environmental_variables path | |
| TMSSAPILOGDIR The Environmental Variable TMSSAPILOGDIR performs the following: * Enables TapeTrack low level API communications debugging. * Specifies the path of the directory where log files debugging files will be created. Example Starting TapeMaster with the variable | |
| TMSSATTRIBUTENOCASELOOKUP The Environmental Variable TMSSATTRIBUTENOCASELOOKUP allows searching of Attributes to match Strings without case sensitivity. Example set TMSSATTRIBUTENOCASELOOKUP=true See Also Setting Environmental Variables Introduction environmental_variables attributes | |
| TMSSBARCODEPARSESPACEOK By default any barcode with a space within it will be truncated at that space by command line programs before processing. Setting the Environmental Variable TMSSBARCODEPARSESPACEOK to any value, will allow any barcode with a space to bypass the truncation and be processed according to the Server level | |
| TMSSBEEP The Environmental Variable TMSSBEEP causes Command Line Programs to emit a beep when they experience a critical error message. Example set TMSSBEEP=on See Also Setting Environmental Variables Introduction environmental_variables | |
| TMSSCMDSTRING The Environmental Variable TMSSCMDSTRING changes the behavior of Command Line Programs to take the value set in TMSSCMDSTRING and write that string, along with the variables to stdout. This allows you to write commands automatically using the value TMSSCMDSTRING along with the values contained in the output from the | |
| TMSSCONFIGFILE The Environmental Variable TMSSCONFIGFILE is used by TapeTrack Desktop Programs to set an alternative path for their Configuration File See Also Setting Environmental Variables environmental_variables config_file path Introduction | |
| TMSSCSVNOHEADER The Environmental Variable TMSSCSVNOHEADER removes headings from the output when Environmental Variable TMSSREPORTFORMAT is set to CSV Example set TMSSCSVNOHEADER=true See Also environmental_variables printing csv Introduction | |
| TMSSDESCRIPTIONTEXT This Environmental Variable TMSSDESCRIPTIONTEXT allows you to set the attribute index 0 (Description) to a custom string value. Example To set attribute 0 from Description to Pool Windows Command Line set TMSSDESCRIPTIONTEXT=Pool Windows PowerShell | |
| TMSSDROPREPORT The Environmental Variable TMSSDROPREPORT allows you to drop, or remove, a report section from command line report output based on the report ID. This can be of benefit if you only need one section of the report output. TMSSDROPREPORT is used in the format | |
| TMSSEXCELOUTPUTPATH The Environmental Variable TMSSEXCELOUTPUTPATH specifies the output path name of the Microsoft Excel file when the Environmental Variable TMSSREPORTFORMAT is set to EXCEL Example set TMSSEXCELOUTPUTPATH="C:\Program Files\TapeTrack\TapeTrack Framework Server\var\reports" Sheet-YYYY-MM-DD-HH-MM-SS.xls | |
| TMSSINETD The Environmental Variable TMSSINETD will add a message to the standard error stream displaying the IP address of the computer that is connecting via xinetd, providing an easy way to track connecting addresses. Example Windows Command Line set TMSSINETD=true | |
| TMSSKERBEROS By default TapeTrack Command Line programs use the -S argument to pass the User and password for authentication. If a Windows Command Line program wishes to use the current Windows User and authenticate via Kerberos Single-Signon, the Environmental Variable TMSSKERBEROS should be set. | |
| TMSSLEVELNAMES The Environmental Variable TMSSLEVELNAMES allows, via Configuration files or Command Line Programs, to map Zone level numbers to String values. Example Using TMSS10Inventory to display LTO Volumes currently at Repository OFFS from Customer US04. TMSS10Inventory -S user:-password@server -V "US04.LTO.*@OFFS" Output | |
| TMSSNOLEVELSLOT The Environmental Variable TMSSNOLEVELSLOT is set, TapeTrack programs will only display the level and not the slot when representing a Physical Slot that has a slot and a level. The value of the Environmental Variable is not consequential. Example set TMSSNOLEVELSLOT=true See Also Setting Environmental Variables | |
| TMSSNOMD5 By default when TapeTrack Command Line programs send passwords to the TapeTrack Framework Server they are first MD5 hashed, and then AES encrypted along with the rest of the data that is sent with the login request. When a TapeTrack User uses Windows Active Directory authentication, TapeTrack must be able to AES decrypt the login request and then send an unhashed password to Active Directory. | |
| TMSSPDFCOLORHDR The Environmental Variable TMSSPDFCOLORHDR changes the color of the PDF report header background or title bar using HEX number input (without the #). The Environmental Variable TMSSPDFCOLORHDR will set the color for all report headers. If used in conjunction with the Report-ID, eg TMSSPDFCOLORHDR100, it will override the global color set for that report. For example TMSS10MoveList produces three reports (Report 117, 118 and 119), setting TMSSPDFCOLORHDR to red and TMSSPDFCO… | |
| TMSSPDFLOGOPATH The Environmental Variable TMSSPDFLOGOPATH defines the fully qualified path of a JPG image that is to be used when the TMSSREPORTFORMAT specifies PDF output. The logo file, to avoid any distortion, should be 400 pixels wide by 168 pixels high. If your logo does not fit these dimensions, use white space padding around your logo to pad it out to an appropriate format. | |
| TMSSPDFORIENTATION The Environmental Variable TMSSPDFORIENTATION sets the PDF report page orientation. Value Description PORTRAIT Report created in portrait orientation LANDSCAPE Report created in landscape orientation Example Windows Command Line | |
| TMSSPDFOUTPUTPATH The Environmental Variable TMSSPDFOUTPUTPATH specifies the output path name when Environmental Variable TMSSREPORTFORMAT is set to PDF output. Example set TMSSPDFOUTPUTPATH ="C:\Program Files\TapeTrack\TapeTrack Framework Server\var\reports" Report-YYYY-MM-DD-HH-MM-SS.pdfYYYY-MM-DD-HH-MM-SS | |
| TMSSPDFPAGESIZE The Environmental Variable TMSSPDFPAGESIZE sets the PDF output page size. Possible values are: Value Description letter 216 x 279 mm (8.5 x 11.0 in) legal 216 x 356 mm (8.5 x 14.0 in) A4 210 x 297 mm (8.3 x 11.7 in) | |
| TMSSPRINTRAWINPUT The environmental variable TMSSPRINTRAWINPUT prints the raw data values read from input to stderr output. This can be useful for viewing raw input data against the processed or parsed data used for processes such as running TMSS10Sync. The value of the | |
| TMSSPROGRESSDISABLE The Environmental Variable TMSSPROGRESSDISABLE will disable the progress messages in command line program output. Example Windows Command Line set TMSSPROGRESSDISABLE=true Windows PowerShell $env:TMSSPROGRESSDISABLE = true Linux export TMSSPROGRESSDISABLE=true | |
| TMSSPWPATH By default, when TapeTrack Command Line Programs use the -S argument and: * Specify no password file, and * Don't use the prompt or literal password syntax. then, the password will be loaded from: * C:\tapetrack\pw\user (Windows) | |
| TMSSRECONCILETEXT The output from the TMSS10Reconcile process has the default Volume statuses of: * [0] Reconciled * [1] Reconciled (Confirmed) * [2] Confirmation Bypass * [3] Pending confirmation * [4] Absent from Scan-Map * [5] Unexpected in Scan-Map | |
| TMSSREPORTCOLUMNDELETE This Environmental Variable TMSSREPORTCOLUMNDELETE can be used to remove columns from a Command Line Program output. To remove columns, set the variable to an array of comma delimited Integers, each representing a column that you would like to remove. TMSSREPORTCOLUMNDELETE will remove the specified columns from all reports. In reports that combine multiple reports like TMSS10ListMoveHistory, adding the report ID to TMSSREPORTCOLUMNDELETE will only affect that report (… | |
| TMSSREPORTFORMAT The Environmental Variable TMSSREPORTFORMAT is used in TapeTrack Command Line Programs to define the format of the output produced. Supported Values The following values are currently supported. Value Description CSV Create Comma Delimited output | |
| TMSSREPORTHTMLLOGO The environmental variable TMSSREPORTHTMLLOGO defines the fully qualified path of an image that is to be used when the TMSSREPORTFORMAT specifies HTML output. The logo file, to avoid any distortion, should be 400 pixels wide by 168 pixels high. | |
| TMSSREPORTTITLE The Environmental Variable TMSSREPORTTITLE allows a custom heading to be applied to a command line report using the report ID. Example Using TMSS10Inventory, setting report heading to My Inventory using report ID 100. Windows Command Line set TMSSREPORTTITLE100=My Heading | |
| TMSSSCANFILENOPARSE TMSSSCANFILENOPARSE stops Barcodes being sent to the server for parsing to extract Customer-ID, Media-ID and Volume-ID. This requires the Customer and Media-ID to be set via the ttidef file. Example set TMSSSCANFILENOPARSE=true | |
| TMSSSCANFILEUNQUALIFIED environmental_variables connecting Introduction | |
| TMSSSERVERPROXY The Environmental Variable TMSSSERVERPROXY tells the TapeTrack Communications API to tunnel all TapeTrack communications via a HTTP proxy. The value of TMSSSERVERPROXY should be set in the format user:password@server:port, where: * user (optional) is the user that will be connecting to the HTTP Proxy Server. | |
| TMSSSLACKICON The Environmental Variable TMSSSLACKICON specifies the location of an icon to add to the Slack message. Example Windows Command Line set TMSSSLACKICON=https://a.slack-edge.com/80588/img/icons/app-57.png Windows PowerShell $env:TMSSSLACKICON = "https://a.slack-edge.com/80588/img/icons/app-57.png" | |
| TMSSSLACKNOTES The Environmental Variable ''TMSSSLACKNOTES“ allows you to add a Note to the Slack message. Example Windows Command Line set TMSSSLACKICON=GazillaByte Report Windows PowerShell $env:TMSSSLACKICON = "GazillaByte Report" Linux export TMSSSLACKICON=GazillaByte Report | |
| TMSSSLACKONERROR The Environmental Variable TMSSSLACKONERROR will add a message to the Slack message in the event of an error in the executing process. Example Windows Command Line set TMSSSLACKONERROR=true Windows PowerShell $env:TMSSSLACKONERROR = "true" Linux | |
| TMSSSLACKURL The Environmental Variable TMSSSLACKURL sets the URL for a Slack message to be sent to detailing the result of a script running a command line executable on a remote server. Example Windows Command Line set TMSSSLACKURL=https://hooks.slack.com/services/your_unique_address_values | |
| TMSSSLACKUSER The Environmental Variable TMSSSLACKUSER allows you to add a user name or company description to the top of the Slack message to better differentiate the message origin if you have several different users set up. Example Windows Command Line set TMSSSLACKUSER=GazillaByte | |
| TMSSSTDERRDIR The Environmental Variable TMSSSTDERRDIR specifies the full path to write the standard error stream to a date stamped file. Example Windows Command Line To write the standard error, from TMSS10Sync, to C:\Program Files\TapeTrack\TapeTrack Sync\reports set TMSSSTDERRDIR=C:\Program Files\TapeTrack\TapeTrack Sync\reports | |
| TMSSSTDERRNOCOLOR The Environmental Variable TMSSSTDERRNOCOLOR disables color formatting for displayed stderr output to terminal window. Example Windows Command Line set TMSSSTDERRNOCOLOR=true Windows PowerShell $env: TMSSSTDERRNOCOLOR = true Linux export TMSSSTDERRNOCOLOR=true | |
| TMSSSTDERRTERMINAL The Environmental Variable TMSSSTDERRTERMINAL displays the stderr on terminal, while still allowing it to be written to the file specified by TMSSSTDERRDIR. Prerequisites Variable TMSSSTDERRDIR set to a valid file location. Example Windows Command Line | |
| TMSSUNQUALIFIEDVOLUME TMSSUNQUALIFIEDVOLUME modifies the output of command line programs from displaying fully qualified barcodes to unqualified barcodes. Example Using TMSS10Inventory to display LTO volumes currently at repository OFFS from customer US04. TMSS10Inventory -S user:-password@server -V "US04.LTO.*@OFFS" | |
| TMSSUSERINHERIT The Environmental Variable TMSSUSERINHERIT allows an account to be created that has no access, but has an inherit permissions flag. Allow access inheritanceTrue Once that User has been authenticated a command can be sent to the server telling it to copy another User's access list to that empty shell. |
Linux Environmental Variables
variable/start.1642124025.txt.gz · Last modified: 2025/01/21 22:07 (external edit)