Namespace containing classes to interrogate and update the workflow database. Create an instance of the Server class and drilldown into its child collections. Alternatively create instances of the Folder, Procedure, Map etc classes directly. In general setting a property of an instance of a class implementing IUpdatable will not update the database until a call to ApplyChanges has been made.
| Class | Description |
|---|---|
| Action | An action in a map. |
| ActionCollection | A collection of actions. |
| Alert | A user alert. |
| AlertCollection | Collection of alerts for a user. |
| Attachment | An attachment in the database. |
| AttachmentCollection | A collection of attachments. |
| AuthenticationScript | A script used to authenticate users. |
| AuthenticationScriptCollection | A collection of authetication scripts |
| Column | A column in a database table. |
| ColumnCollection | Collection of columns in a table. |
| DatabaseAware | Base class for data-aware classes. |
| DesignerLog | A collection of designer log entries. |
| DesignerLogEntry | An entry in the designer log. |
| Field | A field on a form. |
| FieldCollection | Collection of fields on a form. |
| FieldUsageCollection | A collection of the field usage within an action. Any fields not referenced in this collection will be set to optional. |
| Flag | A flag that a folder is waiting for. |
| FlagCollection | A collection of flags a folder is waiting on |
| Folder | A process folder. |
| FolderCollection | A collection of folders. |
| FolderNote | A note on a folder. |
| FolderNoteCollection | A collection of notes added to a folder. |
| FolderVariableCollection | Collection of variables and their values within a folder |
| Form | A form in a procedure. |
| FormCollection | Collection of forms in a procedure. |
| History | A collection of history items. |
| HistoryItem | A history item. |
| Library | A library published to the database. |
| LibraryCollection | List of libraries available published to the database. |
| Map | A map in a procedure. |
| MapCollection | A collection of maps in a procedure. |
| Procedure | A procedure in the database. |
| ProcedureCollection | A collection of procedures. |
| ProcedureVersion | The details for a version of a procedure. |
| ProcedureVersionCollection | Summary description for ProcedureVersionCollection. |
| RegistrySettings | Provides access to the engine's registry settings on the local machine. |
| Report | A report. |
| ReportCollection | A collection of reports. |
| Role | A role in a procedure. |
| RoleCollection | A collection of roles. The roles within this collection will not include dynamic roles. |
| Script | A server-side or client side script stored in the database. |
| ScriptCollection | A collection of scripts. |
| Server | Wrapper class around the database server. |
| Session | A user session. |
| SessionCollection | A collection of all active sessions. |
| SqlExecutingEventArgs | Event argument class for the SqlExecutedEventHandler event handler. |
| Stage | A stage in a map. |
| StageCollection | Collection of stages in a map. |
| Table | A table in the database. |
| TableCollection | A collection of the tables in the database server. |
| Timer | A timer that a folder is waiting for. |
| TimerCollection | A collection of timers a folder is waiting for. |
| User | A registered user. |
| UserAttribute | A user attribute. |
| UserAttributeCollection | A collection of user attributes. |
| UserCollection | List of all registered users. |
| Variable | A variable in a map. |
| VariableCollection | A collection of custom variables. |
| Version | A version of a library in the database. |
| VersionCollection | A collection of procedure versions. |
| Interface | Description |
|---|---|
| IClearable | Interface for any class that can clear its contents. |
| IDeletable | Interface supported by any class that can delete its data from the database. |
| IRefreshable | Interface implemented by any class that can refresh itself. |
| IUpdatable | Interface implemented by any class that can save changes made to it. For performance reasons, setting a property on a class that implements this interface will not update the database, you must call ApplyChanges for the change to be applied to the database. |
| Delegate | Description |
|---|---|
| SqlExecutingEventHandler | Event handler triggered when SQL is about to be executed. |
| Enumeration | Description |
|---|---|
| ActionType | The type of an action |
| DatabaseType | Available types of database (SQL Server, Oracle etc) |
| DesignerLogSources | The types of designer log entries that can be shown |
| LoopbackOption | What will happen to the To Do list after a folder returns to the stage after a loopback action |
| SchemaVersion | Enumerated type that defines which version of the schema the database is using |
| StageType | The type of a stage |