Configuration variables

The following enumerates and describes the different fields that can be set within the configuration. Each field can be referenced to within the SQL and the client itself.

List

Config key

SQL variable name

Data type

Required?

Description

branch_id

_BF_BRANCH_ID

Integer

TRUE

The current branch being operated on. All data from this branch will be placed on top of the main branch (unless this is the main branch) when making queries.

org_id

_BF_ORG_ID

Integer

TRUE

The current organization. All source data will be filtered by this ID.

env_id

_BF_ENV_ID

Integer

TRUE

The current environment. All source data will be filtered by this ID.

system_dt

_BF_SYSTEM_DT

Timestamp

FALSE

The current date time of the system. All source data will be filtered based on created_at <= system_dt. The default for this field is the current time.

rating_as_of_dt

_BF_RATING_AS_OF_DT

Timestamp

FALSE

The date time that determines the status field of invoices, line items and rated events. The default for this field is the current time.

dedup_branch_events

_BF_DEDUP_BRANCH_EVENTS

Boolean

FALSE

A boolean to determine whether or not events are deduplicated. The default is FALSE.

rating_range

_BF_RATING_RANGE_START, _BF_RATING_RANGE_END

Timestamp

FALSE

A timestamp range for calculating invoices, line items and rated events.

contract_ids

_BF_CONTRACT_IDS

JSON array

FALSE

A list of contracts to filter on.