Alpha.Community

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

Приложение A: Примеры использования функций библиотеки

Вход в систему и получение прав

Пример использования:

Logon("login", "********", "http://127.0.0.1:5000")

Возвращаемое значение (пример):

Доступ разрешен

Получение секретной строки

Пример использования:

GetAuthString()

Возвращаемое значение (пример):

eyJzZXJ2ZXIiOiJodHRwOi8vMTI3LjAuMC4xOjUwMDAiLCJwYXNzd29yZCI6IjYwMTNlNjc1NjFmYmEwMmUwMjlhOTgwNGFjNWZkNDYzIiwidXNlciI6ImFkbWluIn0=

Выход из системы

Пример использования:

Logoff("login")

Возвращаемое значение: отсутствует.

Получение текста последней ошибки

Пример использования:

GetLastErrorText()

Возвращаемое значение (пример):

Аутентификация не выполнена

Получение списка шаблонов отчётов в формате json

Пример использования:

GetReportTemplates()

Возвращаемое значение (пример):

[
  {
    "id": "3433d95e-0a2d-43f8-a582-6d95b3898afe",
    "name": "mt",
    "description": ""
  },{
    "id": "d315a931-e6f4-49d0-8676-434fc174ef10",
    "name": "HMItest",
    "description": "Template for testing HMI functions"
  }
]

Получение списка переменных отчёта в формате json

Пример использования:

GetReportArguments("d315a931-e6f4-49d0-8676-434fc174ef10")

Возвращаемое значение (пример):

[{"Name":"test_c","Description":"","Type":{"id":5,"Name":"Catalog"},"CatalogType":{"id":"57ae1976-3b2a-4fb3-b9db-a472cd4e5ef5","name":"hmi","description":"","items":[{"id":"a91be483-7f84-49c3-b940-84e5a4341df1","value":1,"name":"foo","description":"","parentID":null,"setId":"57ae1976-3b2a-4fb3-b9db-a472cd4e5ef5"},{"id":"efd2a14f-ba83-4cd6-b65d-6ded7578c614","value":2,"name":"bar","description":"","parentID":null,"setId":"57ae1976-3b2a-4fb3-b9db-a472cd4e5ef5"},{"id":"6eead513-bf71-4b94-a0fd-c707d7276cb3","value":4,"name":"baz","description":"","parentID":null,"setId":"57ae1976-3b2a-4fb3-b9db-a472cd4e5ef5"},{"id":"4642b84d-cfcf-4fef-afa3-3b7f734facd5","value":8,"name":"qux","description":"","parentID":null,"setId":"57ae1976-3b2a-4fb3-b9db-a472cd4e5ef5"}]},"Default":{"id":"efd2a14f-ba83-4cd6-b65d-6ded7578c614","value":2,"name":"bar","description":"","parentID":null,"setId":"57ae1976-3b2a-4fb3-b9db-a472cd4e5ef5"},"AddToFileName":true},{"Name":"test_t","Description":"","Type":{"id":4,"Name":"Time"},"Default":"3/17/2025, 4:20:00 AM","AddToFileName":true},{"Name":"test_d","Description":"","Type":{"id":3,"Name":"Date"},"Default":"3/12/2025, 12:00:00 AM","AddToFileName":true},{"Name":"test_n","Description":"","Type":{"id":2,"Name":"Number"},"Default":"3.1415926","AddToFileName":true},{"Name":"test_s","Description":"","Type":{"id":1,"Name":"String"},"Default":"foo... bar","AddToFileName":true},{"Name":"test_dt","Description":"desc","Type":{"id":0,"Name":"Date/Time"},"CatalogType":"","Default":"3/16/2025, 12:00:00 AM","AddToFileName":true}]

Получение списка файлов, сгенерированных по шаблону

Пример использования:

GetReportFiles("d315a931-e6f4-49d0-8676-434fc174ef10")

Возвращаемое значение (пример):

[
  {
    "id": "7fb5d8bf-1d02-41a7-9879-9180acb7363b",
    "date": "2025-03-17T17:45:00",
    "name": "HMItest_17.03.2025%2017%3A45%3A00.pdf",
    "length": 976732,
    "subs": false
  },{
    "id": "306bf216-2fc7-46d3-a4c4-e5261ccbd455",
    "date": "2025-03-17T17:50:00",
    "name": "HMItest_17.03.2025%2017%3A50%3A00.pdf",
    "length": 976730,
    "subs": false
  },{
    "id": "d1080e07-5d84-4029-8e01-cc8cf8998610",
    "date": "2025-03-17T18:00:00",
    "name": "HMItest_17.03.2025%2018%3A00%3A00.pdf",
    "length": 976733,
    "subs": false
  }
]

Параметр subs – признак того, что файл сгенерирован по событию.

Получение списка файлов, сгенерированных по шаблону, с фильтрацией по дате создания

Пример использования:

GetReportFilesByDate("d315a931-e6f4-49d0-8676-434fc174ef10", "2025-03-17 17:00:00", "2025-03-17 17:59:59")

Возвращаемое значение (пример):

[
  {
    "id": "7fb5d8bf-1d02-41a7-9879-9180acb7363b",
    "date": "2025-03-17T17:45:00",
    "name": "HMItest_17.03.2025%2017%3A45%3A00.pdf",
    "length": 976732,
    "subs": false
  },{
    "id": "306bf216-2fc7-46d3-a4c4-e5261ccbd455",
    "date": "2025-03-17T17:50:00",
    "name": "HMItest_17.03.2025%2017%3A50%3A00.pdf",
    "length": 976730,
    "subs": false
  }
]

Получение файла отчёта в формате PDF

Пример использования:

GetReportFileInPDF("d315a931-e6f4-49d0-8676-434fc174ef10", "<json>")

где <json> – json-строка, аналогичная той, что получили при вызове функции GetReportArguments, но с подставлением нужнымх значений в поля Default. Пример json-строки (отступы и переносы строк добавлены для удобства восприятия):

"[
  {
    "Name": "test_c",
    "Description": "",
    "Type": {"id": 5, "Name": "Catalog"},
    "CatalogType":
    {
      "id": "57ae1976-3b2a-4fb3-b9db-a472cd4e5ef5",
      "name": "hmi",
      "description": "",
      "items":
      [
        {
          "id": "a91be483-7f84-49c3-b940-84e5a4341df1",
          "value": 1,
          "name": "foo",
          "description": "",
          "parentID": null,
          "setId": "57ae1976-3b2a-4fb3-b9db-a472cd4e5ef5"
        }, {
          "id": "efd2a14f-ba83-4cd6-b65d-6ded7578c614",
          "value": 2,
          "name": "bar",
          "description": "",
          "parentID": null,
          "setId": "57ae1976-3b2a-4fb3-b9db-a472cd4e5ef5"
        }, {
          "id": "6eead513-bf71-4b94-a0fd-c707d7276cb3",
          "value": 4,
          "name": "baz",
          "description": "",
          "parentID": null,
          "setId": "57ae1976-3b2a-4fb3-b9db-a472cd4e5ef5"
        }, {
          "id": "4642b84d-cfcf-4fef-afa3-3b7f734facd5",
          "value": 8,
          "name": "qux",
          "description": "",
          "parentID": null,
          "setId": "57ae1976-3b2a-4fb3-b9db-a472cd4e5ef5"
        }
      ]
    },
    "Default":
    {
      "id": "4642b84d-cfcf-4fef-afa3-3b7f734facd5",
      "value": 8,
      "name": "qux",
      "description": "",
      "parentID": null,
      "setId": "57ae1976-3b2a-4fb3-b9db-a472cd4e5ef5"
    },
    "AddToFileName": false
  }, {
    "Name": "test_t",
    "Description": "",
    "Type": {"id": 4, "Name": "Time"},
    "Default": "*",
    "AddToFileName": true
  }, {
    "Name": "test_d",
    "Description": "",
    "Type": {"id": 3, "Name": "Date"},
    "Default": "*",
    "AddToFileName": true
  }, {
    "Name": "test_n",
    "Description": "",
    "Type": {"id": 2, "Name": "Number"},
    "Default": "666",
    "AddToFileName": true
  }, {
    "Name": "test_s",
    "Description": "",
    "Type": {"id": 1, "Name": "String"},
      "Default": "Thou shalt not make unto thee any graven image",
      "AddToFileName": false
  }, {
      "Name": "test_dt",
      "Description": "desc",
      "Type": {"id": 0, "Name": "Date/Time"},
      "CatalogType": "",
      "Default": "*+1d-2h",
      "AddToFileName": true
  }
]

Возвращаемое значение: строка – представление PDF-файла в стандарте base64.

Генерация отчёта и сохранение его в базу данных

Пример использования:

GetReport("d315a931-e6f4-49d0-8676-434fc174ef10", "<json>")

где <json> – json-строка, аналогичная той, что была в примере выше.

Возвращаемое значение – идентификатор файла в базе данных (он же – поле id в возвращаемом значении функции GetReportFiles):

19562314-f9d7-4f62-af5e-4f6468b4a583