Zip file structure for import
A ZIP file is used during the import and export. This table shows the format of the ZIP file:
| Folder Structure | Explanation |
|---|---|
| ANY | FOLDER: This folder contains all objects of type ANY. |
| +-- ObjectName1 | FOLDER: This folder contains all files related to this object. It has the name of the object. |
| +---- ObjectName1.xml | FILE: This file has the same name as the object, followed by an XML extension. For objects of type ANY this file is empty. |
| +-- … | Other object of type ANY. |
| BOD | FOLDER: This folder contains all objects of type BOD. |
| +-- NounA | FOLDER: this folder contains all files related to this noun/object. It has the name of the noun/object. |
| +---- NounA.xsd | FILE: Noun/object schema file. If this schema file contains references to other schema files, these must also reside in this folder. This file must always be present and has the name of the noun/object. |
| +---- NounA.xml | FILE: Noun properties metadata file. This file must always be present and must at least contain the IDXPath element. |
| +---- … | FILE: Any schema files that are referenced by the NounA.xsd.
Note: No sub folder structure may be present here.
|
| +-- … | Other object of type BOD. |
| JSON | FOLDER: This folder contains all objects of type JSON. |
| +-- Object1 | FOLDER: This folder contains all files related to this object. It has the name of the object. |
| +---- Object1.schema.json | FILE: The JSON schema that describes this object. It has the name of the object and a .schema.json extension. The file must use UTF-8 encoding and must be a valid schema file according to JSON schema definition, version 6. |
| +---- Object1.properties.json | FILE: A JSON file that describes additional properties for this object. It has the name of the object and a .properties.json extension. The file must use UTF-8 encoding and must be a valid JSON file according to the schema for the properties file. |
| +-- … | Other objects of type JSON. Only one JSON schema file for each object must be used. |
| DSV | FOLDER: This folder contains all objects of type DSV (Delimiter-Separated Values). |
| +-- Object1 | FOLDER: This folder contains all files related to this object. It has the name of the object. |
| +---- Object1.schema.json | FILE: The DSV schema that describes this object. It has the name of the object and a ".schema.json" extension. The file must use UTF-8 encoding. |
| +---- Object1.properties.json | FILE: A JSON file that describes additional properties for this object. It has the name of the object and a “.properties.json” extension. The file must use UTF-8 encoding and must be a valid JSON file according to the schema for the properties file. |
| +-- … | Other objects of type DSV. Only one DSV schema file for each object must be used. |
| CustomHeaders | FOLDER: This folder contains the custom headers JSON file. |
| +-- CustomHeaders.json | FILE: A JSON file that includes the custom message headers to be added to objects that are stored in the Data Catalog. |