Alpha.Community

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

Функции

Load

void Load(string uid)

Загружает информацию о группе из подсистемы безопасности в элемент.

Входной параметр – уникальный идентификатор (uid) группы вида alpha:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (тип значения – string).

Вызов: SecurityManagerGroup.Load("alpha:d01969e0-ae05-4548-9375-2533b326a588")

Результат:

  • в случае успешного завершения операции активируется событие LoadComplete;
  • в случае неуспешного завершения операции активируется событие LoadFailed.

Save

void Save()

Отправляет информацию о группе в подсистему безопасности после:

  • редактирования ранее выгруженной из подсистемы безопасности группы;
  • создания группы из проекта Alpha.HMI с помощью функции New() и свойств элемента.

Функция не требует входных параметров.

Вызов: SecurityManagerGroup.Save()

Результат:

  • в случае успешного завершения операции активируется событие SaveComplete;
  • в случае неуспешного завершения операции активируется событие SaveFailed.

GetMembersList

string GetMembersList()

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

Функция не требует входных параметров.

Возвращает данные в JSON-формате, где:

  • memberID - уникальный идентификатор (uid) участника группы вида alpha:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx; 
  • memberName - логин участника группы;
  • memberType - значение этого атрибута указывает, является участник пользователем или дочерней группой:
    • 0 - пользователь;
    • 1 - дочерняя группа.

Вызов: SecurityManagerGroup.GetMembersList()

Результат запроса списка групп в JSON-формате:

{
 "data": [
  {
   "memberID": "alpha:3fbc8d1f-8384-4b19-933b-0d4f0dc59c10",
   "memberName": "ivanov",
   "memberType": "0"
  },
  {
   "memberID": "alpha:dd13c739-1387-4f06-8087-cb437f577def",
   "memberName": "krylov",
   "memberType": "0"
  }
 ]
}

GetApplicationsList

string GetApplicationsList()

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

Функция не требует входных параметров.

Возвращает данные в JSON-формате.

Вызов: SecurityManagerGroup.GetApplicationsList()

Результат запроса списка групп в JSON-формате:

{
 "data": [
  {
   "appID": "Управление состоянием оборудования",
   "appName": "Управление состоянием оборудования"
  }
 ]
}

GroupRoles

string GroupRoles(string appID)

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

Входной параметр – ID приложения, из которого требуется получить список ролей (тип значения – string).

Возвращает данные в JSON-формате.

Вызов: SecurityManagerGroup.GroupRoles("Управление состоянием оборудования")

Результат запроса списка приложений в JSON-формате:

{
 "data": [
  {
   "roleID": "alpha:ec5b145e-7d43-4c18-934c-1da6d4cb407f",
   "roleName": "rolename"
  }
 ]
}

GroupRights

string GroupRights(string appID)

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

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

Возвращает данные в JSON-формате. Для строковых прав значения (если их несколько) разделены сочетанием символов \n.

Для получения списка эффективных прав используйте функцию GroupEffectiveRights.

Вызов: SecurityManagerGroup.GroupRights("Управление состоянием оборудования")

Результат запроса списка приложений в JSON-формате:

{
 "data": [
  {
   "appName": "Управление состоянием оборудования",
   "tokenType": "bool",
   "tokenName": "Управление резервуаром",
   "tokenDescription": "Право управления резервуаром",
   "ownerId": "alpha:07dba445-1903-498c-abdf-af7f55c145c4",
   "tokenValueAllow": "TRUE",
   "tokenValueDeny": "FALSE"
  }
 ]
}

GroupEffectiveRights

string GroupEffectiveRights(string appID)

Предоставляет список эффективных прав группы, загруженной в элемент, из указанного приложения.

Входной параметр – ID приложения, из которого требуется получить список эффективных прав (тип значения – string).

Возвращает данные в JSON-формате. Для строковых прав значения (если их несколько) разделены сочетанием символов \n.

Вызов: SecurityManagerGroup.GroupEffectiveRights("Управление состоянием оборудования")

Результат запроса списка приложений в JSON-формате:

{
 "data": [
  {
   "appName": "Управление состоянием оборудования",
   "tokenType": "bool",
   "tokenName": "Управление резервуаром",
   "tokenDescription": "Право управления резервуаром",
   "ownerId": "alpha:07dba445-1903-498c-abdf-af7f55c145c4",
   "tokenValueAllow": "TRUE",
   "tokenValueDeny": "FALSE"
  }
 ]
}

New

void New()

Освобождает элемент от загруженной в него информации для создания новой группы.

Функция не требует входных параметров.

Вызов: SecurityManagerGroup.New()

После создания новой группы не забудьте загрузить её в подсистему безопасности с помощью функции Save().

AddRole

void AddRole(string roleUID)

Назначает указанную роль группе, загруженной в элемент.

Входной параметр – уникальный идентификатор (uid) роли вида alpha:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (тип значения – string).

Вызов: SecurityManagerGroup.AddRole("alpha:4ce9483e-e137-41c2-bf1c-343e9b731f20")

DeleteRole

void DeleteRole(string roleUID)

Лишает указанной роли группу, загруженную в элемент.

Входной параметр – уникальный идентификатор (uid) роли вида alpha:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (тип значения – string).

Вызов: SecurityManagerGroup.DeleteRole("alpha:4ce9483e-e137-41c2-bf1c-343e9b731f20")

AddRight

void AddRight(string appID, string rightName, uint1 rightType, string allowedValue, string forbidenValue)

Назначает право группе, загруженной в элемент.

Входные параметры:

  • ID приложения, содержащего право (тип значения – string);
  • имя права (тип значения – string);
  • тип права (тип значения – uint1):
    • 0 – строковый;
    • 1 – логический;
  • разрешающее значение права (тип значения – string);
  • запрещающее значение права (тип значения – string).

Для строковых прав значения (если их несколько) можно разделить с помощью сочетания символов \n. Пример: "значение1\nзначение2\nзначение3".

Вызов: SecurityManagerGroup.AddRight("Управление состоянием оборудования","Управление насосом",1,"true","false"

ChangeRight

void ChangeRight(string appID, string rightName, string allowedValue, string forbidenValue)

Меняет значения прав группы, загруженной в элемент.

Входные параметры:

  • ID приложения, содержащего право (тип значения – string);
  • имя права (тип значения – string);
  • новое разрешающее значение права (тип значения – string);
  • новое запрещающее значение права (тип значения – string).

Для строковых прав значения (если их несколько) можно разделить с помощью сочетания символов \n. Пример: "значение1\nзначение2\nзначение3".

Вызов: SecurityManagerGroup.ChangeRight("Управление состоянием оборудования","Управление насосом","false","true")

DeleteRight

void DeleteRight(string appID, string rightName)

Лишает права группу, загруженную в элемент.

Входные параметры:

  • ID приложения, содержащего право (тип значения – string);
  • имя права (тип значения – string).

Вызов: SecurityManagerGroup.DeleteRight("Управление состоянием оборудования","Управление насосом")

GetErrorDescriptionByCode

string GetErrorDescriptionByCode(uint1 FailReasonCode)

Возвращает текстовое описание ошибок, возникающих при загрузке и сохранении групп.

Входной параметр - переменная FailReasonCode (тип значения – uint1).