Alpha.Community

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

Функции

Load

void Load(string appID)

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

Входной параметр – ID приложения (тип значения – string).

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

Результат:

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

Save

void Save()

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

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

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

Вызов: SecurityManagerApplication.Save()

Результат:

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

GetTokensList

string GetTokensList()

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

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

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

Вызов: SecurityManagerApplication.GetTokensList()

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

{
 "data": [
  {
   "tokenID": "Управление насосом",
   "tokenType": "bool",
   "tokenName": "Управление насосом",
   "tokenDescription": "Право доступа к насосу",
   "tokenValues": [
    {
     "allow": "FALSE",
     "deny": "TRUE",
     "subjects": [
      {
       "type": "group",
       "name": "Диспетчеры"
      }
     ]
    },
    {
     "allow": "TRUE",
     "deny": "FALSE",
     "subjects": [
      {
       "type": "user",
       "name": "petrov"
      },
      {
       "type": "group",
       "name": "Операторы"
      },
      {
       "type": "role",
       "name": "Начальник участка"
      }
     ]
    }
   ]
  }
 ]
}

GetRolesList

string GetRolesList()

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

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

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

Вызов: SecurityManagerApplication.GetRolesList()

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

{
 "data": [
  {
   "roleID": "alpha:4ce9483e-e137-41c2-bf1c-343e9b731f20",
   "roleName": "dispatcher"
  }
 ]
}

GetRoleRights

string GetRoleRights(string roleUID)

Предоставляет список прав, назначенных текущей роли.

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

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

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

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

{
 "data": [
  {
   "appName": "Управление состоянием оборудования",
   "tokenType": "bool",
   "tokenName": "Управление резервуаром",
   "tokenDescription": "Право управления резервуаром",
   "ownerId": "alpha:4ce9483e-e137-41c2-bf1c-343e9b731f20",
   "tokenValueAllow": "TRUE",
   "tokenValueDeny": "FALSE"
  },
  {
   "appName": "Управление состоянием оборудования",
   "tokenType": "bool",
   "tokenName": "Управление насосом",
   "tokenDescription": "Право управления насосом",
   "ownerId": "alpha:4ce9483e-e137-41c2-bf1c-343e9b731f20",
   "tokenValueAllow": "FALSE",
   "tokenValueDeny": "TRUE"
  }
 ]
}

New

void New()

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

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

Вызов: SecurityManagerApplication.New()

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

CreateToken

void CreateToken(uint1 tokenType, string tokenName, string decsription)

Создает право в приложении, загруженном в элемент.

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

  • тип права (тип значения – uint1):
    • 0 – строковое;
    • 1 – логическое;
  • имя права (тип значения – string);
  • описание (тип значения – string).

Вызов: SecurityManagerApplication.CreateToken(1,"right","description")

ChangeToken

void ChangeToken(string tokenID, uint1 tokenType, string tokenName, string decsription)

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

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

  • ID права (тип значения – string);
  • тип права (тип значения – uint1):
    • 0 – строковое;
    • 1 – логическое;
  • новое имя права (тип значения – string);
  • новое описание права (тип значения – string).

Вызов: SecurityManagerApplication.ChangeToken("tokenID",1,"newname","newdescription")

Входной параметр тип права не будет требоваться в будущих версиях.

DeleteToken

void DeleteToken(string tokenID)

Удаляет право из приложения, загруженного в элемент.

Входной параметр – ID права (тип значения – string).

Вызов: SecurityManagerApplication.DeleteToken("right")

CreateRole

void CreateRole(string roleName, string appName)

Создает роль в указанном приложении.

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

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

Вызов: SecurityManagerApplication.CreateRole("role","app")

ChangeRole

void ChangeRole(string roleUID, string roleName)

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

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

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

Вызов: SecurityManagerApplication.ChangeRole("alpha:4ce9483e-e137-41c2-bf1c-343e9b731f20","newrolename")

DeleteRole

void DeleteRole(string roleUID)

Удаляет роль из приложения, загруженного в элемент.

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

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

RoleAddRight

void RoleAddRight(string appName, string roleUID, string rightName, uint1 rightType, string allowedValue, string forbidenValue)

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

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

  • имя приложения (тип значения – string);
  • уникальный идентификатор (uid) роли вида alpha:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (тип значения – string);
  • имя права (тип значения – string);
  • тип права (тип значения – uint1):
    • 0 – строковое;
    • 1 – логическое;
  • разрешающее значение (тип значения – string);
  • запрещающее значение (тип значения – string).

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

Вызов: SecurityManagerApplication.RoleAddRight("appname","alpha:4ce9483e-e137-41c2-bf1c-343e9b731f20","pravo",0,"открыто","закрыто")

RoleChangeRight

void RoleChangeRight(string appName, string roleUID, string rightName, string allowedValue, string forbidenValue)

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

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

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

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

Вызов: SecurityManagerApplication.RoleChangeRight("appname","alpha:4ce9483e-e137-41c2-bf1c-343e9b731f20","pravo","закрыто","открыто")

RoleDeleteRight

void RoleDeleteRight(string appName, string roleUID, string rightName)

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

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

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

Вызов: SecurityManagerApplication.RoleDeleteRight("appname","alpha:4ce9483e-e137-41c2-bf1c-343e9b731f20","pravo")

GetErrorDescriptionByCode

string GetErrorDescriptionByCode(uint1 FailReasonCode)

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

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