Методы для чтения данных из Semantic MDM

Основным способом чтения значений атрибутов текущей экспортируемой позиции, является чтение через конструкцию @[имя атрибута]. Для чтения значения вложенных в агрегации атрибутов, необходимо последовательно перечислить имена атрибутов, например:

@[имя атрибута связи][имя вложенного атрибута]
@[имя атрибута связи][имя вложенного атрибута связи][имя вложенного атрибута]

Перечисленные конструкции вернут одно значение атрибута, если все перечисленные в конструкции атрибуты хранят единичное значение. Если хотя бы один из перечисленных в конструкции атрибутов хранит массив значений, то данная конструкция вернет List значений. Для каждого из типов данных атрибутов, будет возвращен свой тип данных:

строка: String;
целое число: Integer;
число с плав. запятой: объект класса ValueDouble;
класс ValueDouble:
Double getValue() – получить центральное значение;
Double getMin() – получить нижнее отклонение, всегда отрицательное ;
Double getMax() – получить верхнее отклонение, всегда положительное;
String getEncodedString() – строковое кодированное значение, содержит значения value, min и max в той ЕИ, в которой задал значение пользователь. Значение в encodedString кодируется следующим образом: value=<среднее число >; min=<нижнее отклонение, всегда меньше нуля>; max=<верхнее отклонение, всегда больше нуля>; measure=<числовой идентификатор ЕИ>; precision=<количество знаков после запятой для округления>; type=<тип ЕИ: “NORMAL”, “RANGE”, “DEFLECTIONS”>. Примеры кодированной строки encodedString:
200 мм: “value=200;min=0;max=0;measure=313;precision=5;type=NORMAL”;
300 – 400 мм: “value=0;min=300;max=400;measure=313;precision=5;type=RANGE”;
10(-0.1;0.15) мм: “value=10;min=-0.1;max=0.15;measure=313;precision=5;type=DEFLECTIONS”;
дата: Date;
логический тип: Boolean;
цвет: integer, где первый, второй и третий байт кодируют цвет RGB;
файл: имя файла;
атрибут связи: String с guid позиции.

Методы чтения данных из Semantic MDM, описанные ниже, рекомендуется использовать в исключительных случаях, когда штатные средства настройки атрибутов обменных классов и использование ссылок на атрибуты (@[<наименование атрибута>]) в скриптах Groovy не позволяют прочитать необходимые данные из Semantic MDM для формирования сообщения экспорта.

Использование данных функций может значительно замедлить экспорт данных во внешние системы, в случае изменения позиции, участвующей в формировании большого количества сообщений экспорта. Например, такой позицией может быть единица измерения “штуки” или “килограмм”, которая используется в большинстве позиций справочника номенклатуры.

Чтение данных о позиции

ItemStatus getItemStatus(String itemUid) – получить статус позиции по GUID (ItemUid) позиции. Функция вернет одно из следующих значений:
NULL - если позиция с переданным itemUid не существует
ItemStatus.Abnormal – соответствует статусу “Не нормализована”,
ItemStatus.Standardized – соответствует статусу “Нормализована”,
ItemStatus.Blocked – соответствует статусу “Заблокирована”,
ItemStatus.Removed – соответствует статусу “Удалёна”,
ItemStatus.Duplicate – соответствует статусу “Дубликат”.
String getMDMId(String sourceId, String systemId) – получить GUID позиции по идентификатору объекта (sourceId) во внешней системе и идентификатору внешней системы (systemId). Вернет NULL если переходной ключ отсутствует.
String getSourceId(String itemUid, String systemId) – получить идентификатор объекта во внешней системе по GUID позиции (itemUid) и идентификатору внешней системы (systemId). Если переходной ключ отсутствует, то вернет NULL.
String getItemNodeUid(String itemUid) – получить GUID группы, которой принадлежит позиция с указанным GUID (itemUid). Если позиция с переданным GUID не существует, то будет возвращена ошибка.

Чтение значений атрибутов позиции

Основным способом чтения значений атрибутов текущей позиции, является чтение через конструкцию @[имя атрибута]. Для чтения значения вложенных в агрегации атрибутов, необходимо последовательно перечислить имена атрибутов, например:

@[имя атрибута связи][имя вложенного атрибута];
@[имя атрибута связи][имя вложенного атрибута связи][имя вложенного атрибута];
@[#composer][ имя вложенного атрибута];
@[#composer][имя вложенного атрибута связи][ имя вложенного атрибута].

Кроме получения списка значений (List) для вложенного атрибута, есть возможность получить полный путь до этого значения через метод: getMapValues(), который вернет Map<String, Object>, где String будет содержать GUID агрегированной позиции, а Object будет содержать либо значение заданного атрибута, либо еще один Map<String, Object>, если путь к вложенному атрибуту состоит из более чем одного атрибута связи.

Примеры возвращаемых значений:

@[имя множественного атрибута связи][имя вложенного строкового атрибута].getMapValues() – данная конструкция вернет Map<String, String>;
@[имя множественного атрибута связи] [имя единичного атрибута связи] [имя вложенного строкового атрибута].getMapValues() – данная конструкция вернет Map<String, Map<String, String>>;
@[имя множественного атрибута связи] [имя единичного атрибута связи] [имя вложенного множественного строкового атрибута].getMapValues() – данная конструкция вернет Map<String, Map<String, List<String>>>.

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

строка: String
целое число: Integer
число с плав. запятой: valueDouble - методы для работы с ValueDouble
дата: Date
логический тип: Boolean
цвет: Long. – число в формате Blue, Green, Red, Alpha, где Blue – страший байт, а Alpha – младший байт. Пример красного цвета в шестнадцатиричном строковом представлении: “241CEDFF”, где: Blue=24, Green=1C, Red=ED, Alpha=FF.
Преобразование цвета из шестнадцатеричного строкового представления в число: Long.parseLong("241CEDFF",16);
Преобразование числа в строковое шестнадцатеричное представление: Long.toString(605875711,16);
файл: String - имя файла
атрибут связи: String - с guid позиции

Описанные ниже функции рекомендуется использовать в исключительных случаях, при невозможности изначально определить полный перечень экспортируемых атрибутов в обменном классе. Примером такого исключения, может быть интеграция с внешними системами по справочнику номенклатуры, в котором необходимо передать информацию по списку атрибутов справочника, который не может быть определен заранее и должен вычисляться динамически, в зависимости от различных условий. Например, выполнить экспорт значений только для тех атрибутов, которые входят в определенную категорию атрибутов и/или участвуют в вычислении полного наименования.

List<PropertyValueDto> getItemPropertyValues(String itemUid) – получить список значений атрибутов позиции с гуидом itemUid. Если атрибут содержит множественные значения, то для каждого значения будет возвращен свой PropertyValueDto, с одинаковым PropertyValueDto.propertyId.

Свойства PropertyValueDto:
String itemUid – идентификатор позиции
long propertyId – числовой идентификатор атрибута
String stringValue – содержит строковое значение атрибута, если тип данных: String или Text. Содержит гуид позиции, если тип данных Aggregation или Composition
ExchangeComplexDouble doubleValue – содержит число с плавающей запятой, если тип данных: Double.
long integerValue – содержит целое число, если тип данных Int
ExchangeFile fileValue – содержит наименование файла и хэш содержимого. Если тип данных Image, то наименование файла будет пустым.

Свойства ExchangeFile:
name – наименование файла, для изображения не указывается
bodyHash – хэш тела файла
Boolean booleanValue – содержит булево значение, если тип данных Bool;
Date dateValue – содержит дату, если тип данных DateTime;
String nameValue – содержит наименование контекста для контекстных значений атрибута;
List<PropertyValueDto> getItemsPropertyValueList(List<String> itemUids, List<long> PropertyIds) – получить список значений для атрибутов указанных в PropertyIds и позиций указанных в itemUids. Если PropertyIds содержит пустой список, то будут возвращены значения всех атрибутов. Для каждого PropertyValueDto в свойстве itemUid будет указан guid позиции, к которому относится возвращенное значение атрибута. Если атрибут содержит множественные значения, то для каждого значения будет возвращен свой PropertyValueDto, с одинаковым PropertyValueDto.propertyId и одинаковым PropertyValueDto.itemUid;
List<ScriptedPropertyValue> getCalculatedPropertyValueDependencies(String itemUid, Long propertyId) – для указанной позиции (itemUid) получить атрибуты и их значения, на основе которых был вычислен указанный вычисляемый атрибут (propertyId). Данный метод вернет список ScriptedPropertyValue, который будет содержать информацию о значениях атрибутов и путях, к этим атрибутам.

Свойства ScriptedPropertyValue:
Long getPropertyId() - идентификатор конечного атрибута;
String getPropertyName() - наименование конечного атрибута;
List<Long> getCalculationPathIds() – путь из идентификаторов атрибутов, по которому система получила значение для конечного атрибута;
List<String > getCalculationPathUids() – путь из GUID атрибутов, по которому система получила значение для конечного атрибута;
List<String> getCalculationPathNames() – путь из наименований атрибутов, по которому система получила значение для конечного атрибута;
String getReadableValue() – строковое значение свойства.

Метод getItemPropertyValues возвращает список всех значений атрибутов для заданной позиции (itemUid). Для чтения значений конкретного атрибута из полученного списка, необходимо знать идентификатор и тип данных атрибута, а также множественное у него значение или нет. Для получения этой информации в скрипте, необходимо использовать метод getPropertyDeclarationsByNodeUid (Чтение данных по атрибутам).

Ниже представлен пример чтения значений атрибутов.

Пример чтения значений атрибутов: “Наименование изделия”, “Диаметр”, “Материал->Марка материала”:

List<PropertyValueDto> itemValues = support.getItemPropertyValues("a1ddfe35-6fca-4f25-b874-604d082d9d3c");

//Получим значение атрибута "Наименование изделия"

PropertyValueDto attrValue = itemValues.find {element -> element. propertyId()==@[Наименование изделия].toId()};

if (attrValue!=null)

{String prodName = attrValue.stringValue}

//Получим значение атрибута "Диаметр" в миллиметрах

attrValue = itemValues.find {element -> element. propertyId()==@[Диаметр].toId()};

If (attrValue!=null)

//Получим диаметр в миллиметрах

{Double prodDiam = doubleValue.getValue().value/1000}

//Получим значение атрибута "Материал->Марка материала" в миллиметрах

attrValue = itemValues.find {element -> element. propertyId()==@[Материал].toId()};

if (attrValue!=null)

{

prodMatUid = attrValue.stringValue;

List<PropertyValueDto> MaterialValues = support.getItemPropertyValues(prodMatUid);

attrValue = itemValues.find {element -> element. propertyId()==@[Марка материала].toId()};

if (attrValue!=null)

{String prodMatMark = attrValue.stringValue}

}

Чтение данных по атрибутам из Semantic MDM

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

PropertyInfoDto getPropertyInfoByUid(String propertyUid) – получить информацию об атрибуте по GUID атрибута Semantic MDM. Если атрибут с заданным PropertyUid не существует, то функция вернет NULL.

Свойства PropertyInfoDto:
long id – числовой идентификатор атрибута;
String uuid – GUID атрибута;
String eOTDid – идентификатор OTD;
dataType – тип данных атрибута:
PropertyDataType.String – строка;
PropertyDataType.Double – число с плав. запятой;
PropertyDataType.Int – целое число;
PropertyDataType.Bool – булев;
PropertyDataType.Image – картинка;
PropertyDataType.Text – текст;
PropertyDataType.DateTime – дата;
PropertyDataType.Colour – цвет;
PropertyDataType.File – файл;
PropertyDataType.Formula – формула;
PropertyDataType.Aggregation – агрегация;
PropertyDataType.Composition – композиция;
Map<String, String> names – возвращается карта “Идентификатор языка” – “Наименование атрибута”. Наименование на русском языке всегда должно быть первым. Идентификаторы языка: ru_RU – русский, en_US – английский;
Map<String, String> aggregateNames – для атрибута связи возвращается карта “Идентификатор языка” – “Обратное наименование атрибута”. Наименование на русском языке всегда должно быть первым. Идентификаторы языка: ru_RU – русский, en_US – английский;
String comment– описание атрибута;
String sourceDocument – значение свойства “Источник (документ)”;
boolean isMultiple – флаг Массив;
boolean isHierarchical – флаг Иерархический;
boolean isContextual – флаг контекстного атрибута;
List<PropertyInfoDto> getPropertyInfoByUidList(List<String> propertyUids) – получить информацию по заданному списку атрибутов. Если один из атрибутов с заданным PropertyUid не существует, то функция не вернет информации по данному атрибуту;
PropertyInfoDto getPropertyInfoByOtdId(String propertyOtdId) – получить информацию об атрибуте по идентификатору OTD атрибута Semantic MDM. Если атрибут с заданным propertyOtdId не существует, то функция вернет NULL;
List<PropertyInfoDto> getPropertyInfoByOtdIdList (List<String> propertyOtdIds) – получить информацию по заданному списку атрибутов. Если один из атрибутов с заданным PropertyOtdId не существует, то функция не вернет информации по данному атрибуту;
PropertyInfoDto getPropertyInfoById(Long propertyId) – получить информацию об атрибуте по числовому идентификатору атрибута Semantic MDM. Если атрибут с заданным PropertyId не существует, то функция вернет ошибку;
List<PropertyInfoDto> getPropertyInfoByIdList (List< Long> propertyIds) – получить информацию по заданному списку атрибутов. Если один из атрибутов с заданным PropertyId не существует, то функция вернет ошибку;
List<PropertyDeclarationInfoDto> getPropertyDeclarationsByNodeUid(String nodeUid, boolean resolveMultilinguals) – получить список деклараций для группы с указанным GUID (nodeUid). Флаг resolveMultilinguals определяет необходимость получения данных о мультиязычных наименованиях в PropertyInfoDto.Names, PropertyInfoDto.aggregateNames, PropertyDeclarationInfoDto.categories;

Свойства PropertyDeclarationInfoDto:
List<String> scopeNodes – список GUID групп, на позиции которых может ссылаться агрегация/композиция (PropertyDeclarationInfoDto.dataType равен Aggregation или Composition)
Map<String, String> categories – возвращается карта “Идентификатор языка” – “Наименование категории”. Наименование на русском языке всегда должно быть первым. Идентификаторы языка: ru_RU – русский, en_US – английский;
long id – числовой идентификатор атрибута;
String uuid – GUID атрибута;
String eOTDid – идентификатор OTD;
PropertyDataType dataType – тип данных атрибута:
PropertyDataType.String – строка;
PropertyDataType.Double – число с плав. запятой;
PropertyDataType.Int – целое число;
PropertyDataType.Bool – булев;
PropertyDataType.Image – картинка;
PropertyDataType.Text – текст;
PropertyDataType.DateTime – дата;
PropertyDataType.Colour – цвет;
PropertyDataType.File – файл;
PropertyDataType.Formula – формула;
PropertyDataType.Aggregation – агрегация;
PropertyDataType.Composition – композиция;
Map<String, String> Names – возвращается карта “Идентификатор языка” – “Наименование атрибута”. Наименование на русском языке всегда должно быть первым. Идентификаторы языка: ru_RU – русский, en_US – английский;
Map<String, String> aggregateNames – для атрибута связи возвращается карта “Идентификатор языка” – “Обратное наименование атрибута”. Наименование на русском языке всегда должно быть первым. Идентификаторы языка: ru_RU – русский, en_US – английский;
String comment– описание атрибута;
String sourceDocument – массив значений “Источник (документ)”;
boolean isMultiple – флаг Массив;
boolean isHierarchical – флаг Иерархический.

Чтение данных по группам из Semantic MDM

getNodePath(String itemUid) - получить путь из групп до указанной позиции. Данная функция сформирует путь по следующему шаблону: <наименование группы>|<GUID группы><символ табуляции><наименование группы>|<GUID группы>… Пример пути до группы: Все справочники|0000000000000000000000 -> Основные справочники|27cd5c64-64ef-4559-9695-ac4dc3b6104a -> Единый справочник Номенклатуры|967241ea-d6e6-4b36-a5bc-f041f4b94abc;
ClassifiableElementInfoDto getNodeInfo(String NodeUid, Boolean fetchParents) – получить информацию о группе по ее GUID (NodeUid) Semantic MDM. Флаг fetchParents позволяет вернуть информацию по всем родительским группам. Если группа с заданным NodeUid не существует, то функция вернет NULL;

Свойства ClassifiableElementInfoDto:
Long id – числовой идентификатор группы;
String uid – GUID группы;
String displayName – наименование группы;
List<ClassifiableElementDto> parents – список родительских групп, первой идет корневая группа, последней идет родительская группа для указанной группы (NodeUid).