Some definitions

Definition elements

Numerous elements are implemented in the VDoc database. From these definition elements we will keep the following:

  • IResourceDefinition: gathers all properties (VDoc fields, free fields and list fields) defined in the administration;
  • IProperty: description of a document field;
  • IWorkflow: constitutes the document life cycle. Gathers the tasks and the actions.
  • ITask: description of a task;
  • IAction: description of an action;
  • IBundleDefinition: constitutes the bundle definition;
  • IDataForm: constitutes the base element of the forms;
  • ISimpleDataForm: standard form;
  • IMenuDataForm: menu form;
  • IViewDataForm: view form;
  • IFolder: interface corresponding to an element from a tree structure;
  • IAttachmentTemplate: word document template.

Diagram of definition elements classes

This classes diagram represents the main relations that exist between every classes of the document management system.

Definition element classes

Table of definition elements correspondence

Functional term Technical term SDK term Open SDK term Description
Document type Resource definition IResourceDefinition ClsDocumentTypeItem Element constituting the document definition as the supported values.
Field / Property Document attributes Property IProperty Property Element constituting the description of a value supported by the document.
Lifecycle Lifecycle IWorkflow VersionGroup A life cycle is the modeling of the document path through multiple stages.
Task / Step Step ITask ClsGeneralInformationsReader ClsStepWriter ClsStepReader A task is the modeled object identifying a lifecycle stage.
Step Change action Routing action Routing action IAction User action to leave a step.
Bundle template Bundle definition IBundleDefinition ClsBundleModelItem Element constituting the document bundle description.
Form Form IDataForm ClsDataFormItem Base element for forms of standard,menu and view type.
Standard form Standard form ISimpleDataForm ClsDataFormItem Standard form enabling to store data,menus and sub-forms.
Menu form Menu form IMenuDataForm ClsDataFormItem Form enabling to retrieve functional terms in the data navigation.
View form View form IViewDataForm ClsDataFormItem Form enabling to point at a view or an external table.
Folder Folder IFolder ClsFolderReader ClsFolderItem Element of a tree structure enabling to implement the security.
Document template Document template IAttachmentTemplate ClsDocumentModelItem ClsWebFavouriteItem Word document template.

Dynamic elements

When a document is creating, several elements are registered in the database. Among these elements we will keep the following:

  • IResource: interface representing the document data and from which it is possible to change the fields values;
  • IVersion: interface branching off the interface IResource enabling to manage the document lifecycle (state change);
  • ITaskInstance: interface representing a document active task on which some operators may intervene;
  • IAttachment: interface enabling to handle attachment-type fields;
  • IOperator: interface representing a user operating on a step.
  • IVersion: interface branching off the interface IVersion enabling to manage the bundle lifecycle;
  • IDataUnit: interface branching off the interface IResource enabling to manage the data values.

    Diagram of dynamic elements classes

    Dynamic element classes

    Table of dynamic elements correspondence

    Functional term Technical term SDK term Open SDK term Description
    Resource Resource IResource Resource The term "Resource" represents the field values container. It lets you store all the document data.
    Version Version IVersion ClsVersionItem ClsBundleElementItem ClsVersionModifier ClsVersionReader ClsVersionBuilder ClsVersionDuplicator Unit element enabling to move user data through a life cycle.
    Task to process Task to process ITaskInstance ClsVersionReader A todo task represents an operation to be performed by a person or a program.
    Attachment,file File wrapper IAttachment ClsFileReader Attached file description in the document via a attachment field.
    Contributor Actor Contributor IOperator ClsOperatorReader ClsUserItem ClsGroupItem IUser IGroup This is an association between a person and an active task.
    Document bundle Bundle IBundle ClsBundleReader ClsBundleBuilder ClsVersionModifier ClsBundleItem ClsBundleElementItem Document bundle enabling to group several documents and sub-bundles.
    Data Data IDataUnit ClsDataBuilder ClsDataReader ClsDataItem Data enabling to contain versions and forms.