TrueChem variables are predefined keywords used to give you access to the data within your TrueChem installation. You can use variables to create and customize your formulas, rules, and actions. Below is a categorized list of variables you can use in TrueChem. Click the category for a detailed list of variables.
NOTE: When referencing variables in TrueChem, the variable name MUST be contained within square brackets [ ] and is NOT case sensitive.
Categories:
Also See:
| Working with Units | Variable Defaults | Variable Formatting | ||
Adjustment Item Variables – A test may contain multiple adjustment items. To specify a specific adjustment item, you must include the item number associated with the adjustment. If no item number is specified, TrueChem will use the current adjustment item. Example: [ADJ4.VALUE] will return the value of adjustment item number 4.
| Name | Description |
| ADJ | The displayed adjustment amount (in the unit defined on the setup of the adjustment item) |
| ADJ.ACCUM | The accumulated amount added since the last remake not including the current adjustment amount |
| ADJ.ACCUM(unit) | The accumulated amount added since the last remake (in the unit specified) not including the current adjustment amount |
| ADJ.ADDAMOUNT | The amount of additive necessary to adjust [ADJ.BASEDON] by [ADJ.TOVARY] |
| ADJ.ADDINCREMENTS | Precision used for rounding of the calculated adjustment amount |
| ADJ.ADDITIVE | Name of the additive |
| ADJ.BASEDON | Name of the test item the adjustment effects |
| ADJ.COMMENTS | Notes assigned by a rule that are directly associated with the adjustment item |
| ADJ.ISINVENTORIED | Returns 1 if consumable is inventory controlled, 0 otherwise |
| ADJ.LOTBALANCE | Returns balance of consumable’s current active inventory lot in consumable’s defined stock unit, 0 if no active lots are found or consumable is not inventoried |
| ADJ.TOTALBALANCE | Returns total balance of all consumable’s current active inventory lots in consumable’s defined stock unit, 0 if no active lots are found or consumable is not inventoried |
| ADJ.COST | Currency formatted value of the cost for amount of additive |
| ADJ.COSTTOTAL | See [TST.ADDCOSTTOTAL] |
| ADJ.DILUTEPOINT | Point beyond which dilutions are calculated |
| ADJ.DILUTETO | Target value of dilution |
| ADJ.DISPLAYAS | Displayed name of the additive for the adjustment item based on advanced settings |
| ADJ.DISPLAYVALUE | Displayed text or number for the adjustment amount |
| ADJ.FIELDn | Additive Optional n field (n = 1 to 12) |
| ADJ.FRACTIONOFMAKEUP | Percentage of current adjustment based on the additives makeup amount (as a decimal ie: 0.25=25%, 1.00=100%) |
| ADJ.ID | Unique ID number |
| ADJ.INCREMENTS | Precision used for rounding of the calculated adjustment amount |
| ADJ.INTERNALPARTNUMBER | Additive internal part number (same as ADJ.FIELD1) |
| ADJ.ITEMNUM | Adjustment item number. ie ADJ1 number is 1 |
| ADJ.LOTLABELS | List of lot labels associated with this adjustment |
| ADJ.LOTLABELS(#) | Lot label associated with this adjustment. Replace # with the number of lots you want to show |
| ADJ.LOTLOCATIONS | List of lot locations associated with this adjustment |
| ADJ.LOTLOCATIONS(#) | Lot location associated with this adjustment. Replace # with the number of lots you want to show |
| ADJ.MAKEUPAMOUNT | Makeup amount of additive in defined makeup unit |
| ADJ.MAKEUPSHORTUNIT | Short name for the additive’s makeup unit |
| ADJ.MAKEUPUNIT | Name for the additive’s makeup unit |
| ADJ.MAXADD | The maximum add amount. Adds will not be greater than [ADJ.MAXADD] |
| ADJ.MINADD | The minimum add amount. No adds will be given if [ADJ.RAWVALUE] is less than [ADJ.MINADD] |
| ADJ.MINUTESSINCESIGNOFF | Minutes since the last signed off addition of referenced additive (-1 if no previous additions) |
| ADJ.MSDS | MSDS associated with this adjustment |
| ADJ.MTO | Metal turnover. Percentage added (as a decimal) since the last remake, based on the additives makeup amount |
| ADJ.NAME | Name of the additive |
| ADJ.NOTES | Notes assigned by a rule that are directly associated with the adjustment item |
| ADJ.NUM | Adjustment item number. ie ADJ1 number is 1 |
| ADJ.ORIGINALVALUE | Amount of addition prior to any user editing |
| ADJ.OUTSTANDINGADDAMOUNT | Amount of any outstanding (not signed off) additions that may exist for referenced additive |
| ADJ.PARTNUMBER | Part number for the additive |
| ADJ.PERCENTOFMAKEUP | The percentage added, since the last remake, based on the additives makeup amount (as a decimal) |
| ADJ.PREVVALUE | Previous adjustment amount (in the unit defined on the setup of the adjustment item) |
| ADJ.PREVVALUE(unit) | Previous adjustment amount (in the unit specified) |
| ADJ.PRICEPERSTOCKUNIT | Price per stock unit of the additive |
| ADJ.RAWVALUE | The calculated adjustment amount (in the unit defined on the setup of the adjustment item) before rounding, applying the minimum and maximum add amounts, and other adjustments |
| ADJ.RAWVALUE(unit) | The calculated adjustment amount (in the unit specified) before rounding, applying the minimum and maximum add amounts, and other adjustments |
| ADJ.REFERENCE | The calculated adjustment amount (in the unit specified) before rounding, applying the minimum and maximum add amounts, and other adjustments |
| ADJ.SAMPLEBEFOREADDS | Equals “1” if current test date/time is prior to last signed off add or if adds are outstanding, otherwise equals “0” |
| ADJ.SHORTNAME | Short name of the additive |
| ADJ.SHORTSTOCKUNIT | Short name of the additive’s stock unit |
| ADJ.SHORTUNIT | Short name for the additive unit |
| ADJ.STARTADDSAT | Threshold the [ADJ.BASEDON] item must reach before an add is requested |
| ADJ.STOCKUNIT | Stock unit of the additive |
| ADJ.TOOBTAIN | The target value of [ADJ.BASEDON] item |
| ADJ.TOVARY | Amount of change to [ADJ.BASEDON] item when [ADJ.ADDAMOUNT] is added |
| ADJ.UNIT | Name of the additive unit |
| ADJ.VALUE | The displayed adjustment amount (in the unit defined on the setup of the adjustment item) |
| ADJ.VALUE(unit) | The displayed adjustment (in the unit specified) |
| ADJ.VENDOR | Vendor of the additive |
| ADJ.VERB | Verb that describes addition or removal action |
External Data Variables – These variables provide access to the recordset of information returned from the use of an External Data Source defined in the TrueChem Library.
| Name | Description |
| EXD.LIST | Return a CrLf delimited string of ~ delimited strings, one for each record in the recordset |
| EXD.LIST=fieldname | Returns a ~ delimited string listing all the values of the specified field from the recordset |
General Variables
| Name | Description |
| COMPUTERNAME | The current computer’s name |
| DATE | The current date in the computer’s default format |
| DAY | The current day (1-7) |
| DAYOFWEEK | Current day of the week (Monday, Tuesday, etc.) |
| DAYOFWEEKSHORT | The current day of the week (Mon, Tue, etc.) |
| HOUR | The current hour of the day (0-23) |
| MONTH | The current month (1-12) |
| RESULT | The current value of the result or adjustment item. You can use this variable in a rule to reference the current item’s value |
| TIME | The current time |
| WEEKDAY | The current day of the week (1-7) |
| YEAR | The current year |
GET Variables – GET variables are used to collect data from the end user
| Name | Description |
| GET.PROMPT | Replace PROMPT with the text the user will see when entering the variable’s value |
{Group} Variables – {Group} is a user defined term in TrueChem. {Group}s contain a collection of {Object}s
| Name | Description |
| GRP.DATECREATED | Date the {Group} was created |
| GRP.DESCP | Name of the {Group} |
| GRP.DISTEMAIL | Distribution e-mail |
| GRP.DISTFAX | Distribution fax number |
| GRP.DISTINFO | Distribution information |
| GRP.DISTLIST | Distribution list |
| GRP.DSPMESSAGE | The display message for the {Group} (on the {Group} setup form) |
| GRP.DISTPHONE | Distribution phone number |
| GRP.FIELDn | {Group} Optional n field (n = 1 to 12) defined in {Group} Setup |
| GRP.ID | Unique ID number |
| GRP.NAME | Name of the {Group} |
| GRP.PRTMESSAGE | The print message for the {Group} (on the {Group} setup form) |
| GRP.SELECT1 | User defined list in {Group} setup |
| GRP.SELECT1SHORT | User defined list in {Group} setup |
Input Variables – A test may contain multiple input items. To specify a specific input item, you must include the item number associated with the input. If no item number is specified, TrueChem will use the current input item. Example: [INP4] will return the value of input item number 4.
| Name | Description |
| INP | The value of the input item |
Inventory Variables – INV variables are used to reference current details of the Inventory module. When these variables refer to Consumable, this means the Additive that is the subject of the Inventory item (Lot, Req, Transaction, etc).
| Name | Description |
| INV.CONSFIELDn | Consumable Optional n field (n = 1 to 12) |
| INV.CONSINTERNALPARTNUMBER | Additive internal part number (same as INV.CONSFIELD1) |
| INV.CONSMAXQTY | Maximum quantity defined for consumable |
| INV.CONSMINQTY | Minimum quantity defined for consumable |
| INV.CONSQTYONORDER | Current amount of consumable on order |
| INV.CONSQTYUNUSABLE | Current unusable amount of consumable |
| INV.CONSQTYUSABLE | Current usable amount of consumable |
| INV.CONSREORDERPOINT | Reorder point defined for consumable |
| INV.CONSSHORTNAME | Short name of consumable |
| INV.CONSSTOCKBALANCE | Current balance of consumable |
| INV.CONSSTOCKUNITNAME | Stock unit name of consumable |
| INV.CONSTYPEDESCRIPTION | Type description of consumable |
| INV.CONSUMABLENAME | Name of additive |
| INV.LOTBALANCE | Current balance of inventory lot |
| INV.LOTCONTAINERTEXT | Current balance of inventory lot expressed in container units |
| INV.LOTDATEORDERED | Date lot was ordered |
| INV.LOTDATERECEIVED | Date lot was received |
| INV.LOTDATERETIRED | Date lot was retired |
| INV.LOTEXPIRATION | Expiration date of lot |
| INV.LOTLABEL | Lot label |
| INV.LOTLOCATIONDESCRIPTION | Storage location description of lot |
| INV.LOTMANUFDATE | Manufacture date of lot |
| INV.LOTPRICEPERUNIT | Price per stock unit of lot |
| INV.LOTQTYRECEIVED | Quantity received for lot |
| INV.MANUFLOTID | Manufacturer lot identifier |
| INV.MANUFNAME | Manufacturer name |
| INV.MANUFPRODDESCRIPTION | Manufacturer product description |
| INV.MANUFPRODMSDS | Manufacturer product MSDS |
| INV.PODELIVERYDATE | Requisition delivery date |
| INV.PONUMBER | Requisition number |
| INV.POAMOUNT | Quantity received for lot |
| INV.REQDELIVERYDATE | Requisition delivery date |
| INV.REQNUMBER | Requisition number |
| INV.TRANSAMOUNT | Amount of transaction |
| INV.TRANSDATETIME | Date/Time of transaction |
| INV.TRANSGROUPNAME | Name of {Group} associated with transaction |
| INV.TRANSOBJECTNAME | Name of {Object} associated with transaction |
| INV.TRANSTYPE | Type of transaction |
| INV.TRANSUNITNAME | Unit name of transaction amount |
| INV.TRANSUSERNAME | TrueChem user associated with transaction |
| INV.VENADDRESS | Vendor address |
| INV.VENCONTACT | Vendor contact name |
| INV.VENDESCRIPTION | Vendor description |
| INV.VENEMAIL | Vendor e-mail address |
| INV.VENFAX | Vendor fax number |
| INV.VENNAME | Vendor name |
| INV.VENPHONE | Vendor phone number |
| INV.VENPRODDESCRIPTION | Vendor product description |
| INV.VENPRODPARTNUM | Vendor part number |
| INV.VENWEBSITE | Vendor website address |
Library Variables – You can reference a user defined library using variables. Library items can be custom documents or scripts.
| Name | Description |
| LIB.DESCRIPTION | Replace Description with the description of the library you want to use. Example: [LIB.Safety Instructions] will return the library item with a description of Safety Instructions |
| LIB.ID | Replace ID with the ID number of the library you want to use. Example: [LIB.12] will return library number 12 |
| LIB.TABLELOOKUPX (lib name, Y-value) | Returns a numeric value from a Lookup Table type library item. (more info) |
| LIB.TABLELOOKUPY (lib name, X-value) | Returns a numeric value from a Lookup Table type library item. (more info) |
| LIB.TABLESELECT (lib name, index) | Returns a text value from a Selection Table type library. (more info) |
Name Variables – Name variables are used to return the user defined terms in TrueChem.
| Name | Description |
| NAM.ACTION | The word used to describe the action being performed on the current adjustment |
| NAM.ADD | The word used to describe an addition (On the Terms Tab in SystemSetup) |
| NAM.CATEGORY | The word used to describe a category (On the terms tab in System Setup) |
| NAM.COMPANY | Your company’s name |
| NAM.CONSUMABLE | The word used to describe item that are used within the company |
| NAM.EXCEPT | The word used to describe exceptions (On the Terms Tab in SystemSetup) |
| NAM.GROUP | The word used to describe {Group}s (On the Terms tab in System Setup) |
| NAM.GROUPFIELDn | User defined term for Optional n (n = 1 to 12) field used in {Group} Setup |
| NAM.GROUPSELECT1 | The description of the first user definable selection in {Group} setup |
| NAM.ITEM | The word used to describe items (On the Terms Tab in SystemSetup) |
| NAM.OBJECT | The word used to describe {Object}s (On the Terms Tab in SystemSetup) |
| NAM.OBJECTFIELDn | User defined term for Optional n (n = 1 to 12) field used in {Object} Setup |
| NAM.OBJECTSELECT1 | The description of the first user definable selection in {Object} Setup |
| NAM.PARTIAL | The word used to describe a partial remake (On the Terms Tab in SystemSetup) |
| NAM.REMAKE | The word used to describe a total remake (On the Terms Tab in SystemSetup) |
| NAM.REMOVE | The word used to describe a remove (On the Terms Tab in SystemSetup) |
| NAM.REPORT | The word used to describe a test report (On the Terms Tab in SystemSetup) |
| NAM.SEQUENCE1 | The word used to describe sequence 1 (On the General Tab in [NAM.TREATMENT] System Setup) |
| NAM.SEQUENCE2 | The word used to describe sequence 2 (On the General Tab in [NAM.TREATMENT] System Setup) |
| NAM.SHIFT1NAME | Name of the 1st shift |
| NAM.SHIFT2NAME | Name of the 2nd shift |
| NAM.SHIFT3NAME | Name of the 3rd shift |
| NAM.SHIFT4NAME | Name of the 4th shift |
| NAM.SHIFT5NAME | Name of the 5th shift |
| NAM.SHIFT6NAME | Name of the 6th shift |
| NAM.TESTDATETIME1 | Name of the primary date and time when performing a test |
| NAM.TESTDATETIME2 | Name of the secondary date and time when performing a test |
| NAM.TREATMENT | The word used to describe products |
{Object} Variables – {Object} is a user defined term in TrueChem. {Object}s represent a single tank\bath\solution.
| Name | Description |
| OBJ.CURRVOLUME | Volume of {Object} including the current level input |
| OBJ.DATECREATED | Date {Object} was created |
| OBJ.DESCP | Name of the {Object} as shown on the TrueChem Tree |
| OBJ.DESCRIPTION | Name of the {Object} as shown on the TrueChem Tree |
| OBJ.DIMFT | From top |
| OBJ.DIMUNIT | Unit name for the dimensions of the {Object} |
| OBJ.DIMX | Width |
| OBJ.DIMY | Length |
| OBJ.DIMZ | Height |
| OBJ.DSPMESSAGE | Notes as defined on the {Object} Notes tab |
| OBJ.FIELDn | {Object} Optional n field (n = 1 to 12) defined in {Object} Setup |
| OBJ.GHSIMAGE(p1,P2) | HTML to display the GHS pictograms for an {Object} Optional parameters: p1 – 0=current {Object} (default), 1=use non-zero add chemicals p2 – 0=enlarge to fit space (default), 1=maintain original size |
| OBJ.GHSSIGNALWORD(p1,p2,p3,p4) | HTML to display the GHS Signal Word for an {Object} Optional parameters: p1 – RGB color if Warning (000000-Black (default), FF0000-Red, etc.) p2 – RGB color if Danger (000000-Black (default), FF0000-Red, etc.) p3 – 0=current {Object} (default), 1=use non-zero add chemicals p4 – 0=return HTML, 1=return Signal Word only |
| OBJ.GHSSTATEMENTS(p1,p2,p3,p4) | HTML to display the GHS Statements for an {Object} Optional parameters: p1 – 0=both (default), 1=Hazard only, 2=Precautionary only p2 – 0=wrap, 1=break after each, 2=bulleted list (default) p3 – 0=don’t show code, 1=code before statement (default), 2=code followed by colon p4 – 0=all {Object} statements (default), 1=only add chemical statements |
| OBJ.GROUPID | The unique {Group} ID for this {Object} |
| OBJ.HMISHTMLIMAGE(p1) | HTML to display the HMIS image for an {Object} Optional parameters: p1 – 1=display image 250% larger |
| OBJ.ID | Unique ID number |
| OBJ.LASTCHANGED | Date {Object} was last changed |
| OBJ.LASTREMAKE | Date of last {Remake} |
| OBJ.LEVELINPUT | The current operating level entered when performing a test |
| OBJ.LOCATION | Location of the {Object} |
| OBJ.MAKEUPHTML | HTML for displaying the makeup information of an {Object} (more info) |
| OBJ.MANUFACTURER | Manufacturer of {Object} |
| OBJ.NAME | Name of the {Object} |
| OBJ.PERCENTVOLUME | Percentage of volume, as a decimal, of {Object} based on the current level |
| OBJ.PLACARDNOTES | Placard notes for {Object} |
| OBJ.PPEHTMLIMAGES(p1,p2) | HTML for displaying the PPE requirements for an {Object} Optional parameters: p1 – 0=no caption (default), 1=caption below, 2=caption above, 3=both p2 – 0=image at 40×30 (default), 1=enlarge to 60×45, 2=enlarge to 80×60 |
| OBJ.REMAKENOTES | {Remake} notes for {Object} |
| OBJ.RESPONSIBLEUSER | Numerical identifier of {Object} responsible user |
| OBJ.RESPONSIBLEUSERID | Login name of {Object} responsible user |
| OBJ.RESPONSIBLEUSERNAME | First and last name of {Object} responsible user |
| OBJ.REVISIONDATE | Date the last revision was made to {Object} |
| OBJ.REVISIONNUMBER | Current revision number of {Object} |
| OBJ.SAFETYIMAGE(p1) | HTML to display the HMIS or GHS image for an {Object} (based on System Setting) Optional parameters: p1 – 1=display image 250% larger |
| OBJ.SELECT1 | User defined list in {Object} setup |
| OBJ.SELECT1SHORT | User defined list in {Object} setup |
| OBJ.STATUS | Current status of an {Object} (1-Active, 2-Retired (Deactivated)) |
| OBJ.STATUSNAME | Current status of an {Object} (Active, Retired) |
| OBJ.TREENAME | Name of the {Object} as shown on the TrueChem Tree |
| OBJ.VOLSHORTUNIT | Short name of the volume unit |
| OBJ.VOLUME | Volume of {Object} |
| OBJ.VOLUNIT | Name of the volume unit |
Result Variables – A test may contain multiple result items. To specify a specific result item, you must include the item number associated with the result. If no item number is specified, TrueChem will use the current result item. Example: [RST4.VALUE] will return the value of result item number 4.
| Name | Description |
| RST.CALC | Calculation or script text |
| RST.CP | Calculated Cp of results |
| RST.CPK | Calculated Cpk of results |
| RST.CURRENTVALUE | The current or previous result value |
| RST.DELTA | Difference between current test value and previous test value |
| RST.DESCP | Description of the result |
| RST.DISPLAYVALUE | Displayed value of result item (set by a rule action) |
| RST.ESTSTDDEV | Estimated standard deviation of results |
| RST.FIELDn | Result Optional n field (n = 3 to 12) |
| RST.GAUGE | Gauge defined for result item |
| RST.ID | Unique ID number |
| RST.LCL | Lower control limit of result |
| RST.LSL | Lower spec limit |
| RST.MCL | Middle control limit |
| RST.MEAN | Calculated Mean of results |
| RST.NAME | Description of the result |
| RST.NOTES | Notes assigned by a rule that are directly associated with the result item |
| RST.NUM | Result number |
| RSTn.OBJm | Result’s universal variable, where n is the RST item number (1-99) within the Object and m is the unique internal Object ID. When this variable is referenced anywhere in TrueChem it will provide the current value of the referenced Result parameter. A Result’s universal variable can be found on the Advanced options dialog of Modify Test Item in Object Setup. |
| RST.OPT | Optimum spec limit |
| RST.PERCENTCHANGE | Variance, in absolute decimal percent (0.20 = 20%) of the current value of the result compared to the previous value of result. Example, current value = 108, previous value = 100, [RST.PercentChange] = 0.08 |
| RST.PP | Calculated Pp of results |
| RST.PPK | Calculated Ppk of results |
| RST.PREV | Previous result used in trending (x out of the last y) as this variable provides regression by always comparing the two successive values |
| RST.PREVVALUE | Previous result value |
| RST.RLL | Range lower limit |
| RST.RML | Range middle limit |
| RST.RUL | Range upper limit |
| RST.SCHEDFREQLEVEL | See [RST.SCHEDULEFREQUENCYLEVEL] |
| RST.SCHEDULEFREQUENCYLEVEL | Frequency level of the result (Normal, Accelerated, Decelerated) |
| RST.SCHEDULESTATUS | Schedule status of the result (Deactivated, Due, Late, Not Due, Not Scheduled) |
| RST.SHORT | Short description of the result |
| RST.SPCPOINTS | Number of points used for SPC calculations |
| RST.STDDEV | Standard deviation of results |
| RST.TREND(#) | Returns 1 if trend (up or down) is detected, 0 otherwise. Replace # with number of points to include in trend analysis (more info) |
| RST.TRENDDOWN(#) | Returns 1 if downward trend is detected, 0 otherwise. Replace # with number of points to include in trend analysis (more info) |
| RST.TRENDSAWTOOTH(#) | Returns 1 if sawtooth trend (…>, <, >, <, etc) is detected, 0 otherwise. Replace # with number of points to include in trend analysis (more info) |
| RST.TRENDUP(#) | Returns 1 if upward trend is detected, 0 otherwise. Replace # with number of points to include in trend analysis (more info) |
| RST.UCL | Upper control limit of result |
| RST.USER1LOWER | Lower other 1 limit |
| RST.USER1UPPER | Upper other 1 limit |
| RST.USER2LOWER | Lower other 2 limit |
| RST.USER2UPPER | Upper other 2 limit |
| RST.USL | Upper spec limit |
| RST.VALUE | Calculated value of the result |
| RST.VOLUMEADJUSTED | Returns current value of the result adjusted for volume differences |
Run Variables – Run variables are used to perform tasks within a script or calculation.
| Name | Description |
| RUN.CALC(C) | Returns the result of a simple one line calculation. Replace C with the calculation to be evaluated |
| RUN.LIB(L) | Returns the result of a library script. Replace L with the ID or Description of the library script to be evaluated |
| RUN.SCRIPT(S) | Executes a simple script and can return a value if script contains “result=”. Replace S with the script to be executed |
Schedule Variables – Schedule variables are used to obtain data related to a scheduled item when sending emails or other notifications. NOTE: These variables are invalid in other areas of TrueChem.
| Name | Description |
| SCH.ALLOTTEDTIME | The allotted time of the schedule |
| SCH.DESCP | The name of the scheduled item |
| SCH.ENDDATETIME | The end date and time of the schedule |
| SCH.FREQDESCP | The schedule frequency |
| SCH.LASTDONE | The date and time the schedule was last done |
| SCH.MISSED | The number of times the schedule has been missed |
| SCH.NAME | The name of the scheduled item |
| SCH.PRIORITY | the priority of the schedule |
| SCH.STARTDATETIME | The start date and time of the schedule |
NOTE: The following variables are also valid schedule variables: [DATE], [TIME], [OBJ.NAME], [OBJ.DESCP], [OBJ.LOCATION], [GRP.NAME], [GRP.DESCP] and all Name variables.
System Variables
| Name | Description |
| SYS.APPPATH | Path to TrueChem.exe |
| SYS.DATAPATH | Path to TrueChem database or database connection file |
| SYS.TEMPPATH | Path to TrueChem temporary directory |
Test Variables – Test variables are used when performing a test.
| Name | Description |
| TST.DATE | Primary test date |
| TST.DATE1 | Primary test date |
| TST.DATE2 | Secondary test date |
| TST.ELAPSEDDATE1 | Number of minutes between the current value of Date1 and the last saved value of Date1 |
| TST.ELAPSEDDATE2 | Number of minutes between the current value of Date2 and the last saved value of Date2 |
| TST.ELAPSEDDATE3 | Number of minutes between the current time and the last saved test |
| TST.ID | Unique ID number |
| TST.NOTES | Current test notes |
| TST.PARTIAL | Current test partial remake percentage (as a decimal) |
| TST.PARTIALAMOUNT | Current test partial remake amount in the Object’s Volume Unit |
| TST.REMAKE | Current test remake (returns “True” or “False”) |
| TST.REPORTHTML | HTML of the current Test Report |
| TST.REPORTID | Current Test Report ID |
| TST.SAMPLEDATE | Sample date and time |
| TST.SAMPLEFIELDn | Sample Optional n field (n = 1 to 12) |
| TST.SAMPLENOTES | Sample notes |
| TST.SAMPLENUMBER | Sample number |
| TST.SAMPLERECVDATE | Date and time sample was received |
| TST.TIME | Current test time |
| TST.TIME1 | Current test time 1 |
| TST.TIME2 | Current test time 2 |
| TST.DATETIME1 | Current test data time 1 |
| TST.DATETIME2 | Current test data time 2 |
User Variables – User variables are used to access information of the user who is currently logged on to TrueChem.
| Name | Description |
| USR.ADDR | The current users address |
| USR.DEPT | The current users department |
| USR.EMAIL | The current users Email address |
| USR.EXT | The current users extension |
| USR.FAX | The current users Fax number |
| USR.FIELDn | The current users Optional n field (n = 3 to 12) |
| USR.FNAME | The current users first name |
| USR.ID | The current users user ID |
| USR.LNAME | The current users last name |
| USR.NAME | The current users first and last name |
| USR.PHONE | The current uses phone |
| USR.TITLE | The current users Title |
User-Defined Variables – User defined variables are used to store and retrieve information.
| Name | Description |
| VAR.GET(NAME) | Replace NAME with the name of the variable. Returns the current value for the user defined variables or “” (blank) if variable has expired |
| VAR.NAME | Replace NAME with the name of the variable. Returns the current value for the user defined variables or “” (blank) if variable has expired (same as VAR.GET(NAME)) |
| VAR.NAME=VALUE | Replace NAME with the name of the variable and VALUE with the value to store. Sets the value of the user defined variable (same as VAR.PUT(NAME=VALUE)) |
| VAR.PUT(NAME=VALUE) | Replace NAME with the name of the variable and VALUE with the value to store. Sets the value of the user defined variable |
Variable Defaults – Placing a : (colon) character after the variable name followed by a default value allows you to specify what is returned if the variable does not have a value -or- is not currently in context. NOTE: this is done within the square brackets [ ]
This can prevent a syntax error in a formula or Rule resulting from trying to use a variable that has no current value.
EXAMPLE: If you try to use [RST.LSL] in a Rule applied to a Result where no Lower Spec Limit (LSL) is defined, TrueChem would not know what to do as the variable reference would return “UNKOWN”. However, if you use [RST.LSL:0] instead, you would get a value of 0 returned in this circumstance.
Following is a list of some special default characters you can use.
| Character | Description |
| + | Plus Sign. This returns the default value equal to the highest positive number the workstation can generate. |
| – | Minus Sign. When used alone this returns the default value equal to the lowest negative number the workstation can generate. When used with a number, causes the returned value to be negative. |
| 0-9 . – | Numbers. Using any valid combination of digits 0-9, negative sign and decimal placeholder will allow for any numerical value to be used as a default. |
Variable Formatting – Placing a | (known as vertical bar -or- pipe) character after the variable name followed by a format code will allow you to specify the format of the value returned. NOTE: this is done within the square brackets [ ]
EXAMPLE: [RST.VALUE|#,##0.000] will return the value of the current Result in the format code described as #,##0.000 Using this format, a numerical value of .27 would return as 0.270 -or- a value of 6829 would return as 6,829.000
Following is a brief list of format code characters available for use.
| Character | Description |
| 0 | Digit placeholder. If the number has less digits than 0’s in the format code the insignificant digits are displayed. |
| # | Digit placeholder. If the number has less digits than #’s in the format code the insignificant digits are NOT displayed. |
| . | Decimal point. Determines the decimal place. |
| , | Thousand separator and number scaling. Placing the , between two digit placeholders to the left of the decimal acts as a separator. Placing the , immediately to the left of the decimal point in the format code will cause the value to be divided “scaled” by 1000. |
| % | Percentage indicator. Value will be multiplied by 100 with the % displayed in the position specified in the format code. |
| $_+-() | Literal characters. Displayed as literals in the position they appear the format code. |
Working with Units – When using variables with a unit parameter, such as Adjustment amounts, using a unit’s short name will specify which unit to return the value in. Using the variable with no unit parameter will return the value in the unit defined on the setup of the item.
For example, the following variables will work correctly:
[ADJ.VALUE] :: returns the adjustment value in the unit defined in the setup
[ADJ.VALUE(gal)] :: returns the adjustment value converted to gallons
[ADJ.VALUE(lt)] :: returns the adjustment value converted to liters
[ADJ.VALUE(ml)] :: returns the adjustment value converted to milliliters
[ADJ.ACCUM(gal)] :: returns the accumulated adjustment value converted to gallons
[ADJ.ACCUM(lt)] :: returns the accumulated adjustment value converted to liters
[ADJ.ACCUM(ml)] :: returns the accumulated adjustment value converted to milliliters
The following examples will NOT work:
[ADJ.VALUE(gallons)] :: uses unit long name instead of short name
[ADJ.VALUE (lt) ] :: space prior to first “(”
[ADJ.VALUE ml] :: missing parentheses around unit short name
Use the tables below to help identify a unit’s short name. NOTE: You cannot convert units between tables.
Volume
| barrel Fluid | bbl |
| cubic centimeter | cc |
| cubic foot | f3 |
| cubic inch | in3 |
| cubic kilometer | km3 |
| cubic millimeter | mm3 |
| cup | c |
| drop | gtt |
| gallon | gal |
| imperial gallon | imp gal |
| liter | lt |
| fluid ounce | floz |
| pint | pt |
| quart | qt |
| tablespoon | tbsp |
| teaspoon | tsp |
| milliliter | ml |
| cubic meters | m3 |
| cubic yard | yd3 |
Mass
| grain | gr |
| gram | g |
| kilogram | kg |
| milligram | mg |
| ounce | oz |
| troy ounce | troz |
| pound | lb |
Length
| centimeter | cm |
| foot | ft |
| inch | in |
| kilometer | km |
| meter | m |
| millimeter | mm |
| yard | yd |
| Micron | u |
Time
| day | d |
| hour | hr |
| minute | min |
| month | mon |
| second | sec |
| year | yr |
Current
| ampere hour | A h |
Speed
| miles per hour | mph |
| feet per minute | fpm |
| feet per second | fps |
| kilometer per hour | km/h |
| meters per second | mps |
| meters per minute | mpm |
Temperature
| British thermal unit | Btu |
Proportion
| Molarity | Mol |
| molality | mo |
| normality | N |
| part per million | ppm |
| percent | % |
Area
| square centimeter | cm2 |
| square foot | f2 |
| square inch | in2 |
| square kilometer | km2 |
| square mile | mi2 |
| square millimeter | mm2 |
| square yard | y2 |
| square Meter | m2 |
Revision 4.6.309