Exported data sets (IRPCExportedDataSets)
Reads the exported data sets of the vault and reports their export status (M-Files Reporting).
| gRPC service | MFiles.IRPCExportedDataSets |
|---|---|
| Book and level | Vault API, standard |
| Methods | 7 |
| Proto file | mfiles/IRPCExportedDataSets.proto |
Overview
An exported data set describes which objects and properties M-Files Reporting copies from the vault to an external reporting database. The data sets are created and changed with the administration service IRPCExportedDataSetsAdmin; this service lets a vault session read them, start an export and follow its progress.
- Read the data sets: GetExportedDataSets, GetExportedDataSet.
- Start an export now and watch it: TriggerExportedDataSetRefresh, then GetDataSetExportingStatusBasic.
- Used by the export process itself: GetDataSetAuxiliaryExecutionControlState, GetDataSetExportingReferenceTimestamp and UpdateExportedDataSetExecutionStatus. Applications rarely need them.
Prerequisites. Every method needs a vault session. All methods except GetDataSetExportingReferenceTimestamp need the Reporting module in the server or vault license; without it they fail with a "no license for reporting" error, except GetExportedDataSets, which returns an empty list. Data set IDs that do not exist fail with "Not found.".
The objects and values that an export reads are available to any session through IRPCDataExport.
Methods
| Method | Summary | Facts |
|---|---|---|
| GetDataSetAuxiliaryExecutionControlState | Gets when an export of the data set was last requested or cancelled by hand. Used by the export process. | read session idempotent |
| GetDataSetExportingReferenceTimestamp | Gets the current server time, as the reference time for data set synchronization. | read session idempotent |
| GetDataSetExportingStatusBasic | Tells whether a data set is being exported right now and when its export status last changed. | read session idempotent |
| GetExportedDataSet | Gets one exported data set by ID. | read session idempotent |
| GetExportedDataSets | Gets all exported data sets of the vault. | read session idempotent |
| TriggerExportedDataSetRefresh | Asks for an export of the data set to start now, outside its schedule. | write session idempotent |
| UpdateExportedDataSetExecutionStatus | Stores the progress of an export. Reserved for the M-Files Reporting export process. | write session idempotent |