Exported data set administration (IRPCExportedDataSetsAdmin)
Manages the vault's exported data sets: the definitions of the vault data that M-Files Reporting Data Services exports to a reporting database.
MFAdmin uses this interface to manage the data set configuration.
| gRPC service | MFiles.IRPCExportedDataSetsAdmin |
|---|---|
| Book and level | Administration API, specialized |
| Methods | 9 |
| Proto file | mfiles/IRPCExportedDataSetsAdmin.proto |
Overview
M-Files Admin uses this service for the reporting and data export settings of a vault. An exported data set (ExportedDataSetAdmin) names the object types, properties and filters to export, a schedule, and the OLE DB connection string of the target database. M-Files Reporting Data Services runs the exports; this service only stores the definitions, requests runs, and reads their status.
- Definitions: GetExportedDataSetsAdmin, AddNewExportedDataSet, ModifyExportedDataSet, RemoveExportedDataSet.
- Runs: TriggerExportedDataSetExecution, CancelExportedDataSetExecution, GetExportedDataSetExecutionStatus.
- Report access account: GetReportAccessCredentialsAdmin, SetReportAccessCredentials.
Rights. All methods need a vault session and a server license that includes the reporting
module ("This operation requires the reporting module." otherwise), except that
GetExportedDataSetsAdmin
returns an empty list without it. Most methods need the vault right see_all_objects. The
connection string makes the server connect to a data source with its own service account, so
setting a new one needs the server right run_code, which a vault administrator normally does
not have (see AddNewExportedDataSet).
Users without administrator rights can request a run with
TriggerExportedDataSetRefresh
if they have the vault right trigger_data_export.
Methods
| Method | Summary | Facts |
|---|---|---|
| AddNewExportedDataSet | Adds an exported data set. | admin session |
| CancelExportedDataSetExecution | Requests that a running export of an exported data set stops. | admin session idempotent |
| GetExportedDataSetExecutionStatus | Gets the progress and status of the latest export run of an exported data set. | admin session idempotent |
| GetExportedDataSetsAdmin | Gets all exported data sets of the vault. | admin session idempotent |
| GetReportAccessCredentialsAdmin | Gets the account that is used to access reports generated from the exported data. | admin session idempotent |
| ModifyExportedDataSet | Replaces the definition of an exported data set. | admin session idempotent |
| RemoveExportedDataSet | Removes an exported data set. | admin session |
| SetReportAccessCredentials | Sets the account that is used to access reports generated from the exported data. | admin session idempotent |
| TriggerExportedDataSetExecution | Requests an immediate export run of an exported data set. | admin session idempotent |