{"id":2264,"date":"2020-02-10T11:24:20","date_gmt":"2020-02-10T19:24:20","guid":{"rendered":"https:\/\/portal.staylinked.com\/sl\/kb\/?post_type=ht_kb&#038;p=2264"},"modified":"2026-02-12T14:28:23","modified_gmt":"2026-02-12T22:28:23","slug":"special-scripting-mnemonics","status":"publish","type":"ht_kb","link":"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/special-scripting-mnemonics\/","title":{"rendered":"Administrator User Guide &#8211; Special Scripting Mnemonics"},"content":{"rendered":"\n<p>Here are some scripting mnemonics that are available for special\nuse:<\/p>\n\n\n\n<p><strong>[devicename]<\/strong> \u2013\nThis script mnemonic is used to substitute the device name into the script.<\/p>\n\n\n\n<p><strong>[deviceip]<\/strong> \u2013 This\nscript mnemonic is used to substitute the device IP into the script.<\/p>\n\n\n\n<p><strong>[devicemac]<\/strong> \u2013\nThis script mnemonic is used to substitute the device MAC address into the\nscript.<\/p>\n\n\n\n<p><strong>[hex ######]<\/strong> \u2013 This script mnemonic is used to substitute Hexadecimal values into the script.<\/p>\n\n\n\n<p><strong>[esc]<\/strong> \u2013 This script mnemonic is used to substitute an escape key. This cannot be part of a string but the [hex 1B] is usable in any location and performs the same function. Server build 214 now also supports [ESC].<\/p>\n\n\n\n<p><strong>[space]<\/strong> \u2013 This script mnemonic is used to substitute a space key. This mnemonic is not usable in all string locations. Primary included as an assumed mnemonic to work in common locations. The [hex 20] is usable in any location and performs the same function.<\/p>\n\n\n\n<p><strong>[uni ####]<\/strong> \u2013 This\nscript mnemonic is used to substitute Unicode values into the script.<\/p>\n\n\n\n<p><strong>[var ##]<\/strong> \u2013 This\nscript mnemonic is used to substitute \u2018User Defined Variables\u2019 into the script.<\/p>\n\n\n\n<p><strong>[delay]<\/strong> \u2013 This\nscript mnemonic is used to insert a 1\/10 second delay into the startup script.<\/p>\n\n\n\n<p><strong>[long_delay]<\/strong> \u2013\nThis script mnemonic is used to insert a 1 second delay into the startup\nscript.<\/p>\n\n\n\n<p><strong>[userid]<\/strong> \u2013 This\nscript mnemonic is used to insert \u2018device identifier\u2019 value into the startup\nscript.<\/p>\n\n\n\n<p><strong>[deviceid]<\/strong> \u2013 This\nscript mnemonic is used to insert the PPC\/CE.Net Device Name into the script.\nFor all Version 9.1 clients, you can specify a \u2018Device ID\u2019 value in the\nStayLinked Client\u2019s configuration dialog. Or, you can use \u2018Client Settings\u2019 to\nassign a \u2018Device ID\u2019 value to individual devices. For older PPC\/CE clients, you\ncan specify the \u2018Device ID\u2019 in the operating system configuration. For CE.Net\ndevices, this value is configured at the \u2018Start \u2013 Settings &#8211; Control Panel &#8211;\nSystem &#8211; Device Name Tab \u2013 Device Name\u2019 dialog. For PPC devices, this value is\nconfigured at the \u2018Start \u2013 Settings \u2013 System Tab \u2013 About \u2013 Device ID Tab \u2013\nDevice Name\u2019 dialog. For DOS devices, this value is managed using the Device\nSettings file (STAYLINK.INI) and the \u2018device_id\u2019 setting.<\/p>\n\n\n\n<p><strong>[devicetype]<\/strong> \u2013\nThis script mnemonic is used to insert the StayLinked Client Device Type value\ninto the script.<\/p>\n\n\n\n<p><strong>[encrypt #,%%]<\/strong> \u2013\nThis scripting mnemonic is used to cause scripted text to be encrypted in the\nconfiguration files. There are two arguments provided to this mnemonic, the\nfirst is a unique sequence number and the second is the text to be encrypted.\nAn example would be the use of a 5250 logon sequence in a \u2018Startup Script\u2019. In\nthis case, your script for logon could be entered like this:<\/p>\n\n\n\n<p>[encrypt\n1,myuserid][fldext][encrypt 2,mypassword][enter]<\/p>\n\n\n\n<p>The text enclosed in the [encrypt #,%%] mnemonic will be\nstored in the configuration files in an encrypted format and will no longer be\ndisplayed in clear text in the Administrator user interface.<\/p>\n\n\n\n<p><strong>[cursor row#, col#]<\/strong> \u2013 This script mnemonic is used to move the current telnet cursor location to a specific row and column. This scripting mnemonic is used for both VOICE input processing and for Screen Reformatting input processing.<\/p>\n\n\n\n<p><strong>[button_row]<\/strong> \u2013 Starting in v15.2, this script mnemonic returns the row when a graphical button is placed for dynamic tap spot collections, allowing the substitution of the telnet screen row as a number in other mnemonics or scripts where this mnemonic is used.<\/p>\n\n\n\n<p><strong>[hostentry]<\/strong> \u2013 Starting in v15.2, this script mnemonic returns the name of the host entry in scripting.<\/p>\n\n\n\n<p><strong>[inputloc row#, col#]<\/strong>\n\u2013 This script mnemonic is used to the next user input to be targeted to a\nspecific row and column. This scripting mnemonic is used for Screen Reformatting\ninput processing.<\/p>\n\n\n\n<p><strong>[wait] <\/strong>\u2013 This script\nmnemonic is used for VT emulation to cause the processing to wait for the next\ntelnet screen presentation event to occur before continuing with further script\nprocessing.<\/p>\n\n\n\n<p><strong>[send] <\/strong>\u2013 This\nscript mnemonic is used for VT emulation to force the current script segment to\nbe sent to the host immediately.<br><\/p>\n\n\n\n<p><strong>Scripting Mnemonic\nExamples:<\/strong><\/p>\n\n\n\n<p>The mnemonic [hex 0D] will insert\nan ASCII CR (Carriage Return) into the script.<\/p>\n\n\n\n<p>If you need to include any square\nbrackets in your script, you should include two of them.<\/p>\n\n\n\n<p>The mnemonic [hex 1B5B5B32347E] is\nthe equivalent of \u2018ESC[24~\u2019 or the VT F12 key.<\/p>\n\n\n\n<p>This script \u2018[hex 1B][[24~\u2019 is\nalso the equivalent of \u2018ESC[24~\u2019 or the VT F12 key.<\/p>\n\n\n\n<p><strong>These special\nscripting mnemonics are available for the following StayLinked Features:<\/strong><\/p>\n\n\n\n<p><strong>VT Telnet Host Property \u2013 ANSWER BACK MESSAGE<\/strong><\/p>\n\n\n\n<p>[devicename], [deviceip], [devicemac], [hex ##], [uni ####], [userid], [deviceid], [devicetype] <\/p>\n\n\n\n<p><strong>Telnet Host and Device Group Startup Scripts<\/strong><\/p>\n\n\n\n<p>[devicename], [deviceip], [devicemac], [hex ##], [uni ####], [var ##], [delay], [long_delay], [userid], [deviceid], [devicetype], [encrypt #,%%] <\/p>\n\n\n\n<p><strong>Keyboard Mappings<\/strong><\/p>\n\n\n\n<p>[devicename], [deviceip], [devicemac], [hex ##], [uni ####], [var ##], [userid], [deviceid], [devicetype], [encrypt #,%%], [screen_map] <\/p>\n\n\n\n<p><strong>Tap Spot Collections<\/strong><\/p>\n\n\n\n<p>[devicename], [deviceip], [devicemac], [hex ##], [uni ####], [var ##], [userid], [deviceid], [devicetype], [screen_map] <\/p>\n\n\n\n<p><strong>Barcode Prefix and Suffix, Printing Completion and Cancellation Actions<\/strong><\/p>\n\n\n\n<p>[hex ##], [uni ####], [var ##], [delay]<\/p>\n\n\n\n<p><strong>5250 Device Name Prefix (Device Groups)<\/strong><\/p>\n\n\n\n<p>NULL, [deviceid]<\/p>\n\n\n\n<p><strong>VOICE input commands<\/strong><\/p>\n\n\n\n<p>[cursor row#, col#]<\/p>\n\n\n\n<p><strong>Screen Recognition Auto-Responses<\/strong><\/p>\n\n\n\n<p>[devicename], [deviceip], [devicemac], [hex ##], [uni ####], [userid], [deviceid], [devicetype], [encrypt #,%%], [wait], [send], [regexgroup #]. Added in v16.2 [regexgroup next]<\/p>\n\n\n\n<p><strong>Screen Recognition and Reformatting Regular Expression Input Modifiers<\/strong><\/p>\n\n\n\n<p>[cursor row#, col#], [inputloc\nrow#, col#]<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Here are some scripting mnemonics that are available for special use: [devicename] \u2013 This script mnemonic is used to substitute the device name into the script. [deviceip] \u2013 This script mnemonic is used to substitute the device IP into the script. [devicemac] \u2013 This script mnemonic is used to substitute&#8230;<\/p>\n","protected":false},"author":7,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":[],"ht-kb-category":[23],"ht-kb-tag":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v16.5 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Administrator User Guide - Special Scripting Mnemonics &ndash; StayLinked<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.staylinked.com\/knowledge-base\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Administrator User Guide - Special Scripting Mnemonics &ndash; StayLinked\" \/>\n<meta property=\"og:description\" content=\"Here are some scripting mnemonics that are available for special use: [devicename] \u2013 This script mnemonic is used to substitute the device name into the script. [deviceip] \u2013 This script mnemonic is used to substitute the device IP into the script. [devicemac] \u2013 This script mnemonic is used to substitute...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/special-scripting-mnemonics\/\" \/>\n<meta property=\"og:site_name\" content=\"StayLinked\" \/>\n<meta property=\"article:modified_time\" content=\"2026-02-12T22:28:23+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"4 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebSite\",\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/#website\",\"url\":\"https:\/\/portal.staylinked.com\/sl\/kb\/\",\"name\":\"StayLinked Knowledge Base\",\"description\":\"Partner Portal Resources and Support\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":\"https:\/\/portal.staylinked.com\/sl\/kb\/?s={search_term_string}\",\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/special-scripting-mnemonics\/#webpage\",\"url\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/special-scripting-mnemonics\/\",\"name\":\"Administrator User Guide - Special Scripting Mnemonics &ndash; StayLinked\",\"isPartOf\":{\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/#website\"},\"datePublished\":\"2020-02-10T19:24:20+00:00\",\"dateModified\":\"2026-02-12T22:28:23+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/special-scripting-mnemonics\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/special-scripting-mnemonics\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/special-scripting-mnemonics\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/portal.staylinked.com\/sl\/kb\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Articles\",\"item\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Administrator User Guide &#8211; Special Scripting Mnemonics\"}]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","_links":{"self":[{"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb\/2264"}],"collection":[{"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb"}],"about":[{"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/users\/7"}],"replies":[{"embeddable":true,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/comments?post=2264"}],"version-history":[{"count":4,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb\/2264\/revisions"}],"predecessor-version":[{"id":5889,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb\/2264\/revisions\/5889"}],"wp:attachment":[{"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/media?parent=2264"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb-category?post=2264"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb-tag?post=2264"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}