Pattern Creation and Editing
With Pattern Studio, you can create or edit a Pattern with ease. In a matter of seconds, you can add Pattern details, Fields and Field specifications, Subschemas, and more. To begin, navigate to the Patterns in Pattern Studio and click the "Create Pattern" button in the page-header.
Once you've clicked the Create button, you will have two options to get started:
You have two options when creating a Pattern
- Create a Pattern using a pre-made Blueprint via Pattern Menu
- Create a Pattern from scratch
In this case, select "Start from Scratch" and the following screen will show, prompting you to enter a name for your Pattern:
- Pattern Name: This will automatically populate the "Identifier" to the right and both will be used to identify documents as belonging to this Pattern. Please note that the "Identifier" will automatically populate and will be used to locate the Pattern in the API. This field is not editable and must be unique across all of your Patterns
- Pattern Description (Optional): Helps you understand what the Pattern is used for. The name and description will appear in Pattern List along with the number of Fields in the Pattern
After continuing from the previous screen, you will arrive at a screen that will show your Primary Schema with the same name as your Pattern. This represents the "main elements" of your document that do not need to be grouped together.
- Primary Schema Name: This represents the "top-level" grouping of Fields that help summarize your document and represent values you want to see up-front and do not need to be put in sub-groups or tables
- Add Field: Adds a new Field to the Primary Schema
- Create New Subschema: Creates a grouping of Fields that is linked under your Primary Schema. Good for subsections or tables of information from a document
We will begin adding Fields to the Primary Schema by clicking "Add Field."
After clicking "Add Field", you will see a new row with the options labeled 1 - 6 in the diagram below. While only "Field Name" is the only mandatory option, the other options are there to help you achieve your data and business needs:
- Required Designation: This makes it so that if a Field has no value associated with it, the Field is flagged for review and the document will not be able to be reviewed. This ensures that Reviewed documents only contain usable data
- Field Name (Mandatory): The name you would like to give the Field. Note that you can click-and-drag on the 6-dot icon in this box to reorder your Fields to change how they will appear in Data Inbox, Document Viewer, and in the API
- Identifier (Automatically Filled): This Field fills out automatically based on Field Name, much like the identifier for Pattern name and the Pattern name. There cannot be two of the same identifier in the same Primary Schema or Subschema. This is used in the API for access
- Field Type: Applies a check to ensure the value associated with the Field is in the correct format. For example, if the expected value should be a numeric type, there shouldn't be any letters. If the type check fails, the Field will be flagged for review and the document will not be able to be reviewed. This ensures that Reviewed documents only contain usable data
- Delete: This will delete the Field. Take care when deleting a Field when you've already been using your Pattern, as the previous values associated with the Field in documents that were associated with the Pattern
- Add Field: Adds another Field
After adding all of our Fields for the Pattern, if you need to add a grouping of Fields (known as a Subschema here), you can click on "Create New Subschema" and a new grouping will be added. Subschema Fields can have multiple values associated with them, so they are suited for row and column values from a table. Subschemas can also be used to group individual values that aren't in a table format, so feel free to use this feature for whatever best suits your purposes.
After defining the fields for our Subschema, we can click on "Save Pattern" to check that all necessary information for your Pattern is filled out. If all information is present, the Save will be successful and will return you to the Pattern List, where you can click on a Pattern name to be taken to the edit screen with the Pattern information.
