Schema diagram
Schema diagrams provide a way to model the required database schema used behind data stores in a workflow szenario.
The diagram type "Schema diagram" is displayed together with the Schema Toolbox.
Schema Context Tab
When editing a schema diagram you’ll notice the schema contextual ribbon tab. The schema contextual ribbon tab provides additional options to your schema diagram.
Apply Schema
To create a real database from your schema definition, you have to apply your schema. If you press the Apply Schema button, your schema will either be created or updated to your new schema definition.
If your schema is not valid, you’ll receive error messages in the output window.
Manage Data
To edit the data in the underlying database table, see topic Manage Data.
Query Editor
To edit Queries for the Workflow Execution, see topic Query Editor.
Schema table
A Schema Diagram consists out of one or more Schema Tables.
Create Schema Table
To create a Schema Table, drag a Schema Table from the Schema Toolbox into the Work area.
Edit Schema Table Name
Edit the Table Name either in the Properties Area or double click the heading of the schema.
Add/Remove Columns
To add/remove columns, move the mouse over a column of a selected schema table and click on the appearing +/- sign to add or remove a column.
Edit Column Properties
To Edit Column Properties, select the requested Column. The Properties Area contains a section "Column Properties" where you may adjust your settings.
The following Settings are available:
- Size
-
If "Data Type" is "String" this represents the size of the underlying database column. Zero (0) indicates a Huge Column size, that is limited by the Database specification only.
- Data Type
-
The Possible Data Types are:
- Variant
-
Unspecified
- String
-
A character based column
- Integer
-
May contain integer numbers
- Float
-
May contain floating point numbers
- DateTime
-
May contain dates
- Currency
-
May contain currency values
- Guid
-
May contain Globally Unique Identifiers
- Object
-
May contain an Object (i.e. List, Dictionary…)
Because the Variant datatype is unspecified, the data MUST be in the format of a python string. That means, strings MUST be enclosed in quotation marks.
- Name
-
The name of the column
- Identity
-
Only available if Data Type is Number or Guid - specifies that this column is an Identity column. Identity column values are automatically generated by the database.
- Primary Key
-
Primary Key columns identify the database row unique. Each table requires at least one primary key column. This option is often used in conjunction with the Identity setting.
Manage Data
To edit the data in the underlying database table of a schema table, select the schema table and click on Manage Data in the Schema Context Tab. The appearing dialog allows you to:
- Export Data
-
Export the content of your table into a csv formatted file
- Import data
-
Import data from a csv formatted file into your table
- Edit a row
-
Doubleclick onto a row to edit the row content
- Delete a row
-
Select the rows to delete and press the Delete button
Query Editor
To utilize Schema definitions within workflows, you may wish to define queries to access data. Queries provide an easy way to load and save data from within a data store in a workflow scenario.
To define and edit queries, select a schema definition and click on Query Editor in the Schema Context Tab. The appearing dialog allows you to:
-
Create a new Query or select an existing one
-
Select the columns of your result set
These columns will be retrieved from or stored/updated to the database when utilizing the query definition -
Select the columns of your query set
These column(s) are used to identify the rows which will be retrieved or saved from/to the database. Usually you specify the primary key columns here.
