Extracting Data

The following steps provide an overview of how to extract data. These steps assume that an application has previously been opened with one of the OpenApplication methods.

Tip:

For an example that illustrates these steps, see Example for Extracting Data.

  To extract data:

  1. Set an object reference to the HsvcDataLoad object.

  2. Point to the application from which data is being extracted by calling HsvcDataLoad.SetSession. For SetSession’s argument, pass the HsvSession object reference that was returned by HsxClient.OpenApplication or HsxClientUI.OpenApplication.

  3. Set an object reference to the IHsvLoadExtractOptions interface with the HsvcDataLoad.ExtractOptions property.

  4. Specify the dimension members for which data is being extracted by setting the following extract options. You are required to specify these options:

    • The dimension member ID of the scenario.

    • The dimension member ID of the year.

    • The dimension member IDs of the periods.

    • The dimension member IDs of the accounts.

    • The dimension member IDs of the child entities.

  5. Optional. To override the defaults for other extract options, specify the values for these options. The available extract options are listed in Table 80, Data Extract Options.

  6. Extract the data by calling HsvcDataLoad.Extract. Extract takes the file names and paths of the data extract file and of the log file.