parse_report_detail_rows: Format the detailed data from the "T!T" fact map in a tabular...

In salesforcer: An Implementation of 'Salesforce' APIs Using Tidy Principles

Format the detailed data from the "T!T" fact map in a tabular report

Description

This function accepts a list that is directly returned by the API and further parses it to return a single tbl_df representing the detail rows and columns of the report without any filters, aggregates, or totals.

Usage

parse_report_detail_rows(
  content,
  fact_map_key = "T!T",
  labels = TRUE,
  guess_types = TRUE,
  bind_using_character_cols = deprecated()
)

Arguments

content	list; the list returned from the content function that parses the JSON response to a list.
fact_map_key	character; string providing an index into each section of a fact map, from which you can access summary and detailed data. The pattern for the fact map keys varies by report format so it is important to know what the reportFormat property of the target report is. See the note below for more details.
labels	logical; an indicator of whether the returned data should be the label (i.e. formatted value) or the actual value. By default, the labels are returned because these are what appear in the Salesforce dashboard and more closely align with the column names. For example, "Account.Name" label may be "Account B" and the value 0016A0000035mJEQAY. The former (label) more accurately reflects the "Account.Name".
guess_types	logical; indicating whether or not to use col_guess() to try and cast the data returned in the recordset. If TRUE then col_guess() is used, if FALSE then all fields will be returned as character. This is helpful when col_guess() will mangle field values in Salesforce that you'd like to preserve during translation into a tbl_df, like numeric looking values that must be preserved as strings ("48.0").
bind_using_character_cols	logical; an indicator of whether to cast the data to all character columns to ensure that bind_rows does not fail because two paginated recordsets have differing datatypes for the same column. Set this to TRUE rarely, typically only when having this set to FALSE returns an error or you want all columns in the data to be character.

Value

tbl_df; a data frame representing the detail rows of a parsed report result HTTP response where the rows represent each row in the report and the columns represent the detail columns.

Note

Below are the fact map key patterns for three report types:

TABULAR

T!T: The grand total of a report. Both record data values and the grand total are represented by this key.

SUMMARY

<First level row grouping_second level row grouping_third level row grouping>!T: T refers to the row grand total.

MATRIX

<First level row grouping_second level row grouping>!<First level column grouping_second level column grouping>.

Each item in a row or column grouping is numbered starting with 0. Here are some examples of fact map keys:

0!T

The first item in the first-level grouping.

1!T

The second item in the first-level grouping.

0_0!T

The first item in the first-level grouping and the first item in the second-level grouping.

0_1!T

The first item in the first-level grouping and the second item in the second-level grouping.

This function is meant to be used internally. Only use when debugging.

salesforcer documentation built on March 18, 2022, 6:26 p.m.