Draft. Add S9 Notation info, including where in the interface it is supported. Link back to here.
Link from Export Data and Documents.Export Data and Documents
S9 Notation is a tool for embedding variables into a variety of Annotations, Workflow Nodes fields. These notations are replaced at runtime by an Index Field, Process Field or by general information. To see a list of notations available for that field, type in a single brace ( { ).
Standard S9 Notations
Every GlobalCapture Workflow comes with a set of standard S9 Notations that be used as follows:
Standard S9 Notation
Formatting | Result |
{LASTUSERMODIFIED} | Contains the last user to either scan or validate the process. |
{PROCESSID} | Contains the numeric unique identifier for this particular process. |
{TODAY} | Contains the date and time that the notation is accessed. |
{p_ActiveTemplate} | The Template which was lasted assigned to the document through classification. |
{p_BatchID} | Contains the numeric unique identifier for this particular set of process. |
{p_FileType} | Contains the current file extension of the document that is being processed. |
{p_FilePath} | Contains the path to the document in process if merged. (PDF and TIFs do not populate this property mid process). |
{p_OriginalFileName} | Contains the original name of the file prior to it being imported into the GlobalCapture Workflow. |
{p_ReleasedFilePath} | Contains the path to the released document following a Release Node. |
See GC appendix for the missing images.
Basic Process Field Notation
When simply referencing the value currently within a Process Field, the following S9 Notation can be used. (Replace ProcessFieldName with the name of your Field.)
Field Name Notation
It is helpful to keep in mind that there can be data-type mismatch issue spawned from inserting one Process Field into another. For example, an alpha character value cannot be placed within a numeric or decimal Field.
In GlobalCapture Convey PLUS, you can extract the confidence of a given Field that has passed through the Classify Node or has been modified by a user. This will return a numeric value between 0 and 100; a higher value meaning that the capture engine is more confident in the value currently held in the Process Field.
Field Name Notation with Confidence
Multi-Value Field Notation
You can access specific indexes of data from within a Multi-Value Field using S9 Notation. In the example, an index of 0 is provided within the MVFieldName notation to extract the first value of the array of data. (Replace MVFieldName with the name of your Multi-Value Field.) Note that if it attempts to access an index that does not exist, it will error in the Batch Manager.
Multi-Value Field Notation
In a slightly more complex example of a basic S9 Notation within a MVFieldName notation, the value extracted from the MVFieldName array will be based on the numeric value currently stored within the index Process Field.
Multi-Value Field Notation
With a method of extracting specific values from the MVFieldName notation, it can become useful to check the length of the Field data to ensure that a valid extraction is taking place. Use a trailing underscore followed by length to access the exact number of values within the Multi-Value Field.
Multi-Value Field Notation with Length
Like normal Process Fields, the MVFieldName notation also supports confidence extraction.
Multi-Value Field Notation with Confidence
TableField Notation
You can use S9 Notation with your Table Fields to access row and column data during your Workflows. The example shows how to access a specific value from within a Table Field. (Replace TFName with the name of your Table Field.) Note that there are two indexes used as coordinates of this data. The first index is the Field ID of the Process Field within that Table Field. This points to the column from which are you are planning on extracting data. The second index is the index of the array holding the data. In this example, the Process Field with Field ID 5 and 0 to extract data in the first row of the Table Field.
Table Field Notation
Like with MVFieldName notation, use a trailing underscore followed by length to access the exact number of values within the Table Field. This example attempts to see how many rows are in the column for Fields with Field ID 5.
Table Field Notation with Length
Here is the more complex example to show what notations are capable of. This example attempts to extract the confidence of a particular value in the Table Field. To focus on this value, it attempts a mathematical operation within the second index of the Table Field. This operation is checking the length of the Table Field column then subtracting a counter from it to specify the index. This index is then used to extract the confidence from that specific table cell.
Table Field Notation with a Mathematical Operation
Notation Math
You can use addition and subtraction in S9 Notation-based operations, as seen in the following examples.
S9 Notation with Notation Mathematics
The values needed to do math do not need to be S9 Notations, but at least one of the values included in the string does.
You can find the sum and the average in Multi-Value Field and Table Field columns. The Multi-Value Field (MVFieldName) or Table Field (TablefieldName) columns needs to contain numeric or decimal data.
Multi-Value Field Notation with Notation Mathematics