Добро пожаловать

Это документация о практиках использования uAPI для Пользовательских сценариев в системе Heado со всеми прикладными элементами (Событиями, Шлюзами e.t.c.) Если вы ещё не имеете представления о чём идёт речь - обратите внимание на раздел Настройки / Задачи & Расширения, доступный под вашим рутовым аккаунтом Heado. В данном разделе происходит большая часть магии, связанной с созданием рутин, под названием "Дисциплины", позволяющих автоматизированно ставить на сотрудников Компании новые задачи, обрабатывать отчёты Сотрудников и обрабатывать статус Задач на основе полученных данных по их завершению.

Как читать документацию

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

Мы разделили общую структуру на несколько основных категорий:

Секция Первые шаги содержит основную информацию о том, как начать работу с Пользовательскими Сценариями и основными возможностями их применения в деле автоматической обработки данных и постановки Задач.
В секции uAPI непосредственно описывается спецификация работы с API Пользовательских Сценариев: объекты, методы, свойства и примеры их применения. Так же в первых главах вы найдёте информацию об ограничениях платформы и нюансах используемого в сценариях языка программирования (Lua 5.1)
Шлюзы данных - здесь описывается общий концепт работы с этим расширением, позволяющим описывать модели пользовательских данных и исползовать их как расширение основных данных Heado
В Практиках применения рассматриваются наиболее наглядные варианты применения uAPI, Шлюзов данных в совокупности в Пользовательских Сценариях.
Секция Глоссарий раскроет секреты специфичных терминологий платформы Heado, в случае, если вы ещё с ними не встречались, здесь перечисляется большая часть элементов и сущностей, с которыми вам предстоит встретиться на пути реализации своих первых Пользовательских Сценариев.

Что в итоге?

Вы научитесь применять расширения платформы Heado для автоматизации специализированных бизнес-процессов любой Компании. Если вы разработчик Компании - вы сможете снизить издержки переноса новых бизнес-сценариев и источников данных, используемых в вашей Компании в платформу Heado. В случае, если вы интегратор - вы сможете инкорпорировать свои решения в платформу Heado в виде готовых рецептов/решений, что позволит легко масштабировать их без раздражающей рутины.