Workflow.xml

Описание структуры серверного xml-файла и основных тэгов

Краткий шаблон Workflow

<?xml version="1.0"?>
<Workflow Schema="">
  <ApiMethods></ApiMethods>

  <Scheduler></Scheduler>

  <Conditions></Conditions>

  <Commands></Commands>

  <SqlQueries></SqlQueries>
  
  <AccessPoints></AccessPoints>

  <Permissions></Permissions>
  
  <Roles></Roles>

  <Groups></Groups>
</Workflow>

Полный шаблон Workflow

<?xml version="1.0"?>
<Workflow Schema="" Table="" IdField="" TitleField="">
  <ApiMethods></ApiMethods>

  <Scheduler></Scheduler>

  <Conditions></Conditions>

  <Commands></Commands>

  <SqlQueries></SqlQueries>
  
  <AccessPoints></AccessPoints>

  <Permissions></Permissions>

  <Roles>
    <Role Name="">
      <Permissions>
        <Permission Name="" />
      </Permissions>
    </Role>
  </Roles>

  <Groups>
    <Group Name="">
      <Roles>
        <Role Name="" />
      </Roles>
    </Group>
  </Groups>

  <UserSettings
    PublicUserTable=""
    PublicUserIdField=""
    PublicUserNameField=""
    PublicUserDomainField=""
    PublicUserFullNameField=""
    PublicUserEnabledField=""
    Table=""
    IdField=""
    PublicIdField=""
    GroupTable=""
    GroupIdField=""
    GroupNameField=""
    UserGroupTable=""
    UserGroupUserIdField=""
    UserGroupGroupIdField=""
    GroupGroupTable=""
    GroupGroupChildIdField=""
    GroupGroupParentIdField=""
    PermissionTable=""
    GroupPermissionTable="" />

  <UpdateSettings
    TableName=""
    QueryNameField=""
    TableNameField=""
    TypeField=""
    ParameterField=""
    UserIdField=""
    DateField="" />
</Workflow>

Описание Workflow

Тэг <Workflow> - корневой элемент серверного файла.

<Workflow Schema="" Table="" IdField="" TitleField="">
  <!--Тэги, специфичные для Engine-->
</Workflow>

Атрибуты тэга <Workflow>

Schema	Название локальной схемы в базе данных. Необязательный атрибут. По умолчанию используется имя процесса, указанное в поле name в таблице public.workflow_type, к которому привязан серверный xml-файл. Имя процесса приводится в нижний регистр.
Table	Название таблицы экземпляров процессов в локальной схеме данных. Название таблицы указывается вместе со схемой. Необязательный атрибут. По умолчанию используется таблица workflow из схемы, указанной в атрибуте Schema тэга <Workflow>.
IdField	Название поля идентификатора экземпляра процесса в таблице экземпляров процессов локальной схемы данных. Необязательный атрибут. По умолчанию используется значение workflow_id.
TitleField	Название поля заголовка экземпляра процесса в таблице экземпляров процессов локальной схемы данных. Необязательный атрибут. По умолчанию используется значение title.

Тэги, специфичные для Workflow

Conditions

Содержит условия процесса.

Необязательный тэг. Значение тэга <Conditions>: см. в разделе Conditions.

<Conditions></Conditions>

Commands

Содержит команды процесса.

Необязательный тэг. Значение тэга <Commands>: см. в разделе Commands.

<Commands></Commands>

SqlQueries

Содержит sql-запросы процесса.

Необязательный тэг. Значение тэга <SqlQueries>: см. в разделе SqlQueries.

<SqlQueries></SqlQueries>

Scheduler

Содержит задачи процесса для планировщика.

Необязательный тэг. Значение тэга <Scheduler>: см. в разделе Scheduler.

<Scheduler></Scheduler>

AccessPoints

Содержит точки доступа процесса.

Необязательный тэг. Значение тэга <AccessPoints>: см. в разделе AccessPoints.

<AccessPoints></AccessPoints>

Permissions

Содержит разрешения процесса.

Необязательный тэг. Значение тэга <Permissions>: см. в разделе Permissions.

<Permissions></Permissions>

Roles

Содержит роли процесса.

Необязательный тэг. Значение тэга <Roles>: см. в разделе Roles.

<Roles></Roles>

Groups

Содержит соответствия групп пользователей и ролей процесса.

Необязательный тэг. Значение тэга <Groups>: см. в разделе Groups.

<Groups></Groups>

UserSettings

Настройки таблиц пользователей.

Необязательный тэг. Значение тэга <UserSettings>: отсутствует.

<UserSettings
  PublicUserTable=""
  PublicUserIdField=""
  PublicUserNameField=""
  PublicUserDomainField=""
  PublicUserFullNameField=""
  PublicUserEnabledField=""
  Table=""
  IdField=""
  PublicIdField=""
  GroupTable=""
  GroupIdField=""
  GroupNameField=""
  UserGroupTable=""
  UserGroupUserIdField=""
  UserGroupGroupIdField=""
  GroupGroupTable=""
  GroupGroupChildIdField=""
  GroupGroupParentIdField=""
  PermissionTable=""
  GroupPermissionTable="" />

Атрибуты тэга <UserSettings>

PublicUserTable	Название таблицы пользователей в глобальной схеме данных. Название таблицы указывается вместе со схемой. Необязательный атрибут. По умолчанию используется таблица user из схемы, указанной в атрибуте PublicSchema тэга <Workflow>.
PublicUserIdField	Название поля идентификатора пользователя в таблице пользователей глобальной схемы данных. Необязательный атрибут. По умолчанию используется значение user_id.
PublicUserNameField	Название поля системного имени пользователя в таблице пользователей глобальной схемы данных. Необязательный атрибут. По умолчанию используется значение user_name.
PublicUserDomainField	Название поля домена пользователя в таблице пользователей глобальной схемы данных. Необязательный атрибут. По умолчанию используется значение user_domain.
PublicUserFullNameField	Название поля видимого имени пользователя в таблице пользователей глобальной схемы данных. Необязательный атрибут. По умолчанию используется значение user_full_name.
PublicUserEnabledField	Название поля признака активного состояния пользователя в таблице пользователей глобальной схемы данных. Необязательный атрибут. По умолчанию используется значение enabled.
Table	Название таблицы пользователей в локальной схеме данных. Название таблицы указывается вместе со схемой. Необязательный атрибут. По умолчанию используется таблица user из схемы, указанной в атрибуте Schema тэга <Workflow>.
IdField	Название поля идентификатора пользователя в таблице пользователей локальной схемы данных. Необязательный атрибут. По умолчанию используется значение user_id.
PublicIdField	Название поля глобального идентификатора пользователя в таблице пользователей локальной схемы данных. Необязательный атрибут. По умолчанию используется значение public_user_id.
GroupTable	Название таблицы групп пользователей в локальной схеме данных. Название таблицы указывается вместе со схемой. Необязательный атрибут. По умолчанию используется таблица group из схемы, указанной в атрибуте Schema тэга <Workflow>.
GroupIdField	Название поля идентификатора группы пользователей в таблице групп пользователей локальной схемы данных. Необязательный атрибут. По умолчанию используется значение group_id.
GroupNameField	Название поля системного имени группы пользователей в таблице групп пользователей локальной схемы данных. Необязательный атрибут. По умолчанию используется значение name.
UserGroupTable	Название таблицы соответствий пользователей и групп в локальной схеме данных. Название таблицы указывается вместе со схемой. Необязательный атрибут. По умолчанию используется таблица user_group из схемы, указанной в атрибуте Schema тэга <Workflow>.
UserGroupUserIdField	Название поля идентификатора пользователя в таблице соответствий пользователей и групп локальной схемы данных. Необязательный атрибут. По умолчанию используется значение user_id.
UserGroupGroupIdField	Название поля идентификатора группы пользователей в таблице соответствий пользователей и групп локальной схемы данных. Необязательный атрибут. По умолчанию используется значение group_id.
GroupGroupTable	Название таблицы соответствий групп пользователей между собой в локальной схеме данных. Название таблицы указывается вместе со схемой. Необязательный атрибут. По умолчанию используется таблица group_group из схемы, указанной в атрибуте Schema тэга <Workflow>.
GroupGroupChildIdField	Название поля идентификатора дочерней группы пользователей в таблице соответствий групп пользователей между собой в локальной схеме данных. Необязательный атрибут. По умолчанию используется значение child_group_id.
GroupGroupParentIdField	Название поля идентификатора родительской группы пользователей в таблице соответствий групп пользователей между собой в локальной схеме данных. Необязательный атрибут. По умолчанию используется значение parent_group_id.
PermissionTable	Название таблицы разрешений в локальной схеме данных. Название таблицы указывается вместе со схемой. Необязательный атрибут. Если атрибут отсутствует, то система динамических прав НЕ ФУНКЦИОНИРУЕТ.
GroupPermissionTable	Название таблицы соответствий групп пользователей и разрешений в локальной схеме данных. Название таблицы указывается вместе со схемой. Необязательный атрибут. По умолчанию используется таблица group_permission из схемы, указанной в атрибуте Schema тэга <Workflow>.

UpdateSettings

Настройки таблицы для записи информации об изменении данных процесса.

Необязательный тэг. Значение тэга <UpdateSettings>: отсутствует.

<UpdateSettings
  TableName=""
  QueryNameField=""
  TableNameField=""
  TypeField=""
  ParameterField=""
  UserIdField=""
  DateField="" />

Атрибуты тэга <UpdateSettings>

TableName	Название таблицы для записи информации об изменении данных процесса в локальной схеме данных. Необязательный атрибут. По умолчанию используется таблица update из схемы, указанной в атрибуте Schema тэга <Workflow>.
QueryNameField	Название поля имени запроса, обращавшегося к базе данных, в таблице для записи информации об изменении данных процесса локальной схемы данных. Необязательный атрибут. По умолчанию используется значение query_name.
TableNameField	Название поля имени таблицы базы данных, к которой обращался запрос, в таблице для записи информации об изменении данных процесса локальной схемы данных. Необязательный атрибут. По умолчанию используется значение table_name.
TypeField	Название поля типа запроса в таблице для записи информации об изменении данных процесса локальной схемы данных. Необязательный атрибут. По умолчанию используется значение type.
ParameterField	Название поля значения параметра, который вернул запрос, в таблице для записи информации об изменении данных процесса локальной схемы данных. Необязательный атрибут. По умолчанию используется значение parameter.
UserIdField	Название поля идентификатора пользователя, который вызвал запрос, в таблице для записи информации об изменении данных процесса локальной схемы данных. Необязательный атрибут. По умолчанию используется значение user_id.
DateField	Название поля даты и времени, когда запрос был выполнен, в таблице для записи информации об изменении данных процесса локальной схемы данных. Необязательный атрибут. По умолчанию используется значение date.

ReplySettings

Настройки таблицы напоминаний процесса.

Необязательный тэг. Значение тэга <ReplySettings>: отсутствует.

<ReplySettings
  Table=""
  IdField=""
  StepTypeIdField=""
  WorkflowIdField=""
  UserIdField=""
  ReplyIdField=""
  PausedField="" />

Атрибуты тэга <ReplySettings>

Table

Название таблицы напоминаний процесса в локальной схеме данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут Table отсутствует, то по умолчанию используется значение <значение атрибута Schema тэга Workflow>.reply.

IdField

Название поля идентификатора напоминания в таблице напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут IdField отсутствует, то по умолчанию используется значение reply_id.

StepTypeIdField

Название поля идентификатора шага напоминания в таблице напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут StepTypeIdField отсутствует, то по умолчанию используется значение step_type_id.

WorkflowIdField

Название поля идентификатора экземпляра процесса напоминания в таблице напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут WorkflowIdField отсутствует, то по умолчанию используется значение workflow_id.

UserIdField

Название поля идентификатора пользователя-адресата напоминания в таблице напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут UserIdField отсутствует, то по умолчанию используется значение user_id.

ReplyIdField

Название поля идентификатора адресата сообщения в системе Messenger в таблице напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут ReplyIdField отсутствует, то по умолчанию используется значение messenger_reply_id.

PausedField

Название поля признака, определяющего, остановлен ли показ напоминания для пользователя-адресата, в таблице напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут PausedField отсутствует, то по умолчанию используется значение paused.

MessageAppearanceSettings

Настройки таблицы настроек напоминаний процесса.

Необязательный тэг. Значение тэга <MessageAppearanceSettings>: отсутствует.

<MessageAppearanceSettings
  Table=""
  IdField=""
  StepTypeIdField=""
  MessengerUserIdField=""
  MessengerPriorityIdField=""
  ThemeField=""
  ShortField=""
  TextField=""
  DeadLineField=""
  DeadLineShiftField=""
  LinkTitleField=""
  LinkProgramField=""
  LinkArgumentField=""
  StartConditionDateField=""
  StartConditionDateShiftField=""
  FinishConditionCountField=""
  FinishConditionDateField=""
  FinishConditionDateShiftField=""
  BrakeConditionCountField=""
  PeriodField=""
  PeriodVariableField=""
  StartHourField=""
  FinishHourField=""
  MissedShowPeriodField=""
  MissedShowPeriodVariableField=""
  MandatoryLookField=""
  MandatoryTextField=""
  MandatoryUrlField=""
  EnabledField="" />

Атрибуты тэга <MessageAppearanceSettings>

Table

Название таблицы настроек напоминаний процесса в локальной схеме данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут Table отсутствует, то по умолчанию используется значение <значение атрибута Schema тэга Workflow>.message_appearance.

IdField

Название поля идентификатора настройки напоминаний для шага процесса в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут IdField отсутствует, то по умолчанию используется значение message_appearance_id.

StepTypeIdField

Название поля идентификатора шага, для которого задаются настройки, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут StepTypeIdField отсутствует, то по умолчанию используется значение step_type_id.

MessengerUserIdField

Название поля идентификатора пользователя в системе Messenger, от которого будут приходить напоминания, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут MessengerUserIdField отсутствует, то по умолчанию используется значение messenger_user_id.

MessengerPriorityIdField

Название поля идентификатора приоритета сообщения в системе Messenger, с которым будут приходить напоминания, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут MessengerPriorityIdField отсутствует, то по умолчанию используется значение messenger_priority_id.

ThemeField

Название поля темы напоминания в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут ThemeField отсутствует, то по умолчанию используется значение theme.

ShortField

Название поля краткого содержания напоминания в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут ShortField отсутствует, то по умолчанию используется значение short.

TextField

Название поля полного содержания напоминания в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут TextField отсутствует, то по умолчанию используется значение text.

DeadLineField

Название поля даты, когда напоминание считается просроченным, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут DeadLineField отсутствует, то по умолчанию используется значение dead_line.

DeadLineShiftField

Название поля интервала времени относительно времени создания напоминания, когда напоминание считается просроченным, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут DeadLineShiftField отсутствует, то по умолчанию используется значение dead_line_shift.

LinkTitleField

Название поля заголовка ссылки напоминания в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут LinkTitleField отсутствует, то по умолчанию используется значение link_title.

LinkProgramField

Название поля пути до приложения для запуска ссылки напоминания в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут LinkProgramField отсутствует, то по умолчанию используется значение link_program.

LinkArgumentField

Название поля аргументов для запуска ссылки напоминания в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут LinkArgumentField отсутствует, то по умолчанию используется значение link_argument.

StartConditionDateField

Название поля даты, когда напоминание должно быть показано первый раз (условие начала показа), в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут StartConditionDateField отсутствует, то по умолчанию используется значение start_condition_date.

StartConditionDateShiftField

Название поля интервала времени относительно времени создания напоминания, когда напоминание должно быть показано первый раз (условие начала показа), в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут StartConditionDateShiftField отсутствует, то по умолчанию используется значение start_condition_date_shift.

FinishConditionCountField

Название поля условия завершения показа напоминания по количеству уже показанных раз в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут FinishConditionCountField отсутствует, то по умолчанию используется значение finish_condition_count.

FinishConditionDateField

Название поля даты, когда напоминание уже не может быть показано повторно (условие завершения показа), в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут FinishConditionDateField отсутствует, то по умолчанию используется значение finish_condition_date.

FinishConditionDateShiftField

Название поля интервала времени относительно времени создания напоминания, когда напоминание уже не может быть показано повторно (условие завершения показа), в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут FinishConditionDateShiftField отсутствует, то по умолчанию используется значение finish_condition_date_shift.

BrakeConditionCountField

Название поля условия прерывания показа напоминания по количеству адресатов, для которых уже выполнены условия завершения показа, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут BrakeConditionCountField отсутствует, то по умолчанию используется значение brake_condition_count.

PeriodField

Название поля интервала (в часах) между повторами показа напоминания в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут PeriodField отсутствует, то по умолчанию используется значение period.

PeriodVariableField

Название поля указания имени поля из таблицы шага, соответствующего текущей настройке, в которой для каждого экземпляра шага будет хранится интервал (в часах) между повторами показа напоминания, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут PeriodVariableField отсутствует, то по умолчанию используется значение period_variable.

StartHourField

Название поля часа (час от дня), начиная с которого напоминание может быть показано, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут StartHourField отсутствует, то по умолчанию используется значение start_hour.

FinishHourField

Название поля часа (час от дня), после которого напоминание уже не может быть показано, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут FinishHourField отсутствует, то по умолчанию используется значение finish_hour.

MissedShowPeriodField

Название поля интервала (в часах), в течение которого напоминание, уже не появившееся вовремя, будет все равно показано, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут MissedShowPeriodField отсутствует, то по умолчанию используется значение missed_show_period.

MissedShowPeriodVariableField

Название поля указания имени поля из таблицы шага, соответствующего текущей настройке, в которой для каждого экземпляра шага будет храниться интервал (в часах), в течение которого напоминание, уже не появившееся вовремя, будет все равно показано, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут MissedShowPeriodVariableField отсутствует, то по умолчанию используется значение missed_show_period_variable.

MandatoryLookField

Название поля признака, определяющего, требуется ли обязательный просмотр напоминания, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут MandatoryLookField отсутствует, то по умолчанию используется значение mandatory_look.

MandatoryTextField

Название поля признака, определяющего, требуется ли обязательное прочтение напоминания, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут MandatoryTextField отсутствует, то по умолчанию используется значение mandatory_text.

MandatoryUrlField

Название поля признака, определяющего, требуется ли обязательный вызов ссылки в напоминании, в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут MandatoryUrlField отсутствует, то по умолчанию используется значение mandatory_url.

EnabledField

Название поля признака показа напоминания для данного этапа в таблице настроек напоминаний процесса локальной схемы данных.

Необязательный атрибут. Любое значение будет переведено в текстовое.

Если атрибут EnabledField отсутствует, то по умолчанию используется значение enabled.