ARTA Synergy предоставляет API для доступа к своим функциям с помощью rest сервисов. Описание методов API можно посмотреть в javadoc. Авторизация для всех методов API — Basic HTTP, подробнее о способах авторизации см. Способы авторизации в ARTA Synergy

Под «событием» мы будем подразумевать сообщение о каком-либо изменении в Arta Synergy, содержащее тип события и минимально необходимые для получения связанной с событием информации либо воздействия на Synergy данные. Обработчик события (или событий) — программный модуль, читающий сообщения о событиях из JMS Queue или JMS Topic и осуществляющий, при необходимости, доступ к экземпляру Synergy, сгенерировавшему сообщение, с помощью API Synergy.

Обработчик событий является отдельным от Arta Synergy приложением, которое может работать как на том же сервере приложений, что и Arta Synergy, так и на удалённом.

Кроме этого, обработчик события может иметь собственные конфигурационные файлы, необходимые для реализации целевого назначения.

Обработчик событий может обрабатывать как конкретное событие (например, event.registers.formdata.add), так и класс событий (например, event.registers.*).

Обработка события может происходить в 3 этапа:

ARTA Synergy генерирует событие в случае, если для этого события настроены обработчики. Обработчики событий настраиваются в конфигурационном файле ${jboss.home}/standalone/configuration/arta/api-observation-configuration.xml.

Сообщение, помещаемое в очередь JMS, представляет собой экземпляр javax.jms.TextMessage. Тело сообщения зависит от типа события, его описание можно посмотреть ниже среди описаний типов событий. Каждое событие содержит свойство api_event, указывающее на тип события, вызвавшего его (содержимое тега <event>event.registers.formdata.add</event> в конфигурационном файле).

Например:

<configuration>
    <listener> 
        <queue>java:jboss/queues/Synergy/UsersQueue</queue>
        <event>event.users.*</event>
    </listener>
    <listener> 
        <queue>java:jboss/queues/Synergy/RegisterCreateDocQueue</queue>
        <event>event.registers.formdata.add</event>
    </listener>
</configuration>

В этом примере настроены обработчики:

Рассмотрим, например, код обработчика очереди UsersQueue:

public class UsersMessagesListener implements MessageListener {

    public void onMessage(Message message) {
        //Получаем идентификатор пользователя, для которого 
        //сгенерировано событие
        String userID = ((TextMessage) message).getText();
        //Получаем тип события
        String eventType = message.getStringProperty("api_event");

        //Выполнение действие по получению дополнительных данных через API
        //и прочих операций, зависящих от условий решаемой задачи
    }
}

Ниже описаны типы событий, которые могут быть сгенерированы ARTA Synergy.

Для события [event.orgstructure.department.formdata.change] - идентификатор подразделения, для события [event.orgstructure.position.formdata.change] - идентификатор должности, для события [event.users.formdata.change] - идентификатор пользователя будет передаваться как основной параметр, остальные как свойства. Получить их можно следующим образом:

public void onMessage(Message message) {
    //Получение идентификатора пользователя/должности/подразделения (В зависимости от события на которое подписаны)
    String userID = ((TextMessage) message).getText();
    //Получаем идентификатор формы
    String formUUID = message.getStringProperty("formUUID");
}

1.2.1.2.1. События ARTA Synergy

1.2.1.2.1.1. События пользователей

Данные события генерируются для каждого из нижеописанных случаев изменения данных пользователей:

• [event.users.account.change] Изменение данных полей первичной карточки пользователя, т.е. параметров его учётной записи:

  • Фамилия

  • Имя

  • Отчество

  • Логин

  • Код для показателей

  • e-mail

  • JID

  • Личная папка пользователя

• [event.users.formdata.change] Изменение данных карточек пользователей на основе форм, ассоциированных с ним посредством функциональности «Отдел кадров». Для данного события передаются следующие данные:

  • userID - ID пользователя

  • formUUID - ID формы карточки пользователя

  • dataUUID - ID данных по форме

• [event.users.account.add] Добавление новой записи учётной записи пользователя (и связанными с ней файлами по формам «отдела кадров»)

• [event.users.account.delete] Удаление (пометка «удалённые») учётной записи пользователя (и связанных с ней файлов по формам «отдела кадров»)

• [event.users.contactdata.change] Изменение «контактных данных» пользователя — изменение/добавление записей раздела «Контакты» профиля пользователя (модуль «Сотрудники») следующих типов:

  • Skype

  • Рабочий телефон

  • XMPP

  • Адрес

  • Мобильный телефон

  • Почта

  • Телефон

Для всех событий типа event.users.* передаваемые данные — ID пользователя Synergy.

1.2.1.2.1.2. События должностей

Данные события генерируются для каждого из нижеописанных случаев c должностями:

• [event.orgstructure.position.add] Добавление новой должности

• [event.orgstructure.position.change] Изменение данных должности - добавление/изменение/удаление следующей информации:

  • Общее:

    • Название должности (на трех языках)

    • Код для показателей

    • Подразделение

    • Шифр

    • Необходимое количество штатных единиц

    • Тип назначения целей

    • Номер

  • Управление модулями

  • Показатели - статус активности

• [event.orgstructure.position.formdata.change] Изменение данных карточки должности на основе формы, ассоциированной с ней посредством функциональности «Отдел кадров». Для данного события передаются следующие данные:

  • positionID - ID должности

  • assistantID - ID заместителя, передается только при изменении данных карточки заместителя

  • formUUID - ID формы карточки должности

  • dataUUID - ID данных по форме

• [event.orgstructure.position.delete] Удаление должности

Для всех событий типа event.orgstructure.position.* передаваемые данные - ID должности Synergy.

Итерационные задачи по реализации: 0281, 0493

1.2.1.2.1.3. События подразделений

Данные события генерируются для каждого из нижеописанных случаев c подразделениями:

• [event.orgstructure.department.add] Добавление нового департамента

• [event.orgstructure.department.change] Изменение данных подразделения - добавление/изменение/удаление следующей информации:

  • Общее:

    • Информация о подразделении:

      • Название (на трех языках)

      • Номер

      • Код для показателей

      • Родительское подразделение (для всех узлов, кроме корневого)

      • Удаленный филиал

    • Информация о руководителе подразделения:

      • Название должности (на трех языках)

      • Тип назначения целей

      • Руководитель

      • И.О. руководителя

    • Заместители:

      • Название (на трех языках)

      • Номер

      • Пользователь

      • Подразделения, в которых данный пользователь будет выполнять обязанности заместителя

  • Управление модулями

  • Показатели - статус активности

  • Права на дела:

    • Наследовать права от родительского подразделения

    • Дело

    • Тип документа

Замечание

Ввиду особенностей реализации при сохранении подразделения отдельно сохраняется его карточка, отдельно - заместители. Таким образом, в данном случае событие event.orgstructure.department.change будет отправлено дважды, а при изменении заместителей через метод API rest/api/positions/assistant/save - единожды.

• [event.orgstructure.department.formdata.change] Изменение данных карточки подразделения на основе формы, ассоциированной с ней посредством функциональности «Отдел кадров». Для данного события передаются следующие данные:

  • departmentID - ID подразделения

  • formUUID - ID формы карточки подразделения

  • dataUUID - ID данных по форме

• [event.orgstructure.department.delete] Удаление подразделения

Для всех событий типа event.orgstructure.department.* передаваемые данные - ID подразделения Synergy.

Итерационные задачи по реализации: 0281, 0493

1.2.1.2.1.4. События реестров

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

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

Рисунок 1.1. Процесс «Событие реестра»

Подробнее о настройке и использовании реестров можно узнать в Руководстве Методолога, раздел Реестры, и Руководстве Пользователя, раздел Реестры.

1.2.1.2.1.5. События адресной книги

Объекты адресной книги (люди, организации) могут генерировать следующие события:

• [event.addressbook.contact.add] Добавление нового контакта адресной книги

• [event.addressbook.contact.change] Изменение данных контакта адресной книги: добавление / изменение / удаление записей карточки контакта. Событие генерируется при изменении:

  • данных в дополнительной карточке

  • данных в стандартной карточке:

    • «Люди»: ФИО, дата рождения, изображение, телефон, мобильный, e-mail, адрес, IM, URL, место работы, примечание, ключевые слова, поля дополнительной карточки, а также доступность контакта

    • «Организации»: название, изображение, сайт, адрес, телефон, мобильный, e-mail, поля дополнительной карточки, а также доступность контакта

• [event.addressbook.contact.change] Изменение данных контакта адресной книги

• [event.addressbook.contact.delete] Удаление контакта адресной книги

Для всех событий типа event.addressbook.contact.* передаваемые данные - это ID контакта адресной книги Synergy.

Итерационные задачи по реализации: AB1.

1.2.1.2.1.6. События работ

• [event.workflow.work.create] Создание работы

• [event.workflow.work.change] Изменение следующих параметров работы:

  • название

  • нагрузка

  • приоритет

  • сроки

  • ключевые слова

  • повторение

  • форма завершения

  • прогресс

• [event.workflow.work.completion] Фактическое завершение работы

• [event.workflow.work.expired] Работа просрочилась

• [event.workflow.work.delete] Удаление работы

Примечание

При добавлении/изменении/удалении комментария к работе, аналогичное событие для документов в очередь не добавляется.

Для события [event.workflow.work.expired] используется системная настройка «Интервал проверки работ на просроченность (в минутах)» (Конфигуратор -> Настройки системы -> Параметры уведомлений)

Минимальный набор передаваемых данных для всех событий типа event.workflow.work.*:

• идентификатор работы

Если работа запускается по реестру, то также обязательно передаются:

• идентификатор данных по форме записи реестра (свойство с ключом dataUUID)

• идентификатор документа реестра (свойство с ключом documentID)

В случае, если генерируется любое событие по работе, порожденной мероприятием проекта, в свойствах сообщения (ключ ArrangementID) передается идентификатор этого мероприятия (ParentID).

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

Итерационные задачи по реализации: AS25, AS26

1.2.1.2.1.7. События по проектам

• [event.projects.arrangement.create] Создание мероприятия проекта

• [event.projects.arrangement.delete] Удаление мероприятия проекта

• [event.projects.arrangement.restore] Восстановление мероприятия проекта

• [event.projects.arrangement.responsibles] Фактическое изменение списка ответственных за мероприятие проекта

Примечание: событие изменения списка ответственных не включает случаи, когда выбранному ответственному создается работа-запрос стать ответственным и когда он отказывает в этом запросе. Таким образом, учитывается только фактическое назначение ответственного за мероприятие проекта.

• [event.projects.arrangement.progress] Выставление прогресса мероприятия

Минимальный набор передаваемых данных для всех событий типа event.projects.arrangement.* - это идентификатор мероприятия проекта.

Итерационные задачи по реализации: AS29, AS30

1.2.1.2.1.8. События по документам

• [event.docflow.document.register] Регистрация документа в журнале

Минимальный набор передаваемых данных в сообщении для события [event.docflow.document.register] - идентификатор документа.

В свойствах сообщения (ключ registerID) передаётся идентификатор журнала.

Итерационные задачи по реализации: AS35.

1.2.1.2.1.9. События по формам

• [event.form.formdata.change] Создание и сохранение данных по форме

Минимальный набор передаваемых данных в сообщении для события [event.form.formdata.change]:

• dataUUID - идентификатор данных по форме;

• formID - идентификатор формы;

• isNew - сохранены ли данные:

  • true - новые;

  • false - существующие.

В свойствах сообщения (ключ dataUUID) также передаётся идентификатор данных по форме.

1.2.1.2.1.10. События комментариев

Данные события генерируются для каждого из нижеописанных случаев:

Комментарии к работе

• [event.comment.work.add] Добавление нового комментария к работе

• [event.comment.work.change] Изменение комментария к работе

• [event.comment.work.delete] Удаление комментария к работе

Примечание

При добавлении/изменении/удалении комментария к работе, аналогичное событие для документов в очередь не добавляется.

Комментарии к документу

• [event.comment.document.add] Добавление нового комментария к документу

• [event.comment.document.change] Изменение комментария к документу

• [event.comment.document.delete] Удаление комментария к документу

Личные комментарии

• [event.comment.personal.add] Добавление нового личного комментария

• [event.comment.personal.change] Изменение личного комментария

• [event.comment.personal.delete] Удаление личного комментария

Комментарии к проекту/мероприятию

• [event.comment.action.add] Добавление нового комментария к мероприятию проекта

• [event.comment.action.change] Изменение комментария к мероприятию проекта

• [event.comment.action.delete] Удаление комментария к мероприятию проекта

Для всех событий типа event.comment.* передаваемые данные зависят от типа комментария и выглядят следующим образом:

• Комментарий к работе:

  • идентификатор комментария (свойство с ключом message text)

  • идентификатор автора комментария (свойство с ключом userID)

  • идентификатор документа (свойство с ключом documentID)

  • идентификатор работы (свойство с ключом actionID)

• Комментарий к документу:

  • идентификатор комментария (свойство с ключом message text)

  • идентификатор автора комментария (свойство с ключом userID)

  • идентификатор документа (свойство с ключом documentID)

• Личный комментарий:

  • идентификатор комментария (свойство с ключом message text)

  • идентификатор автора комментария (свойство с ключом userID)

  • идентификатор документа (свойство с ключом documentID)

  • идентификатор работы (свойство с ключом actionID)

• Комментарий к мероприятию:

  • идентификатор комментария (свойство с ключом message text)

  • идентификатор автора комментария (свойство с ключом userID)

  • идентификатор проекта (свойство с ключом projectID)

  • идентификатор мероприятия (свойство с ключом actionID)

  Примечание

  В случае, если объектом события является комментарий к проекту, то параметры projectID и actionID будут равны.

Итерационные задачи по реализации: 0345

1.2.1.2.1.11. Генерация произвольных событий

В ARTA Synergy имеется метод API, позволяет генерировать произвольные события.

URL метода: rest/api/events/create. Типа запроса: POST.

Метод принимает следующие обязательные параметры:

• eventName - название события (строка);

• eventMsg - произвольный json (строка).

В случае успешного выполнения метода сервер вернет сообщение «Событие успешно сгенерировано».

Пример:

Событие, генерируемое мобильным клиентом по координатам GPS:

eventName=event.ext.gps&eventMsg={"lat":333.333,"lon":222.222}

Итерационные задачи по реализации: API41.

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

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

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

Конфигурация блокирующего процесса:

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

Рисунок 1.2.

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

<jms-queue name="ExampleQueue">
    <entry name="java:jboss/queues/Integration/ExampleQueue"/>
    <durable>true</durable>
</jms-queue>

<listener>
     <queue>java:jboss/queues/Integration/ExampleQueue</queue>
     <event>event.blocking.example</event>
</listener>

Обратите внимание, что название блокирующего процесса, указанное в маршруте в конфигураторе должно быть равно значению тега в конфигурационном файле api-observation-configuration.xml (в данном примере: event.blocking.example) и название очереди должно совпадать со значением тега queue конфигурационного файла api-observation-configuration.xml (в данном примере: java:jboss/queues/Integration/ExampleQueue)

Сообщение, передаваемое в очередь, является экземпляром TextMessage. Содержимым сообщения является объект JSON с полями:

После того, как модуль обратится к внешней системе и выполнит необходимые действия, он должен вызвать метод API Synergy для того, чтобы возвратить результат выполнения процесса и продолжить работу маршрута. Для того, чтобы это сделать, необходимо вызвать метод API kz.arta.synergy.samples.processes.blocking.ProcessesService#signalProcess.

package kz.arta.synergy.samples.processes.blocking;

import com.sun.org.apache.xerces.internal.impl.dv.util.Base64;
import org.codehaus.jackson.JsonFactory;
import org.codehaus.jackson.JsonParser;
import org.codehaus.jackson.JsonToken;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.jms.Message;
import javax.jms.MessageListener;
import javax.jms.TextMessage;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;

/**
 * <p><Пример блокирующего процесса</p>
 */
public class BlockingQueueListener implements MessageListener {
    
    public void onMessage(Message message) {

        String dataUUID = null;
        String executionID = null;
        String documentID = null;

        if (!(message instanceof TextMessage)){
            return;
        }

        try {

            JsonFactory factory = new JsonFactory();
            JsonParser parser = factory.createJsonParser(((TextMessage) message).getText());
            JsonToken token = null;

            while ((token = parser.nextToken()) != null) {
                if (token == JsonToken.FIELD_NAME) {
                    String fieldName = parser.getText();
                    parser.nextToken();
                    String value = parser.getText();
                    if (fieldName.equals("dataUUID")){
                        dataUUID = value;
                    } else if (fieldName.equals("executionID")){
                        executionID = value;
                    } else if (fieldName.equals("documentID")){
                        documentID = value;
                    }
                }
            }

         //Выполнение каких-либо действий
         ….......

            //Разблокировка маршрута

            String address = "http://127.0.0.1:8080/Synergy";
            String login = "1";
            String password = "1";
            String signal = "got_agree";
            boolean isSuccess = false;

            try {
                URL url = new URL(address + "/rest/api/processes/signal?signal=" + signal + "&executionID=" + executionID + "&param1=resolution&value1=signal_is_" + signal);

                HttpURLConnection conn = (HttpURLConnection) url.openConnection();
                conn.setRequestMethod("GET");
                conn.setRequestProperty("Accept", "application/json; charset=utf-8");

                String encoded = Base64.encode((login + ":" + password).getBytes());
                conn.setRequestProperty("Authorization", "Basic " + encoded);

                String output;
                StringBuffer result = new StringBuffer();

                BufferedReader br = new BufferedReader(new InputStreamReader((conn.getInputStream())));

                while ((output = br.readLine()) != null) {
                    result.append(output);
                }

                conn.disconnect();

                JsonFactory factory = new JsonFactory();
                JsonParser parser = factory.createJsonParser(result.toString());
                JsonToken token = null;

                while ((token = parser.nextToken()) != null) {
                    if (token == JsonToken.FIELD_NAME) {
                        String fieldName = parser.getText();
                        token = parser.nextToken();
                        if (fieldName.equals("errorCode") && parser.getText().equals("0")){
                            isSuccess = true;
                        }
                    }
                }
            } catch (Exception exc){
                logger.error(exc.getMessage(), exc);
            }

        } catch (Exception exc){
            logger.error(exc.getMessage(), exc);
        }
    }
}

#submodule=module_id

где module_id:

При переходе по ссылке откроется указанный модуль.

#submodule=common&file_identifier=some_file_id&action=open_document&document_identifier=some_doc_id

#submodule=plans&action=open_action&action_identifier=some_action_id&project_identifier=some_project_id

#submodule=employees&innermodule=structure&action=open_user&user_identifier=some_user_id

Для настройки пользовательских компонентов методологу нужно во вкладке «Процессы» конфигуратора выбрать пункт «Пользовательские компоненты».

Рисунок 1.6. Пользовательские компоненты

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

Использование пользовательских компонентов как полей формы

В общем случае пользовательские компоненты не участвуют в местах, где могут использоваться какие-либо другие компоненты формы:

Для того, чтобы пользователький компонент присутствовал в сопоставлениях, необходимо, чтобы в его модели были реализованы методы setAsfData и getAsfData (см. «Создание нового компонента»), а также чтобы возвращалась структура компонента вида:

{ 
    "id": "id", 
    "type": "type", 
    "value": "value", 
    "key": "key"
}

Для снятия остальных ограничений достаточно реализации метода getAsfData и корректности возвращаемой структуры.

Пример:

В качестве примера расмотрим реализацию пользовательского компонента «Load info», который показывает перегруженных сотрудников при создании работы (данный компонент входит в стандартную поставку Synergy).

Итерационные задачи по реализации: 0193: Компонент предупреждение о перегрузке

Исходный код содержит следующий простой HTML код:

<!-- Определим добавляемый элемент, указав для него необходимый стиль. -->
<span id = "workloadLable" style="color:red; padding-top: 10px"> </span>
<!-- За содержимое элемента будет отвечать исходный код скрипта.       -->

Исходный код скрипта устроен более сложным образом. Рассмотрим реализацию функции получающей данные из api:

function ajaxUserWL(ar){
    // Функция filtrAr() исключает из массива повторения пользователей.
    ar = filtreAr(ar);

    // Используем массив, который подходит под формат `json`, определенный в `api`.
    // Данный формат необходимо всегда уточнять в javadoc.
    var req = [];
    for (var i = 0; i < ar.length; i++){
        var r = {userID: ar[i].userId,
            startDate: getCurrentDateFormated(),
            finishDate: getCurrentDateFormated()};
        req.push(r);
    }

    // Вызываем функцию, которая для пользователей из массива req, вызовет
    // api, возвращающую их загруженность. Перегруженные пользователи
    // добавляются в массив res и формируют содержимое HTML тага.
    jQuery.ajax({

        // Вызов необходимого api.
        url: 'rest/person/workload/m',
        type: 'post',
        data: JSON.stringify(req),
        contentType: 'application/json',
        dataType: 'json',

        // Функция осуществляет проверку на перегруженность и помещает таких
        // сотрудников в массив res
        success: function (data) {
            res = [];
            for (var i = 0; i < ar.length; i++) {
                var user = data[ar[i].userId];
                if (user == null) {
                    continue;
                }
                for (var j = 0; j < user.length; j++) {

                    // Проверка на перегруженность.
                    if (parseFloat(user[j].value) > 100) {
                        res.push(ar[i]);
                    }
                }
            }

            // Функция определяет формат, в котором будет выводиться инофрмация.
            overloadUsers(res);
        }
    });
}

Итерационные задачи по реализации: 0195: API получения нагрузки

Замечание:

Замечание:

Для того, чтобы выбрать, где использовать пользовательский компонент, методологу необходимо во вкладке «Процессы» выбрать пункт «Внешние модули-компоненты» и добавить новый внешний модуль-компонент.

Рисунок 1.7. Внешние модули-компоненты

Настройка внешнего модуля-компонента включает в себя настройку следующих полей:

Для работы ВМК в Synergy реализована отправка событий в JS EventBus.

Пример использования события из нового проигрывателя форм в JS:

AS.FORMS.bus.on(AS.FORMS.EVENT_TYPE.formShow, function (event, model, view) {
    var calendarModel = model.getModelWithId('cmp-1'); //Передается идентификатор компонента
    calendarModel.on(AS.FORMS.EVENT_TYPE.valueChange, function () {
        var value = calendarModel.getValue();
        console.log(value);
    });
});

Ниже описаны параметры для каждого события.

$EVENT_BUS.subscribe(new EventHandler('FORM_LOADED', handlerUsersSelected));
        function handlerUsersSelected(event, args) {
            console.log("event FORM_LOADED");
            var component = jQuery('img#image_for_portlet');
            if (component === null || component.length === 0) {
                console.log("no success");
                return;
            }
            console.log("success!!");
            console.log(component.parentNode);
            console.log(component);
            var mySpan = document.createElement("div");
            mySpan.innerHTML = "<div id='portlet_div' ><iframe frameborder = "0" height = "100%" id = "portlet1" src = "http://192.168.2.119:8080/widget/web/guest/home/-/meetups" width = "100%" > </iframe ></div > ";
            component.replaceWith(mySpan.innerHTML);
        }
            var checkAgain = function() {
                setTimeout(handlerUsersSelected, 5000);
            };

registryCode:"reg_code"
registryId:"9034810f-5f18-44b9-948a-8f78a5f1ec9d"

<table cellspacing="0" 
       cellpadding="0" 
       synergytest="RegistryTreeElement" 
       registryid="82356e07-a859-49cc-8adf-896c32725810" 
       registrycode="Заявление_о_приеме_на_работу_(вариант_2,_на_двух_языках)" 
       style="display: inline;" 
       class="commonLabelBold">
<colgroup> <col> </colgroup> 
<tbody>
    <tr>
        <td>007 Заявление о приеме на работу на период</td>
        <td style="white-space: nowrap;"></td>
    </tr>
</tbody>
</table>

function onUserChooserCreated(evt, chooser){
        var id = getUserChooserId(chooser.args);
        console.log(id);
}

Для того, чтобы создать экземпляр проигрывателя, необходимо вызвать метод AS.FORMS.createPlayer().

Методы проигрывателя:

Базовая модель.

Базовые свойства модели.

Базовое отображение.

Базовые методы отображения.

Модели и отображения проигрывателя.

Свойства:

Методы:

Свойства:

Методы:

Модели и отображения компонентов.

{
  "id": "cmp-qdg8xo", 
  "type": "numericinput", 
  "value": "2 222,00", //текстовое представление
  "key": "2222.00" //числовое представление
}

{
  "id": "cmp-7gj2xv", 
  "type": "listbox", 
  "value": "наименование выбранного элемента", 
  "key": "значение выбранного элемента"
}

{
  "id": "cmp-7gj2xv", 
  "type": "check", 
  "value": ["значение элемента 1", "значение элемента 2", "значение элемента 3"], 
  "key": ["наименование элемента 1", "наименование элемента 2", "наименование элемента 3]
}

{
  "id": "cmp-7gj2xv", 
  "type": "radio", 
  "value": "значение выбранного элемента", 
  "key": "наименование выбранного элемента"
}

{
  "id": "cmp-pfa3r5", 
  "type": "date", 
  "value": "2016-маусым-15", 
  "key": "2016-06-15 12:07:00"
}

{
  "id": "cmp-d84aev", 
  "type": "file", 
  "value": "Файл.png", //имя файла
  "key": "14064b88-633c-4748-b9c6-9fbf8c8a86e6" //идентификатор файла в хранилище
}

{
  "id": "cmp-7u4wuv", 
  "type": "link", 
  "value": "#submodule=common&action=open_document&document_identifier=${docID}", 
  "key": "Документ; false"
}

{
  "id": "cmp-7gj2xv", 
  "type": "entity", 
  "value": "Фамилия Имя Отчество", 
  "key": "1ba41729-871f-4575-88d8-5a6c3de6297a",
  "formatVersion": "V1",
  "manualTags": {"identifier" : "введенный вручную тэг"}
}

{
  "id": "cmp-7gj2xv", 
  "type": "entity", 
  "value": "formattedName1, formattedName2, formattedName3", 
  "key": "identifier1;identifier2;identifier3",
  "formatVersion": "V1",
  "manualTags": {"identifier1" : "введенный вручную тэг"}
}

{
  "id": "cmp-rgi3pr", 
  "type": "entity", 
  "value": "название должности", 
  "key": "f1af818e-cd5d-4390-9e96-b26dd148e42d",
  "formatVersion": "V1",
  "manualTags": {"identifier" : "введенный вручную тэг"}
}

{
  "id": "cmp-7gj2xv", 
  "type": "entity", 
  "value": "название подразделения", 
  "key": "4a76ae9b-a460-431a-9edc-c9bf2966f2fb",
  "formatVersion": "V1",
  "manualTags": {"identifier" : "введенный вручную тэг"}
}

{
  "id": "cmp-7gj2xv", 
  "type": "entity", 
  "value": "name1;; name1;; name3;; name4", 
  "key": "identifier1;identifier2;identifier3",
  "formatVersion": "V1",
  "manualTags": {"identifier" : "введенный вручную тэг"}
}

{
  "id": "cmp-mqk3ik", 
  "type": "repeater", 
  "value": "Нет",
  "key": "0"
}

{
  "id": "cmp-mqk3ik", 
  "type": "repeater", 
  "value": "По дням недели: Понедельник, Воскресенье",
  "key": "1|1.0;7.0"
}

{
  "id": "cmp-mqk3ik", 
  "type": "repeater", 
  "value": "По дням месяца: 12, 17, 23",
  "key": "2|12.0;17.0;23.0"
}

{
  "id": "cmp-mqk3ik", 
  "type": "repeater", 
  "value": "Ежегодно: 4.1, 5.11, 7.12, 9.30",
  "key": "4|1.4; 11.5; 12.7; 30.9"
}

{
  "id": "cmp-7gj2xv", 
  "type": "projectlink", 
  "value": "Проект: %название%", //для портфеля "Портфель: %название%"
  "key": "00e24c3d-d3de-423a-9b86-5d501975b922", 
  "valueID": "00e24c3d-d3de-423a-9b86-5d501975b922"
}

{
  "id": "cmp-6vrrkp", 
  "type": "reglink", 
  "value": "1111-GPON", //значащее содержимое через «-»
  "key": "a1b478c0-2d33-11e6-b327-3085a93a6496", 
  "valueID": "a1b478c0-2d33-11e6-b327-3085a93a6496",
  "username": "Admin Admin Admin",
  "userID": "1"
}

{
  "id": "cmp-7gj2xv", 
  "type": "personlink", 
  "value": "Фамилия Имя Отчество (Организация)", //для организации "Организация (Адрес)"
  "key": "0:idenitifier", 
  "valueID": "0:identifier"
}

{
  "id": "cmp-5hpcpy", 
  "type": "filelink", 
  "value": "Файл.pdf", //название файла
  "key": "36afa2d9-cd78-4638-8132-773a69ff0c55" //идентификатор файла
}

События:

Методы:

Методы:

Методы AS.FORMS.ApiUtils:

Методы AS.FORMS.ASFDataUtils:

Методы AS.FORMS.DateUtils:

Методы AS.FORMS.ComponentUtils:

Перед созданием нового компонента необходимо определиться со следующими вопросами:

Ответив на эти вопросы, можно приступить к написанию компонента.

Предположим, нужно хранить в качестве значения компонента 3 поля:

Таким образом, в переменной value модели будет объект, содержащий эти 3 поля. Например:

value = { identifier : 1, name : «Наименование», info : «Дополнительная информация» }

Данный объект необходимо передавать в метод модели setValue, а получать в методе модели getValue.

Чтобы эти данные сохранялись в файл по форме и поднимались при последующем открытии, необходимо реализовать 2 метода модели:

Необходимо учесть, что поля сохраняемого объекта asfData могут иметь лишь следующий перечень наименований:

Все эти поля необязательны, но объект, сохраняемый в файле по форме, может иметь только такие свойства.

Пример реализации этих методов:

model.getAsfData = function(blockNumber){
    if(model.getValue()) {
        /*следующий метод сформирует правильную запись для сохранения в файле по форме 
           при этом:
            model.getValue().title — запишется в поле value
            model.getValue().value — запишется в поле key*/
        var result = AS.FORMS.ASFDataUtils.getBaseAsfData(model.asfProperty, blockNumber, model.getValue().name , model.getValue().identifier);
        /* дописываем необходимую информацию в поле valueID*/
        result.valueID = model.getValue().info ;
        return result;
    } else {
        return AS.FORMS.ASFDataUtils.getBaseAsfData(model.asfProperty, blockNumber);
    }
};

model.setAsfData = function(asfData){
    if(!asfData || !asfData.value) {
        return;
    }
    /*читаем данные из объекта из файла по форме: дополнительная информация была сохранена в поле valueID и теперь читаем из него*/
    var value = { value : asfData.key, title : asfData.value, info : asfData.valueID};

    model.setValue(value);
};

Далее необходимо определить список специальных ошибок. Например, пользователь может выбирать значениями с некоторыми идентификаторами . Для этого необходимо переопределить метод модели getSpecialErrors.

model.getSpecialErrors = function() {
    if(model.getValue()) {
        if(model.getValue().identifier == '0') {
            return {id : model.asfProperty.id, errorCode : AS.FORMS.INPUT_ERROR_TYPE.wrongValue};
        }
    }
};

В данном примере проверяется, является ли значение идентификатора равным 0. Если да, то это значит, что компонент неправильно заполнен и возвращается ошибка. Synergy при этом будет показывать, что данные заполнены некорректно.

Работа с моделью теперь завершена.

Далее будем работать с отображением.

Предположим, что на вопрос №3 даны следующие ответы:

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

В области видимости есть переменная editable:

Для режима просмотра достаточно иметь div, куда будет вставлено тестовое описание поля, и реализовать метод updateValueFromModel.

Пример:

var textView = jQuery('<div>', {class : "asf-label"});
view.container.append(textView);
view.updateValueFromModel = function(){
    textView.html(model.getValue().name);
};

Создается div, который добавляется в контейнер компонента. При любом изменении модели автоматически вызовется метод updateValueFromModel и значение изменится.

Для режима редактирования необходимо создать div, кнопку, а также реализовать методы updateValueFromModel, markInvalid, unmarkInvalid.

Пример:

/**
 * инициализируем внешний вид компонента, див и кнопку
 */
var inputView = jQuery('<div>', {class : "asf-label", style : "width:calc(100% - 30px)"});
var button = jQuery('<button>', {class : "asf-browseButton"});
view.container.append(inputView);
view.container.append(button);
/**
 * обновляем значение отображения в зависимости от значения модели
 */
view.updateValueFromModel = function(){
    inputView.html(model.getValue().name);
};
/**
 * метод помечает поле как неправильно заполненное
 */
view.markInvalid = function(){
   button.css("background-color", "#aa3344");
};
/**
 * метод убирает пометку неправильно заполненного поля
 */
view.unmarkInvalid = function(){
    button.css("background-color", "");
};
/**
 * вызываем какой-нибудь диалог выбора пользователя
 */
button.onclick(function(){
    var value = {identifier : "1", name : "name "+math.rand(), info : "additional info"};   // тут прописывается какая-нибудь логика получения этого значения
    model.setValue(value);
});