Model
Every Model schema contains objects that correspond to entities within that specific Anaplan Model.
Bulk Operations
The model schemas expose export actions as tables using the Anaplan Asyncronous APIs. When you query a table in these schemas, the driver runs a "job", which executes the corresponding export action. The export actions extract their targeted data into files that the driver then downloads. These files provide the records for the queried tables.Connection properties such as BulkTimeout, BulkPollingInterval and BulkPageSize apply to queries executed against these schemas. These properties control how asynchronous operations (such as export actions) are executed and how their results are retrieved.
Important: Import, export, and writeback actions require exclusive access to a model while they run. During this time, the model is locked and other queries to the same model are queued until the active operation completes. Because these requests remain open while waiting in the queue, the Timeout value may need to be increased, especially in multi-threaded environments. For exports that take longer to complete, you may also need to increase BulkTimeout.
Views
The following Views are shipped with the driver:
| Name | Description |
| Export | An example export. |
Stored Procedures
The following Stored Procedures are shipped with the driver:
| Name | Description |
| CancelExport | Cancels an ongoing export task. |
| DeleteFile | Deletes the content of a file from Anaplan. This only removes private content. Default content and the import data source model object remain. |
| DownloadFile | Downloads a file. |
| DownloadFileChunk | Downloads a specific chunk of a file. |
| GetOAuthAccessToken | Fetches the OAuth Access Token, which is used to authenticate and authorize API calls made. |
| GetOAuthAuthorizationUrl | Retrieves the OAuth Authorization URL, allowing the client to direct the user's browser to the authorization server and initiate the OAuth process. |
| RefreshOAuthAccessToken | Refreshes an expired OAuth Access Token to maintain continuous authenticated access to resources without requiring reauthorization from the user. |
| StartExport | Initiates an Export Task based on an existing Export Definition. Returns a Task ID to monitor. |