CreateSchema
Generates a schema definition for a table, supporting metadata documentation and streamlined integrations in Cloud Financials.
CreateSchema
Creates a local schema file (.rsd) from an existing table or view in the data model.
The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.
The connector checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the connector.
Input
| Name | Type | Description |
| TableName | String | The name of the specific table for which the schema generation is requested. This refers to a database table in the target schema. |
| SchemaName | String | The name of the schema in which the table resides. The schema helps to organize database objects and permissions. |
| FileName | String | The full path and filename where the generated schema is saved, for example, 'C:\\scripts\\Accounts.rsd'. This specifies the location for the output file. |
| SimplifyNames | String | Indicates whether to simplify the column names in the schema output. When set to true, the schema uses shorter or more concise names for easier readability. |
Result Set Columns
| Name | Type | Description |
| Result | String | A flag indicating whether the schema download operation was successful. A value of true means the schema was successfully downloaded. |
| FileData | String | The Base64-encoded content of the generated schema. This is returned only if neither 'FileName' nor 'FileStream' is provided, allowing the schema to be retrieved directly. |