Псевдообъекты

Функционал Псевдообъектов предназначен для создания объектов по пользовательским схемам, и позволяет передачу их метаданных в каталог. Созданные таким образом метаданные, могут использоваться для представления в происхождении данных источников, сбор метаданных которых не поддерживается механизмами сбора каталога.

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

Создание псевдообъекта

Для создания псевдообъекта требуется Json-схема, которая доступна пользователю на Чтение.

  1. Для создания псевдообъекта необходимо перейти на страницу «Управление псевдообъектами», используя пункт «Псевдообъекты» в левом меню. 

В открывшемся окне Управление Псевдообъектами нажать кнопку «Создать»

  1. Заполнить обязательные поля:

  • Наименование: наименование объекта
  • Схема: указать схему из списка доступных схем
  • Статус: выбрать Активен

Нажать кнопку «Создать»

Добавление описания доступно только при редактировании созданного Псевдообъекта. JSON конструктор строится по схеме, которая определяет созданный псевдообъект.

Копирование псевдообъектов

Псевдообъекты поддерживают копирование. При копировании все исходные настройки псевдообъекта также копируются, к наименованию добавляется постфикс copy[порядковый номер копии]

Копирование доступно в панели дополнительных свойств в операциях по кнопке "Копировать" )

Передача данных в каталог

Для передачи данных в "Каталог данных" необходимо открыть дополнительные параметры по клику на строку псевдообъекта и в операциях нажать кнопку "Передать метаданные в каталог )"

Схема и пример объекта для создания API сервиса в каталоге

JSON-схема

Схема 
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://example.com/product.schema.json",
    "title": "Product",
    "type": "object",
    "additionalProperties": false,
    "swatch": {
        "meta": {
            "endpoint": {
                "/name": {
                    "$ref": "/productName"
                },
                "/responseSchema/schemaFields": {
                    "$ref": "/fields"
                },
                "/apiCollection": {
                    "$ref": "/context/meta/endpoint/apiCollection"
                }
            }
        },
        "roles": {
            "table": {
                "types": [
                    "TABLE"
                ]
            }
        }
    },
    "required": [
        "context",
        "productName",
        "fields"
    ],
    "properties": {
        "productId": {
            "type": "integer"
        },
        "productName": {
            "type": "string"
        },
        "context": {
            "type": "object",
            "additionalProperties": false,
            "required": [
                "meta"
            ],
            "properties": {
                "meta": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                        "endpoint"
                    ],
                    "properties": {
                        "endpoint": {
                            "type": "object",
                            "additionalProperties": false,
                            "required": [
                                "apiCollection"
                            ],
                            "properties": {
                                "apiCollection": {
                                    "type": "string"
                                }
                            }
                        }
                    }
                }
            }
        },
        "fields": {
            "type": "array",
            "additionalItems": false,
            "hints": {
                "role": "table"
            },
            "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                    "dataType": {
                        "type": "string",
                        "enum": [
                            "RECORD",
                            "NULL",
                            "BOOLEAN",
                            "INT",
                            "LONG",
                            "BYTES",
                            "FLOAT",
                            "DOUBLE",
                            "TIMESTAMP",
                            "TIMESTAMPZ",
                            "TIME",
                            "DATE",
                            "STRING",
                            "ARRAY",
                            "MAP",
                            "ENUM",
                            "UNION",
                            "FIXED",
                            "ERROR"
                        ]
                    },
                    "dataTypeDisplay": {
                        "type": "string"
                    },
                    "description": {
                        "type": "string"
                    },
                    "displayName": {
                        "type": "string"
                    },
                    "fullyQualifiedName": {
                        "type": "string"
                    },
                    "name": {
                        "type": "string"
                    }
                },
                "required": [
                    "dataType",
                    "name"
                ]
            }
        },
        "characteristics": {
            "type": "object",
            "properties": {
                "color": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                        "hexvalue"
                    ],
                    "properties": {
                        "name": {
                            "type": "string"
                        },
                        "hexvalue": {
                            "type": "string",
                            "pattern": "^(?:[0-9a-fA-F]{3}){1,2}$"
                        }
                    }
                },
                "weight": {
                    "type": "object",
                    "additionalProperties": false,
                    "required": [
                        "value"
                    ],
                    "properties": {
                        "value": {
                            "type": "number"
                        },
                        "unit": {
                            "type": "string",
                            "enum": [
                                "kg",
                                "g"
                            ],
                            "default": "kg"
                        }
                    }
                }
            }
        }
    }
}

Описание

{
    "productName": "MS Excel",//указывает на наименование таблицы
    "fields": [ // определяет список столбцов
        {
            "dataType": "RECORD", // тип столбца
            "name": "Продукт" // наименование столбца
        }
    ],
    "context": {
        "meta": {
            "endpoint": {
                "apiCollection": "test.demo" // путь к таблице в сервисах api
            }
        }
    }
}