{"id":1632,"date":"2019-10-02T11:01:19","date_gmt":"2019-10-02T18:01:19","guid":{"rendered":"https:\/\/portal.staylinked.com\/sl\/kb\/?post_type=ht_kb&p=1632"},"modified":"2022-04-13T09:29:47","modified_gmt":"2022-04-13T16:29:47","slug":"regular-expressions","status":"publish","type":"ht_kb","link":"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/regular-expressions\/","title":{"rendered":"Regular Expressions"},"content":{"rendered":"\n

Overview<\/h2>\n\n\n\n

This article describes the barcode regular expressions feature that provides a very flexible mechanism by which scanned barcode data can be manipulated by the StayLinked Server before that data is entered into the Telnet Session. StayLinked has always provided barcode data manipulation capabilities, but the barcode regular expression feature provides the ultimate flexibility and capability to manipulate scanned barcode data. <\/p>\n\n\n\n

What are Regular Expressions?<\/h2>\n\n\n\n

Regular expressions provide the ability to describe and identify specific patterns of words or characters in strings of text. In the StayLinked context, the strings of text are the data in the scanned barcodes. Using regular expressions, you can describe a pattern to match the text in scanned barcode data. The pattern is specified using a pre-defined syntax that is processed by the Java-based regular expression parser inside the StayLinked server. If a match is identified, then a replacement string can be processed which is used to manipulate and transform the scanned barcode data into its desired form.<\/p>\n\n\n\n

So, when using regular expressions with StayLinked,\nyou will provide an \u2018Expression\u2019 string which uses regular expression syntax\n(Java \u2013 similar to PERL) to describe a pattern to be matched in the scanned\nbarcode data. You will also provide a \u2018Replacement\u2019 string which describes how\nto manipulate the scanned barcode data and transform that data into the desired\nformat.<\/p>\n\n\n\n

To learn more about regular expressions, we recommend reviewing these resources:
http:\/\/en.wikipedia.org\/wiki\/Regular_expression<\/a>
www.Regex101.com<\/a> <\/p>\n\n\n\n

Composing an \u2018Expression\u2019 to match a pattern in barcode data<\/h2>\n\n\n\n

An \u2018expression\u2019 is a pattern that is composed of simple characters, such as \/123\/<\/strong>, or a combination of simple and special characters, such as \/12*3\/<\/strong> or ^PART(\\d+)$<\/strong>. The last example uses \u2018capturing parentheses\u2019 to identify some of the data in the pattern. The barcode data that matches the part of the pattern inside the \u2018capturing parenthesis\u2019 is stored in memory for later use in the \u2018Replacement\u2019 string.<\/p>\n\n\n\n

Simple Patterns used in an \u2018Expression\u2019<\/h2>\n\n\n\n

Simple patterns are constructed of characters for which you want to find a direct match. For example, the pattern \/BIN\/<\/strong> matches character combinations in barcode data only when exactly the characters \u201cBIN\u201d occur together and in that order. Such a match would succeed in the barcodes \"BIN98654\" and \"LOC55BIN99\". In both cases the match is with the exact characters \u201cBIN\u201d. There is no match found in the barcode data \"BOX55967LOT559\" because it does not contain the exact characters \u201cBIN\u201d.<\/p>\n\n\n\n

Special Characters used in an \u2018Expression\u2019<\/h2>\n\n\n\n

When the search for a matching pattern requires something more than a direct match, such as finding one or more B's, or finding white space, then you can include special characters in the expression. For example, the pattern \/12*3\/ <\/strong>matches any character combination in which a single \u201c1\u201d is followed by zero or more \u201c2\u201ds (* means 0 or more occurrences of the preceding item) and then immediately followed by \u201c3\u201d. In the string \"3221222234523,\" the pattern matches the substring \u201c122223\u201d.<\/p>\n\n\n\n

The following matrix provides a complete list and description of the special characters that can be used in your expressions.<\/p>\n\n\n\n

\"\"<\/figure><\/div>\n\n\n\n
\"\"<\/figure><\/div>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n
\"\"<\/figure>\n\n\n\n

Using Parenthesis to make Capturing Groups<\/h2>\n\n\n\n

The \u2018Expression\u2019 string that you\ncompose has two functions. First, the expression is used to match a pattern of\ncharacters in the scanned barcode data. Second, the expression identifies any\nparts of the scanned barcode data that you want to be included in the\n\u2018Replacement\u2019 string that will ultimately be entered into the telnet session.<\/p>\n\n\n\n

When the scanned barcode data matches an \u2018Expression\u2019, those parts of that barcode data that you want to use in the \u2018Replacement\u2019 string are indicated by those parts of the \u2018Expression\u2019 string that are surrounded by parenthesis to make \u2018capturing groups\u2019. Any scanned barcode data enclosed in a \u2018capturing group\u2019 is remembered in memory and can be referred to in the \u2018Replacement\u2019 string.<\/p>\n\n\n\n

Your \u2018Expression\u2019 can include zero of more of these \u2018capturing groups\u2019. The data identified by the \u2018capturing group\u2019 are stored in memory and are identified sequentially; [1], [2], …, [n]. In your \u2018Replacement\u2019 string, you can refer to these remembered data using $1, $2, \u2026, $n<\/strong> syntax. Also note that in Screen Recognition, 'capturing groups' from previous screens can be used with the mnemonic [regexgroup #], where # is the sequential group as noted above. [regexgroup 0] will clear the previously captured groups from memory.<\/p>\n\n\n\n

For example, the expression ^PART(\\d+)$ <\/strong>matches any scanned barcode data that starts with (^<\/strong>) the text\u00a0 PART<\/strong> and ends with ($<\/strong>) 1 or more numeric digits (\\d+<\/strong>). The numeric digits portion of the expression is enclosed in the \u2018capturing group\u2019 and will be remembered in memory. This remembered data can be referred to in the Replacement string using $1<\/strong>. If the scanned barcode data was PART1234567890,<\/strong> then the expression would match this data and the \u2018capturing group\u2019 would remember the value of\u00a0 1234567890<\/strong>. If the \u2018Replacement\u2019 string were defined as $1<\/strong>, then the result of the regular expression replacement processing would be 1234567890<\/strong> which would be sent to the telnet session. If the \u2018Replacement\u2019 string were defined as ITEM$1<\/strong>, then the scanned barcode data would be transformed into ITEM1234567890<\/strong> which would be sent to the telnet session.<\/p>\n\n\n\n

The following examples show the \u2018Add Regular Expression\u2019 dialog. Using this dialog, you can compose your Expression and Replacement strings. You can even enter Sample Barcode Data to test your individual Regular Expressions in real time.<\/p>\n\n\n\n

\"\"<\/figure><\/div>\n\n\n\n
\"\"<\/figure>\n\n\n\n

Creating and Testing Regular Expressions<\/h2>\n\n\n\n

You can assign barcode rules to either \u2018Device Groups\u2019 or to \u2018Telnet Host Entries\u2019. To specify Regular Expressions for your barcodes, you must add a specific rule for the specific \u2018Barcode Type\u2019 that is being scanned. In this example, we have added a barcode rule to the \u2018Default Device Group\u2019 for the Code 3 of 9 barcode type with any length (Min. and Max. Length equals 0).<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

In this dialog you will find the\n\u2018Regular Expression Processing\u2019 listing which provides the ability to define\nmultiple regular expressions to be processed against the scanned barcode data\nthat meets the criteria defined by this barcode rule. When scanned barcode data\nis received by the server, the barcode rule that most closely matches the\n\u2018Barcode Type\u2019 and the \u2018Min. and Max. Lengths\u2019 will be processed. Within this\nbarcode rule, all of the barcode manipulation functions are processed in dialog\norder, from the top down. So, \u2018Regular Expression Processing\u2019 is applied after\n\u2018Use First ## Digits\u2019 and before \u2018Scan Prefix\u2019 and \u2018Scan Suffix\u2019. Additionally,\nif you define multiple \u2018Regular Expressions\u2019 to be processed, then they are\nprocessed in order and the result of the current expression is used as the data\nfor the following expression. In this way, it is possible that a scanned\nbarcode could be transformed by one or more of the defined regular expressions\nwith the ultimate result being entered into the telnet session.<\/p>\n\n\n\n

Because the \u2018Regular Expressions\u2019 functionality is so powerful and flexible, there is really no need to use any of the other barcode manipulation functions. All of those functions can be accomplished using \u2018Regular Expression Processing\u2019 alone.<\/p>\n\n\n\n

You can right-click in the Regular\nExpression list to access a context menu which provides the following options:<\/p>\n\n\n\n

Add<\/strong> \u2013 Adds a new regular expression to the list.<\/p>\n\n\n\n

Edit<\/strong> \u2013 Edit and test the selected regular expression.<\/p>\n\n\n\n

Copy <\/strong>\u2013 Copy the selected regular expression to the clip-board.<\/p>\n\n\n\n

Paste <\/strong>\u2013 Paste the copied regular expression into a new \u2018Paste\u2019\ndialog.<\/p>\n\n\n\n

Delete <\/strong>\u2013 Delete the selected regular expression.<\/p>\n\n\n\n

Move Up<\/strong> \u2013 Change the order of regular expression processing by\nmoving the selected expression up in the list.<\/p>\n\n\n\n

Move Down<\/strong> \u2013 Change the order of regular expression processing by\nmoving the selected expression down in the list.<\/p>\n\n\n\n

Import <\/strong>\u2013 Import Regular Expressions that were previously exported\ninto a Regex File (*.rgx).<\/p>\n\n\n\n

Export <\/strong>\u2013 Export the currently defined list of Regular Expressions\ninto the desired Regex File (*.rgx).<\/p>\n\n\n\n

Test Expressions <\/strong>\u2013 Opens a testing dialog that will allow you to\ntest various sample scanned barcode data and review the results as that data is\nprocessed by each of the regular expressions in the current order.<\/p>\n\n\n\n

When you add or edit an expression, you will use this dialog:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Expression<\/strong> \u2013 Compose your Expression string in this text box.<\/p>\n\n\n\n

Replacement <\/strong>\u2013 Compose your Replacement string in this text box.<\/p>\n\n\n\n

Sample Barcode Data <\/strong>\u2013 Enter some sample barcode data in this text\nbox.<\/p>\n\n\n\n

Results <\/strong>\u2013 This text box will display the results of the \u2018Expression\u2019 string and the \u2018Replacement\u2019 string after processing against any \u2018Sample Barcode Data\u2019 that you have entered. The \u2018Results\u2019 value is updated in real time as any of the other elements are changed.<\/p>\n\n\n\n

When you select the \u2018Test Expressions\u2019 option, you will be presented with this dialog:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

This dialog will display the\ncurrently defined Regular Expressions. The Expression and Replacement strings\nwill be displayed in their respective columns. As you type in some sample\nbarcode data, the Data and Result columns will be updated in real time.<\/p>\n\n\n\n

It is important to remember that multiple regular expressions are processed in order with the result of the current expression used as the data for the next expression. In the example above, you can see that the sample barcode data was transformed by the first regular expression and the result became the data for the next regular expression. But, the next regular expression had no effect on that data because there was no pattern match.<\/p>\n\n\n\n

Examples of Regular Expressions<\/h2>\n\n\n\n

Following are several examples of Regular Expressions used to transform scanned barcode data for some common uses:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

This regular expression removes the\nlast character from any alpha-numeric barcode data of at least one character.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

This regular expression removes the first and the last character from any alpha-numeric barcode data of at least two characters.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

This regular expression removes\nall white space from the scanned barcode data.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

This regular expression will provide only the first five characters of scanned barcode data of any length.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

This regular expression will replace every occurrence of an asterisk (*) with an upper-case X.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

This regular expression will replace every occurrence of the word PART with the word ITEM.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

This regular expression will match\na barcode that starts with ]C1229<\/strong> followed by a group of five digits\n($1) followed by a 3 followed by a group of 6 digits ($2) followed by a group\nof 5 to 10 digits ($3) and ending with any one digit. The returned value will\nbe the group of 5 to 10 digits ($3).<\/p>\n","protected":false},"excerpt":{"rendered":"

Overview This article describes the barcode regular expressions feature that provides a very flexible mechanism by which scanned barcode data can be manipulated by the StayLinked Server before that data is entered into the Telnet Session. StayLinked has always provided barcode data manipulation capabilities, but the barcode regular expression feature…<\/p>\n","protected":false},"author":7,"comment_status":"open","ping_status":"closed","template":"","format":"standard","meta":[],"ht-kb-category":[],"ht-kb-tag":[],"yoast_head":"\nRegular Expressions – 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=\"Regular Expressions – StayLinked\" \/>\n<meta property=\"og:description\" content=\"Overview This article describes the barcode regular expressions feature that provides a very flexible mechanism by which scanned barcode data can be manipulated by the StayLinked Server before that data is entered into the Telnet Session. StayLinked has always provided barcode data manipulation capabilities, but the barcode regular expression feature...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/regular-expressions\/\" \/>\n<meta property=\"og:site_name\" content=\"StayLinked\" \/>\n<meta property=\"article:modified_time\" content=\"2022-04-13T16:29:47+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2019\/10\/RegularExpressions_1.1.jpg\" \/>\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=\"11 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\":\"ImageObject\",\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/regular-expressions\/#primaryimage\",\"inLanguage\":\"en-US\",\"url\":\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2019\/10\/RegularExpressions_1.1.jpg\",\"contentUrl\":\"https:\/\/portal.staylinked.com\/sl\/kb\/wp-content\/uploads\/2019\/10\/RegularExpressions_1.1.jpg\",\"width\":915,\"height\":479},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/regular-expressions\/#webpage\",\"url\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/regular-expressions\/\",\"name\":\"Regular Expressions – StayLinked\",\"isPartOf\":{\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/regular-expressions\/#primaryimage\"},\"datePublished\":\"2019-10-02T18:01:19+00:00\",\"dateModified\":\"2022-04-13T16:29:47+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/regular-expressions\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/regular-expressions\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/portal.staylinked.com\/sl\/kb\/knowledge-base\/regular-expressions\/#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\":\"Regular Expressions\"}]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","_links":{"self":[{"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb\/1632"}],"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=1632"}],"version-history":[{"count":2,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb\/1632\/revisions"}],"predecessor-version":[{"id":3969,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb\/1632\/revisions\/3969"}],"wp:attachment":[{"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/media?parent=1632"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb-category?post=1632"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/portal.staylinked.com\/sl\/kb\/wp-json\/wp\/v2\/ht-kb-tag?post=1632"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}