Difference between revisions of "WireCAD Online Help:SysName Format"

From WireCAD Online Help
Jump to: navigation, search
 
(15 intermediate revisions by the same user not shown)
Line 22: Line 22:
  
  
−
{{note|WireCAD supports multiple formats in the same database. In order to accomplish this we use the simplified Regex as a mask. If you have any data in the Project Systems table and you change ANYTHING in ANY Format field you will change the mask and therefore the sequence. You must decide if the change is such that it warrants copying the new simplified Regex to all records in the Project Systems table in order to keep your sequence.}}
+
{{warning|WireCAD supports multiple formats in the same database. In order to accomplish this we use the simplified Regex as a mask. If you have any data in the Project Systems table and you change ANYTHING in ANY Format field you will change the mask and therefore the sequence. You must decide if the change is such that it warrants copying the new simplified Regex to all records in the Project Systems table in order to keep your sequence.}}
  
 
   
 
   
Line 32: Line 32:
 
! Setting/Control  !! Explanation/Description
 
! Setting/Control  !! Explanation/Description
 
|-
 
|-
−
| '''Selected Format'''|| Selects the current SysName format. Clicking the + or - button allows you to add and remove custom SysName Formats
+
| '''Selected Format'''|| Selects the current SysName format. Clicking the + or - button allows you to add and remove custom SysName Formats[[File:Sysfmt1.png|thumb|Select SysName Format]]
 
|-
 
|-
−
| '''Variable List'''|| Displays the sequence of variables in grid view that will be concatenated into the final SysName.
+
|'''Input String/Looks Like'''|| WireCAD uses a fixed set of constants to test your custom format. All of the constants are upper case. The Input String provides a string to which the selected format is applied. The '''Looks Like''' label shows the input string with the formatting applied.[[File:Sysfmt3.png|thumb|Select SysName Format]]
 
|-
 
|-
−
| Example || Example
+
|'''Advanced Regular Expression Info(geek stuff)'''|| This collapsible panel displays the complex and simplified REGEX. The simplified REGEX is associated with every SysName that is created under this format. This allows us to have multiple sequences working in the same table. As noted above: even minor changes in the simplified REGEX will change the sequence.[[File:Sysfmt4.png|thumb|SysName Format]]
 
|-
 
|-
−
| Example || Example
+
| '''Regex Examples'''||Some examples that you can cut/paste into the format field.
 
|-
 
|-
−
| Example || Example
+
| '''Variable List'''|| Displays the sequence of variables in grid view that will be concatenated into the final SysName.[[File:Sysfmt2.png|thumb|Select SysName Format]]
 
|-
 
|-
−
| Example || Example
+
| '''Field''' || The variable to concatenate into the output string.[[File:Sysfmt6.png|thumb|SysName Format]]
 
|-
 
|-
−
| Example || Example
+
| '''Sequence On'''|| Applies to Numeric/Alpha Sequences. Sets the variable that the sequences is associated to.[[File:Sysfmt4.png|thumb|Select SysName Format]]
 
|-
 
|-
−
| Example || Example
+
|''' Format''' || The REGEX for all fields except the STRING variable. The STRING variable uses the literal string value of the format field.[[File:Sysfmt5.png|thumb|SysName Format]]
 
|-
 
|-
−
| Example || Example
+
| '''Order''' || the variable's order in the list.
 
|-
 
|-
−
| Example || Example
+
| '''[UP]/[DN]'''|| Move the selected record up or down in the list.
−
|}
+
|-
−
 
+
| '''Test Syntax'''|| Tests the syntax. This tool has so many possibilities that it is possible that the '''[Test Syntax]''' function may not find all errors.
−
 
+
−
 
+
−
 
+
−
 
+
−
 
+
−
 
+
−
 
+
  
 +
|}
  
 
== Available Variables ==
 
== Available Variables ==
  
 +
{| class="wikitable" style=" background-color:#ffffcc;" cellpadding="10" cellspacing="0"; border="1"; width="100%"
 +
|-
 +
! Variable  !! Description !! Sequencable  !! Default Format REGEX
 +
|-
 +
| '''MANUFACTURER'''|| The Manufacturer Name from the global Manufacturers database||X||\w{1,6}
 +
|-
 +
| '''EQUIPMENTNAME'''|| Equipment Name/PN/Model Number||X||\w{1,6}
 +
|-
 +
| '''DESCRIPTION'''|| The device description as contained in the global equipment library||X||\w{1,6}
 +
|-
 +
| '''EQUIPMENTTYPE'''|| The Equipment Type as contained in the global equipment library||X||\w{1,6}
 +
|-
 +
| '''LOCATION'''|| The location typed in the SysName edit dialog.||X||\w{1,6}
 +
|-
 +
| '''ELEVATION'''|| The elevation typed in the SysName edit dialog||X||\w{1,5}
 +
|-
 +
| '''STRING'''|| any string (usually used for delimiters like dashes (-))||||any string (usually used for delimiters like dashes (-))
 +
|-
 +
| '''ALPHASEQUENCE'''|| an alpha sequence that starts at the letter 'a'||X||\w{4}
 +
|-
 +
| '''NUMERICSEQUENCE'''|| a numeric sequence that starts with the project starting number||X||\d{1,5}
 +
|-
 +
| '''USER1'''|| the global equipment library device definition user1 field||X||\w{1,6}
 +
|-
 +
| '''USER2'''|| the global equipment library device definition user2 field||X||\w{1,6}
 +
|-
 +
| '''USER3'''|| the global equipment library device definition user3 field||X||\w{1,6}
 +
|-
 +
| '''USER4'''|| the global equipment library device definition user4 field||X||\w{1,6}
  
 +
|}
 
   
 
   
−
 
−
Variable
 
−
Description
 
−
Sequencable
 
−
Default Format (regex)
 
−
MANUFACTURER
 
−
Manufacturer Name
 
−
X
 
−
\w{1,6}
 
−
EQUIPMENTNAME
 
−
Equipment Name/PN/Model Number
 
−
X
 
−
\w{1,6}
 
−
DESCRIPTION
 
−
The device description as contained in the global equipment library
 
−
X
 
−
\w{1,6}
 
−
EQUIPMENTTYPE
 
−
The Equipment Type as contained in the global equipment library
 
−
X
 
−
\w{1,6}
 
−
LOCATION
 
−
The location typed in the SysName edit dialog
 
−
X
 
−
\w{1,6}
 
−
ELEVATION
 
−
The location typed in the SysName edit dialog
 
−
X
 
−
\w{1,6}
 
−
STRING
 
−
any string (usually used for delimiters like dashes (-))
 
  
−
-
 
−
NUMERICSEQUENCE
 
−
a numeric sequence that starts with the project starting number
 
−
 
−
\d{1,5}
 
−
ALPHASEQUENCE
 
−
an alpha sequence that starts at the letter 'a'
 
−
 
−
\w{4}
 
−
USER1
 
−
the global equipment library device definition user1 field
 
−
 
−
\w{1,6}
 
−
USER2
 
−
"
 
−
 
−
\w{1,6}
 
−
USER3
 
−
"
 
−
 
−
\w{1,6}
 
−
USER4
 
−
"
 
−
 
−
\w{1,6}
 
−
SeqOn
 
−
This variable should sequence on another variable's value.
 
−
 
−
Order
 
−
The order in the list of the variable
 
−
 
−
 
  
 
== More About Regex ==
 
== More About Regex ==
−
 
−
 
 
The Format field uses regular expressions. The following are some simple examples:
 
The Format field uses regular expressions. The following are some simple examples:
−
\w{1,6}                       Any non number, non punctuation string from 1 to 6 characters
+
{| class="wikitable" style=" background-color:#ffffcc;" cellpadding="10" cellspacing="0"; border="1"; width="100%"
−
\w*                               Any non number, non punctuation string any length
+
|-
−
[a-zA-Z0-9]{5}               Lower / Upper case and 0 thru 9 exactly 5 characters
+
! Expression!! Description
−
\d{1,5}                       Digits 1 to 5 digits in length
+
|-\w{1,6}     ||Any non number, non punctuation string from 1 to 6 characters
−
\d*                               Digits any length
+
|-
−
\\                                a slash "\". The \ is the escape character so you need two
+
|\w*         ||Any non number, non punctuation string any length
−
-                               a dash except when in [] or {} then a range.
+
|-
−
[a-zA-Z0-9_\-\,]{1,4}       Lower / Upper case, 0-9, underscore, dash, and comma.
+
|[a-zA-Z0-9]{5} ||Lower / Upper case and 0 thru 9 exactly 5 characters
 +
|-
 +
|\d{1,5} ||Digits 1 to 5 digits in length
 +
|-
 +
|\d*||Digits any length
 +
|-
 +
|\\||                               a slash "\". The \ is the escape character so you need two
 +
|-
 +
|-"-" ||                              a dash except when in [] or {} then a range.
 +
|-
 +
|[a-zA-Z0-9_\-\,]{1,4} ||      Lower / Upper case, 0-9, underscore, dash, and comma.
 +
|}

Latest revision as of 18:57, 2 January 2011

Command Line Shortcut: fsys

User Permissions Level: sysNameFormatMasterCollection - AllowAddNew/AllowEdit/AllowDelete
Product Level: XLT,PRO,ENT
Allows control of the SysName numbering scheme. Using the SysName Format dialog you can select any field that is associated with the SysName and concatenate it into your own numbering scheme. Each of the fields selected can be formatted and the numbers can be set to sequence off of another field.


How it Works

The SysName format tool is used to generate regular expressions that are then used to parse SysName info as well as provide formatting information to masked text boxes.

A note on regular expressions: WireCAD v6 makes extensive use of regular expressions (Regex). Regular expressions are a well documented string parsing tool. Much has been written on them. It is not within the scope of this quick start guide to fully explain regular expressions; however, a google search will tell you more than you ever wanted to know.

Two forms of regular expression are generated: a simplified form that is used as a mask in both the Systems database and in textboxes, and a complex form that aids in the generation of queries to determine the next number in a sequence. The following are both the simplified and complex regex for the default format: 

\w{1,6}-\d{1,5}

(?<EQUIPMENTTYPE>\w{1,6})-(?<NUMERICSEQUENCE>\d{1,5})


Attention.png Warning: WireCAD supports multiple formats in the same database. In order to accomplish this we use the simplified Regex as a mask. If you have any data in the Project Systems table and you change ANYTHING in ANY Format field you will change the mask and therefore the sequence. You must decide if the change is such that it warrants copying the new simplified Regex to all records in the Project Systems table in order to keep your sequence.


Controls Explanation

Setting/Control Explanation/Description
Selected Format Selects the current SysName format. Clicking the + or - button allows you to add and remove custom SysName Formats
Select SysName Format
Input String/Looks Like WireCAD uses a fixed set of constants to test your custom format. All of the constants are upper case. The Input String provides a string to which the selected format is applied. The Looks Like label shows the input string with the formatting applied.
Select SysName Format
Advanced Regular Expression Info(geek stuff) This collapsible panel displays the complex and simplified REGEX. The simplified REGEX is associated with every SysName that is created under this format. This allows us to have multiple sequences working in the same table. As noted above: even minor changes in the simplified REGEX will change the sequence.
SysName Format
Regex Examples Some examples that you can cut/paste into the format field.
Variable List Displays the sequence of variables in grid view that will be concatenated into the final SysName.
Select SysName Format
Field The variable to concatenate into the output string.
SysName Format
Sequence On Applies to Numeric/Alpha Sequences. Sets the variable that the sequences is associated to.
Select SysName Format
Format The REGEX for all fields except the STRING variable. The STRING variable uses the literal string value of the format field.
SysName Format
Order the variable's order in the list.
[UP]/[DN] Move the selected record up or down in the list.
Test Syntax Tests the syntax. This tool has so many possibilities that it is possible that the [Test Syntax] function may not find all errors.

Available Variables

Variable Description Sequencable Default Format REGEX
MANUFACTURER The Manufacturer Name from the global Manufacturers database X \w{1,6}
EQUIPMENTNAME Equipment Name/PN/Model Number X \w{1,6}
DESCRIPTION The device description as contained in the global equipment library X \w{1,6}
EQUIPMENTTYPE The Equipment Type as contained in the global equipment library X \w{1,6}
LOCATION The location typed in the SysName edit dialog. X \w{1,6}
ELEVATION The elevation typed in the SysName edit dialog X \w{1,5}
STRING any string (usually used for delimiters like dashes (-)) any string (usually used for delimiters like dashes (-))
ALPHASEQUENCE an alpha sequence that starts at the letter 'a' X \w{4}
NUMERICSEQUENCE a numeric sequence that starts with the project starting number X \d{1,5}
USER1 the global equipment library device definition user1 field X \w{1,6}
USER2 the global equipment library device definition user2 field X \w{1,6}
USER3 the global equipment library device definition user3 field X \w{1,6}
USER4 the global equipment library device definition user4 field X \w{1,6}


More About Regex

The Format field uses regular expressions. The following are some simple examples:

Expression Description
\w* Any non number, non punctuation string any length
[a-zA-Z0-9]{5} Lower / Upper case and 0 thru 9 exactly 5 characters
\d{1,5} Digits 1 to 5 digits in length
\d* Digits any length
\\ a slash "\". The \ is the escape character so you need two
[a-zA-Z0-9_\-\,]{1,4} Lower / Upper case, 0-9, underscore, dash, and comma.
Retrieved from "https://www.wirecad.com/wiki/index.php?title=WireCAD_Online_Help:SysName_Format&oldid=778"