Описание переменных переданных в скрипт из DC

Owned by Visiology Robot (Unlicensed)
Last updated: мар. 30, 2023 by Денис Лихачев
3 min read

Переменные из SmartForms передаются только при вызове вычислений только из экземпляра формы.

Скрипт получает параметры, которые можно получить по обращения к переменной parameters.

Ключ

Пример значения

Описание

domain

192.168.23.108

IP или доменное имя

httpsEnabled

True

Признак работы по https

httpsPort

8091

Порт DataCollection для работы по https

platformVersion

2.16.1682

Версия платформы

measureGroup

{
  "UniqueName": "measureGroup_Plan_prodazh"
}

Описание группы показателей

formInstanceStates

[
  {
    "BusinessProcess": {
      "Id": 3,
      "Name": "Утверждение планов"
    },
    "State": {
      "Id": 4,
      "Name": "Черновик"
    }
  }
]

Описание статуса данных формы

startDateTime

4/13/20 12:52:00 PM

Время запуска скрипта

userName

Admin

Имя пользователя, запустившего скрипт

formInstance

см. ниже

Описание экземпляра формы

Описание экземпляра формы:

{
	"Id": "ft5-d5e1-d7e1",										// Идентификатор экземпляра данных формы
	"CalendarElements": [										// Элементы календаря, данные которых относястся к форме
		{
			"Key": "cal_Kvartal",								// Идентификатор календаря
			"Value": [
				{
					"AbsolutelyValue": "2019-01-01T00:00:00Z",	// Абсолютное значение даты и времени
					"Granularity": 30,				// Код гранулярности календаря
					"ValueAsString": "1 квартал",			// Значение строкой
					"IntervalValue": "01.01.2019-31.03.2019"	// Интервальное значение координаты дат
				},
				{
					"AbsolutelyValue": "2019-04-01T00:00:00Z",
					"Granularity": 30,
					"ValueAsString": "2 квартал",
					"IntervalValue": "01.04.2019-30.06.2019"
				}
			]
		}
	],
	"DimensionElements": [									// Элементы измерений, данные которых относятся к форме
		{
			"Key": "dim_Filiali",							// Идентификатор измерения
			"Value": [								// Идентификаторы элементов измерения
				1
			]
		},
		{
			"Key": "dim_Produkti",
			"Value": [
				1,
				2,
				3,
				4,
				5
			]
		},
		{
			"Key": "dim_Versii",
			"Value": [
				1
			]
		},
		{
			"Key": "dim_Plan_prodazh",
			"Value": [
				1,
				2
			]
		}
	],
	"Circulation": {								// Информация о тиражировании	
		"DimensionElements": [							// Информация об элементах измерения, к которому относится экземпляр
			{
				"Dimension": {						// Информация об измерении
					"UniqueName": "dim_Filiali",			// Идентификатор измерения
					"Name": "Mediastore. Филиалы"			// Наименование измерения
				},
				"Element": {
					"Id": 1,						// Идентификаторы элементов измерения
					"Name": "Москва"					// Наименование элемента измерения
				}
			},
			{
				"Dimension": {
					"UniqueName": "dim_Versii",
					"Name": "Mediastore. Версии"
				},
				"Element": {
					"Id": 1,
					"Name": "1"
				}
			}
		],
		"DimensionFolders": [],									// Информация о каталогах измерения, к которому относится экземпляр
		"CalendarElements": [],									// Информация об элементах календаря, к которому относится экземпляр
		"CalendarFolders": []									// Информация о каталогах календаря, к которому относится экземпляр
	},
	"FormFilters": {										// Информация о фильтрах формы
		"CalendarsFilters": [									// Информация о фильтрах календаря
			{
				"Block": "Column",					// Часть формы, в которой находится сущность
				"Calendar": {						// Описание календаря
					"UniqueName": "cal_Kvartal",			// Идентификатор календаря
					"Name": "Квартал"				// Наименование календаря
				},
				"Elements": [						// Элементы календаря
					{
						"AbsolutelyValue": "2019-01-01T00:00:00Z",	// Абсолютное значение элемента календаря
						"Granularity": "Quarter"			// Гранулярность
					},
					{
						"AbsolutelyValue": "2019-04-01T00:00:00Z",
						"Granularity": "Quarter"
					}
				]
			}
		],
		"DimensionsFilters": [									// Информация о фильтрах измерений
			{
				"Block": "Filter",							// Часть формы, в которой находится сущность
				"Dimension": {								// Информация об измерении
					"UniqueName": "dim_Filiali",					// Идентификатор измерения
					"Name": "Mediastore. Филиалы"					// Наименование измерения
				},
				"Elements": []								// Элементы фильтрации
			},
			{
				"Block": "Row",
				"Dimension": {
					"UniqueName": "dim_Produkti",
					"Name": "Mediastore. Продукты"
				},
				"Elements": [
					{
						"Id": 1,
						"Name": "Продукт 1"
					},
					{
						"Id": 2,
						"Name": "Продукт 2"
					},
					{
						"Id": 3,
						"Name": "Продукт 3"
					},
					{
						"Id": 4,
						"Name": "Продукт 4"
					},
					{
						"Id": 5,
						"Name": "Всего по группе 2"
					}
				]
			},
			{
				"Block": "Filter",
				"Dimension": {
					"UniqueName": "dim_Versii",
					"Name": "Mediastore. Версии"
				},
				"Elements": []
			},
			{
				"Block": "Column",
				"Dimension": {
					"UniqueName": "dim_Plan_prodazh",
					"Name": "Mediastore. Плановые показатели продаж"
				},
				"Elements": [
					{
						"Id": 1,
						"Name": "Количество"
					},
					{
						"Id": 2,
						"Name": "Цена"
					}
				]
			}
		]
	}
}

Переменные из Data Collection передаются только при вызове вычислений только из экземпляра формы.

Скрипт получает параметры, которые можно получить по обращения к переменной parameters.

Ключ

Пример значения

Описание

domain

192.168.23.108

IP или доменное имя

httpsEnabled

True

Признак работы по https

httpsPort

8091

Порт DataCollection для работы по https

platformVersion

2.16.1682

Версия платформы

measureGroup

{
  "UniqueName": "measureGroup_Plan_prodazh"
}

Описание группы показателей

formInstanceStates

[
  {
    "BusinessProcess": {
      "Id": 3,
      "Name": "Утверждение планов"
    },
    "State": {
      "Id": 4,
      "Name": "Черновик"
    }
  }
]

Описание статуса данных формы

startDateTime

4/13/20 12:52:00 PM

Время запуска скрипта

userName

Admin

Имя пользователя, запустившего скрипт

formInstance

см. ниже

Описание экземпляра формы

Описание экземпляра формы:

{
	"Id": "ft5-d5e1-d7e1",										// Идентификатор экземпляра данных формы
	"CalendarElements": [										// Элементы календаря, данные которых относястся к форме
		{
			"Key": "cal_Kvartal",								// Идентификатор календаря
			"Value": [
				{
					"AbsolutelyValue": "2019-01-01T00:00:00Z",	// Абсолютное значение даты и времени
					"Granularity": 30,				// Код гранулярности календаря
					"ValueAsString": "1 квартал",			// Значение строкой
					"IntervalValue": "01.01.2019-31.03.2019"	// Интервальное значение координаты дат
				},
				{
					"AbsolutelyValue": "2019-04-01T00:00:00Z",
					"Granularity": 30,
					"ValueAsString": "2 квартал",
					"IntervalValue": "01.04.2019-30.06.2019"
				}
			]
		}
	],
	"DimensionElements": [									// Элементы измерений, данные которых относятся к форме
		{
			"Key": "dim_Filiali",							// Идентификатор измерения
			"Value": [								// Идентификаторы элементов измерения
				1
			]
		},
		{
			"Key": "dim_Produkti",
			"Value": [
				1,
				2,
				3,
				4,
				5
			]
		},
		{
			"Key": "dim_Versii",
			"Value": [
				1
			]
		},
		{
			"Key": "dim_Plan_prodazh",
			"Value": [
				1,
				2
			]
		}
	],
	"Circulation": {								// Информация о тиражировании	
		"DimensionElements": [							// Информация об элементах измерения, к которому относится экземпляр
			{
				"Dimension": {						// Информация об измерении
					"UniqueName": "dim_Filiali",			// Идентификатор измерения
					"Name": "Mediastore. Филиалы"			// Наименование измерения
				},
				"Element": {
					"Id": 1,						// Идентификаторы элементов измерения
					"Name": "Москва"					// Наименование элемента измерения
				}
			},
			{
				"Dimension": {
					"UniqueName": "dim_Versii",
					"Name": "Mediastore. Версии"
				},
				"Element": {
					"Id": 1,
					"Name": "1"
				}
			}
		],
		"DimensionFolders": [],									// Информация о каталогах измерения, к которому относится экземпляр
		"CalendarElements": [],									// Информация об элементах календаря, к которому относится экземпляр
		"CalendarFolders": []									// Информация о каталогах календаря, к которому относится экземпляр
	},
	"FormFilters": {										// Информация о фильтрах формы
		"CalendarsFilters": [									// Информация о фильтрах календаря
			{
				"Block": "Column",					// Часть формы, в которой находится сущность
				"Calendar": {						// Описание календаря
					"UniqueName": "cal_Kvartal",			// Идентификатор календаря
					"Name": "Квартал"				// Наименование календаря
				},
				"Elements": [						// Элементы календаря
					{
						"AbsolutelyValue": "2019-01-01T00:00:00Z",	// Абсолютное значение элемента календаря
						"Granularity": "Quarter"			// Гранулярность
					},
					{
						"AbsolutelyValue": "2019-04-01T00:00:00Z",
						"Granularity": "Quarter"
					}
				]
			}
		],
		"DimensionsFilters": [									// Информация о фильтрах измерений
			{
				"Block": "Filter",							// Часть формы, в которой находится сущность
				"Dimension": {								// Информация об измерении
					"UniqueName": "dim_Filiali",					// Идентификатор измерения
					"Name": "Mediastore. Филиалы"					// Наименование измерения
				},
				"Elements": []								// Элементы фильтрации
			},
			{
				"Block": "Row",
				"Dimension": {
					"UniqueName": "dim_Produkti",
					"Name": "Mediastore. Продукты"
				},
				"Elements": [
					{
						"Id": 1,
						"Name": "Продукт 1"
					},
					{
						"Id": 2,
						"Name": "Продукт 2"
					},
					{
						"Id": 3,
						"Name": "Продукт 3"
					},
					{
						"Id": 4,
						"Name": "Продукт 4"
					},
					{
						"Id": 5,
						"Name": "Всего по группе 2"
					}
				]
			},
			{
				"Block": "Filter",
				"Dimension": {
					"UniqueName": "dim_Versii",
					"Name": "Mediastore. Версии"
				},
				"Elements": []
			},
			{
				"Block": "Column",
				"Dimension": {
					"UniqueName": "dim_Plan_prodazh",
					"Name": "Mediastore. Плановые показатели продаж"
				},
				"Elements": [
					{
						"Id": 1,
						"Name": "Количество"
					},
					{
						"Id": 2,
						"Name": "Цена"
					}
				]
			}
		]
	}
}