Generating Object XSDs
OneData provides an XSD feature, to generate the XML schema for an object.
OneData provides two output options for generating the XSD:
Create the XSD and display it in
OneData.
Create the XSD and download it as a file that can be saved.
Note: OneData generates XSDs for data objects only. XSD generation for conceptual objects is not supported.
Every column contains the property XML Element Name. OneData uses the value specified in this property as the element name in the XSD it generates.
The XSD generation feature in OneData creates an element in the equivalent XML data type for each column in the object. However, OneData does not support BLOB (binary large object) or file type data types when generating the XSD. If the object contains columns defined with either of these data types, then when you attempt to generate the XSD
The following table lists the XSD data type that OneData uses when generating the XSD.
Object Column Data Type | XSD Data Type |
Binary LOB | Not supported |
File Type | Not supported |
Boolean | boolean |
Char | string |
Character LOB | string |
Contiguous Sequence | decimal |
Database Sequence | decimal |
Date | string |
External Sequence | decimal |
Numeric | decimal |
Optional Database Sequence | decimal |
Percentage | decimal |
Timestamp | string |
Varchar | string |
OneData does not create elements for data audit columns or columns that are unsupported data types.
To generate the XML schema for an object
1. On the Menu toolbar, click Manage > Manage Data.
2. Navigate to the object you want to view and select it.
3. Use the option that corresponds to the object’s display mode to access the object definition:
In Default mode: click the
Advanced Definition tab.
In Nova mode: click
View > Definition.
4. Expand the External Services properties and customize the XSD definition:
a. In the XML Format field, select the format of the XSD.
Format Type | Description |
Table-Column as element | Shows the column value in the record as child element of the table element. |
Table-Column as attribute | Shows the column value in the record as attribute. |
Data row as element | Shows the column value in the record as child element of the data row element. |
Data row as attribute | Shows the column value in the record as attribute of the data row element. |
b. In the Style field, select the style option:
With decode:
OneData uses the internal reference identifier (constraint name) as the element name of foreign keys. If the object contains concatenated keys, or a concatenated foreign key, the element name in the XSD is named tag only once.
Without decode:
OneData uses the value specified in the
XML Element Name property of the column definition as the corresponding element name in the XSD.
c. In Attach Column Description, selecting the field includes the column description as an XML comment in XSD.
Note: This option is available if you are generating the XSD through RESTful call as well. In RESTful URL, the request parameter description is used to specify whether to generate XML comment for column description. Default value is false.
5. Click Generate XSD or Download XSD.