Exported data set administration (IRPCExportedDataSetsAdmin)

View as Markdown

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 serviceMFiles.IRPCExportedDataSetsAdmin
Book and levelAdministration API, specialized
Methods9
Proto filemfiles/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.

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

MethodSummaryFacts
AddNewExportedDataSetAdds an exported data set.admin session
CancelExportedDataSetExecutionRequests that a running export of an exported data set stops.admin session idempotent
GetExportedDataSetExecutionStatusGets the progress and status of the latest export run of an exported data set.admin session idempotent
GetExportedDataSetsAdminGets all exported data sets of the vault.admin session idempotent
GetReportAccessCredentialsAdminGets the account that is used to access reports generated from the exported data.admin session idempotent
ModifyExportedDataSetReplaces the definition of an exported data set.admin session idempotent
RemoveExportedDataSetRemoves an exported data set.admin session
SetReportAccessCredentialsSets the account that is used to access reports generated from the exported data.admin session idempotent
TriggerExportedDataSetExecutionRequests an immediate export run of an exported data set.admin session idempotent