reveneraR (version 1.0.1)

get_client_metadata: Get Metadata on Client Ids for a List of Product Ids

Description

Returns metadata (what Revenera calls "properties") for every Client Id installed during user-provided date range for all product Ids in a list.

Usage

get_client_metadata(
  rev_product_ids,
  product_properties_df,
  desired_properties,
  installed_start_date,
  installed_end_date,
  chatty = FALSE
)

Value

Data frame with selected properties for each Client Id.

Arguments

rev_product_ids

A vector of Revenera product id's for which you want active user data.

product_properties_df

Data frame with available properties for all product ids. Can obtain with the get_product_properties function.

desired_properties

The property names of the metadata you want to collect.

installed_start_date

Date object for the starting date of product installations.

installed_end_date

Date object for the ending date of product installations.

chatty

The function can be chatty, sending a message to the console for every iteration through a product Id. Many API calls may be required and the console may get very long and it may slow down the execution.

Details

It is not recommended that your username be stored directly in your code. There are various methods and packages available that are more secure; this package does not require you to use any one in particular.

This API call can only return 200 Client Ids at a time. It will take a long time to execute if you have many Client Ids, as the function will submit requests to the API repeatedly; this may even result in a timeout error from the server. In order to provide data for troubleshooting this function will write a message to the console after each call. It is recommended that you divert the console output to a text file. You can do this in multiple ways, including with the sink function (see example for how to do this).

For the same reason you are encouraged to break your request into smaller chunks using the install dates and/or splitting up your product Ids.

Examples

if (FALSE) {
rev_user <- "my_username"
rev_pwd <- "super_secret"
logout(rev_user, rev_pwd)
Sys.sleep(30)
revenera_auth(rev_user, rev_pwd)
product_ids_list <- c("123", "456", "789")
product_properties <- get_product_properties(product_ids_list)
sink("output_filename.txt") # write out chatty messages to a file
sink(stdout(), type = "message")
client_metadata <- get_client_metadata(
  product_ids_list, product_properties, c("Property1", "Property2"),
  start_date, end_date, chatty = TRUE
)
sink()
}