appsettings.json

Шаблон

{
  "Serilog": {
    "MinimumLevel": "Warning",
    "WriteTo": [
      {
        "Name": "Async",
        "Args": {
          "configure": [
            {
              "Name": "RollingFile",
              "Args": {
                "pathFormat": "Logs\\log-{Date}.txt",
                "fileSizeLimitBytes": null,
                "retainedFileCountLimit": null,
                "outputTemplate": "{Timestamp:o} [{Level:u3}] {SourceContext} ({RequestId}/{ThreadId}) {Message}{NewLine}{Exception}{NewLine}",
                "buffered": false
              }
            },
            {
              "Name": "LiterateConsole",
              "Args": {
                "outputTemplate": "{Timestamp:o} [{Level:u3}] {SourceContext} ({RequestId}/{ThreadId}) {Message}{NewLine}{Exception}{NewLine}"
              }
            },
            { "Name": "Debug" },
            {
              "Name": "EventLog",
              "Args": {
                "logName": "Workflow Technology",
                "source": "Workflow Web Forms",
                "outputTemplate": "{Timestamp:o}{NewLine}[{Level:u3}] {SourceContext} ({RequestId}/{ThreadId}){NewLine}{Message}{NewLine}{Exception}{NewLine}"
              }
            }
          ]
        }
      }
    ],
    "Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId", "WithRequestId" ]
  },
  "AllowedHosts": "*",
  "FormsAppParameters": {
    "ServerUrl": "http://localhost:50002",
    "ConnectionTimeout": "00:05:00",
    "HostUrl": "http://192.168.7.88:4990",
    "StartAssembly": "Carrent",
    "XmlFolder": "D:\\WorkflowTechnology\\Clients\\Carrent\\Projects\\1. Carrent\\WebForms",
    "TempFileFolder": "D:\\Web\\TempFile",
    "EngineOnSameMachine": true,
    "EngineStorages": [ "D:\\WorkflowEngine\\Carrent.v3\\Upload" ],
    "SystemLocale": "en-US",
    "Translate": false,
    "HelpDeskEnabled": true,
    "LoginPageUrl": "login",
    "TimeoutEnabled": true,
    "TimeoutInterval":  240,
    "AnonymousUserName": "WS_GUEST",
    "AnonymousPassword": "123",
    "LogLocale": "en-US",
    "DebugMode": false,
    "DebugPath": "D:\DebugDC"
  }
}

Серверная часть

ServerUrl

IP-адрес (или доменное имя) и порт серверной части, к которой будет обращаться клиентская часть.

Обязательное поле. Ожидается URL-адрес.

Значение по умолчанию: отсутствует

"ServerUrl": "http://localhost:50002"

ConnectionTimeout

Задает значение Timeout для попытки установления соединения с сервером.

Необязательное поле. Любое значение будет переведено в текстовое.

Значение по умолчанию: "00:05:00"

"ConnectionTimeout": "00:02:00"

Настройки Web-службы

HostUrl

IP-адрес (или доменное имя) и порт, на котором будет запущено Web-приложения и доступно для работы в браузере.

Необязательное поле. Ожидается URL-адрес.

Значение по умолчанию: "http://localhost:4990/"

"HostUrl": "http://192.168.7.88:4990"

StartAssembly

Задает имя библиотеки, в которой описывается шаблон web-страницы. На основе этого шаблона будут генерироваться web-страницы.

Необязательное поле. Любое значение будет переведено в текстовое.

Значение по умолчанию: "WorkflowWebForms.dll"

"StartAssembly": "Carrent"

XmlFolder

Абсолютный путь до папки с xml-файлами форм и вложенной папкой Images, содержащей графические файлы. Из этих xml-файлов будут генерироваться web-страницы.

Стартовая страница web-приложения задается атрибутом StartPage в тэге <Form> xml-файла.

Если несколько форм имеют атрибут StartPage со значением True, то это приведет к некорректной маршрутизации.

Если ни одна из форм не имеет атрибут StartPage со значением True, то попытка обращения к стартовой странице вызовет ошибку 404 (страница не найдена).

Обязательное поле. Ожидается абсолютный путь до папки.

Значение по умолчанию: отсутствует

"XmlFolder": "D:\\WorkflowTechnology\\Carrent\\Projects\\1. Carrent\\WebForms"

TempFileFolder

Задает путь до папки, куда будут загружаться временные файлы web-службы. Временные файлы - любые файлы, которые служба получает для последующей передачи пользователю, или файлы прикрепляемые в команде EmailSendCommand.

Если web-служба и серверная часть (служба Engine) находятся на разных компьютерах, то все системные файлы и файлы загруженные пользователями, должны быть скачаны web-службой на свой компьютер в папку временных файлов. Затем web-служба сможет использовать эти файлы, чтобы предоставлять их клиенту.

Если web-служба и серверная часть (служба Engine) находятся на одном компьютере, то это отмечается в настройке EngineOnSameMachine, а в настройке EngineStorages перечисляются пути до всех папок, в которых могут храниться файлы.

Необязательное поле. Ожидается абсолютный путь до папки.

Значение по умолчанию: "TempFile"

"TempFileFolder": "D:\\Web\\TempFile"

Если используется значение по умолчанию, то в корневой папке приложения WorkflowWebForms будет создана директория TempFile, куда будут загружаться временные файлы веб-службы.

EngineOnSameMachine

Признак, отмечающий, что web-служба и серверная часть приложения будут запущены на разных компьютерах.

Необязательное поле. Ожидается логическое значение.

Значение по умолчанию: false

"EngineOnSameMachine": true

EngineStorages

Задает список абсолютных путей до папок, в которых хранятся системные файлы и файлы, загруженные клиентами. Используется, если настройка EngineOnSameMachine имеет значение True.

Если web-службе нужно найти определенный файл, то она последовательно пройдет по всем каталогам, указанным в настройке, пока не найдет файл.

Необязательное поле. Ожидается линейный массив путей до папок.

Значение по умолчанию: отсутствует.

"EngineStorages": [ "D:\\WorkflowEngine\\Carrent.v3\\Upload" ]

SystemLocale

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

Необязательное поле. Ожидается одно из допустимых значение:

en-US

английский (США)

ru-RU

русский (Россия)

Значение по умолчанию: "en-US"

"SystemLocale": "en-US"

Translate

Признак, определяющий будет ли работать автоперевод страниц в браузере.

Необязательное поле. Ожидается логическое значение.

Значение по умолчанию: true

"Translate": false

HelpDeskEnabled

Признак, включающий возможность отправлять обращения в сервис HelpDesk.

Необязательное поле. Ожидается логическое значение.

Значение по умолчанию: true

"HelpDeskEnabled": false

Аутентификация

LoginPageUrl

Задает адрес web-страницы, на которую будет перенаправляться пользователь если еще не прошел аутентификацию, или не проявлял активности в течение времени, указанного в настройке TimeoutInterval.

Необязательное поле. Любое значение будет переведено в текстовое.

Значение по умолчанию: "login"

"LoginPageUrl": "login"

TimeoutEnabled

Признак, включающий механизм повторной аутентификации если пользователь не проявлял активности в течение времени, указанного в настройке TimeoutInterval.

Необязательное поле. Ожидается логическое значение.

Значение по умолчанию: false

"TimeoutEnabled": true

TimeoutInterval

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

Необязательное поле. Ожидается положительное целочисленное значение.

Значение по умолчанию: 240

"TimeoutInterval":  240

Анонимный пользователь

Анонимная учетка необходима для подписания запросов к серверной части, когда пользователь не авторизовался в приложении. Например, запрос на получение списка пользователей для окна входа в программу.

AnonymousUserName

Логин анонимного пользователя.

Необязательное поле. Любое значение будет переведено в текстовое.

Значение по умолчанию: "WS_GUEST"

"AnonymousUserName": "WS_GUEST"

AnonymousPassword

Пароль анонимного пользователя.

Необязательное поле. Любое значение будет переведено в текстовое.

Значение по умолчанию: "wsGuestPwd123"

"AnonymousPassword": "wsGuestPwd123"

Настройки логирования

LogLocale

Задает код культуры, который определяет язык сообщений об ошибке публикуемых в журнале событий Windows.

Необязательное поле. Ожидается одно из допустимых значение:

en-US

английский (США)

ru-RU

русский (Россия)

Значение по умолчанию: "en-US"

"LogLocale": "en-US"

Serilog

Настройка логирования. Подробнее на github.com.

"Serilog": {
  "MinimumLevel": "Warning",
  "WriteTo": [
    {
      "Name": "Async",
      "Args": {
        "configure": [
          {
            "Name": "RollingFile",
            "Args": {
              "pathFormat": "Logs\\log-{Date}.txt",
              "fileSizeLimitBytes": null,
              "retainedFileCountLimit": null,
              "outputTemplate": "{Timestamp:o} [{Level:u3}] {SourceContext} ({RequestId}/{ThreadId}) {Message}{NewLine}{Exception}{NewLine}",
              "buffered": false
            }
          },
          {
            "Name": "LiterateConsole",
            "Args": {
              "outputTemplate": "{Timestamp:o} [{Level:u3}] {SourceContext} ({RequestId}/{ThreadId}) {Message}{NewLine}{Exception}{NewLine}"
            }
          },
          { "Name": "Debug" },
          {
            "Name": "EventLog",
            "Args": {
              "logName": "Workflow Technology",
              "source": "Workflow Web Forms",
              "outputTemplate": "{Timestamp:o}{NewLine}[{Level:u3}] {SourceContext} ({RequestId}/{ThreadId}){NewLine}{Message}{NewLine}{Exception}{NewLine}"
            }
          }
        ]
      }
    }
  ],
  "Enrich": [ "FromLogContext", "WithMachineName", "WithThreadId", "WithRequestId" ]

Отладка

В режиме отладки формы пишут в файлы информацию:

время начала и время окончания выполнения команд;
время начала и время окончания загрузки данных;
результаты проверки условий;
результат выполнения Execution.

Для работы с логами отладки используется дополнительная утилита - WorkflowVisualizer.

DebugMode

Признак, включающий на клиентской части режим отладки.

Необязательное поле. Ожидается логическое значение.

Значение по умолчанию: false

"DebugMode": false

DebugPath

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

Необязательное поле. Любое значение будет переведено в текстовое.

Значение по умолчанию: "D:\\DebugDC"

"DebugPath": "D:\\DebugDC"

Last updated 12 months ago

hashtagШаблон

hashtagСерверная часть

hashtagServerUrl

hashtagConnectionTimeout

hashtagНастройки Web-службы

hashtagHostUrl

hashtagStartAssembly

hashtagXmlFolder

hashtagTempFileFolder

hashtagEngineOnSameMachine

hashtagEngineStorages

hashtagSystemLocale

hashtagTranslate

hashtagHelpDeskEnabled

hashtagАутентификация

hashtagLoginPageUrl

hashtagTimeoutEnabled

hashtagTimeoutInterval

hashtagАнонимный пользователь

hashtagAnonymousUserName

hashtagAnonymousPassword

hashtagНастройки логирования

hashtagLogLocale

hashtagSerilog

hashtagОтладка

hashtagDebugMode

hashtagDebugPath

Шаблон

Серверная часть

ServerUrl

ConnectionTimeout

Настройки Web-службы

HostUrl

StartAssembly

XmlFolder

TempFileFolder

EngineOnSameMachine

EngineStorages

SystemLocale

Translate

HelpDeskEnabled

Аутентификация

LoginPageUrl

TimeoutEnabled

TimeoutInterval

Анонимный пользователь

AnonymousUserName

AnonymousPassword

Настройки логирования

LogLocale

Serilog

Отладка

DebugMode

DebugPath