CreateSchema
Generates a schema file for a specified Salesforce table, defining field structure and types.
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 add-in 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 add-in.
Input
| Name | Type | Description |
| TableName | String | Name of the Salesforce object or table for which the schema should be generated. This is required. |
| TableDescription | String | Optional description for the table. If omitted, a default description is auto-generated by the driver. |
| WriteToFile | String | Specifies whether to save the generated schema to a file. Defaults to 'true'. Set to 'false' to return schema data via FileStream or FileData instead. |
| FileName | String | Name of the file to save the generated schema to. For example: 'Accounts.rsd'. Required if WriteToFile is 'true'. |
Result Set Columns
| Name | Type | Description |
| Result | String | Indicates whether the schema creation operation was successful ('Success') or failed ('Failure'). |
| FileData | String | Base64-encoded content of the generated schema. Returned only when WriteToFile is 'false' and FileStream is not specified. |
| SchemaFile | String | Name or path of the generated schema file, confirming completion of the operation. |