test-pphe-data-pro/includes/docs.js
2025-08-19 13:35:32 +00:00

94 lines
3.8 KiB
JavaScript

// Universal fields
const tenant_code = `The tenant/chain that the record belongs to`;
const property_code = `The property that the record belongs to`;
const export_insert_time = `Date and time the raw data record was inserted to BigQuery from Opera R&A`;
const staging_insert_time = `Date and time the staging data record was inserted from the raw data table`;
// Identifiers
const reservation_id = `Within a given property and tenant, identifier for the individual reservation`;
const reservation_product_id = `Within a given property and tenant, identifier for the individual reservation product`
const financial_transaction_id = `Within a given property and tenant, identifier for the individual transaction`;
const group_id = `Within a given property and tenant, identifier for the individual business group`;
const event_id = `Within a given property and tenant, identifier for the individual event`;
const profile_id = `Within a given property and tenant, identifier for the individual profile`;
const market_segment_code = `Market code`;
const group_profile_id = `Profile ID of the group`;
const travel_agent_profile_id = `Profile ID of the travel agent`;
const company_profile_id = `Profile ID of the company`;
const guest_profile_id = `Profile ID of the guest`;
const guest_country_code = `Country code of the guest`;
const booking_status_code = `Booking status`;
const booking_source_code = `Booking source`;
const block_code = `Block code`;
const rate_code = `Rate code`;
const transaction_code = `Transaction code`;
const reservation_status_code = `Reservation status`;
const room_category_code = `Room category`;
const booked_room_category_code = `Booked room category`;
const room_class_code = `Room class`;
const room_type_code = `Room type`;
const confirmation_number = `Confirmation number of the reservation`;
// Dimensions
const guest_country_name = 'Country name of the guest';
const product_name = `Product/package code`;
const product_description = `Full description of the product/package`;
const group_description = `Full description/name of the group/block`;
// Dates and times
const considered_date = `Business Date that the data corresponds to`;
// Booleans
const is_meeting_room_flag = `Indicates whether the room is a meeting room`;
const is_pseudo_room_flag = `Indicates whether the room is a pseudo room`;
// Stats and metrics
const number_of_rooms = `Number of rooms`;
const room_nights = 'Total number of nights (across all rooms) for the reservation';
const adults = `Number of adults`;
const children = `Number of children`;
const room_revenue = `Total net room revenue amount`;
const food_revenue = `Total net food and beverage revenue amount`;
const total_revenue = `Total net revenue amount`;
const other_revenue = `Total of net revenue amount that does not fall under room, food, or beverage categories`;
module.exports = {
tenant_code,
property_code,
export_insert_time,
staging_insert_time,
reservation_id,
reservation_product_id,
financial_transaction_id,
group_id,
event_id,
profile_id,
market_segment_code,
group_profile_id,
travel_agent_profile_id,
company_profile_id,
guest_profile_id,
guest_country_code,
booking_status_code,
booking_source_code,
block_code,
rate_code,
transaction_code,
reservation_status_code,
room_category_code,
booked_room_category_code,
room_class_code,
room_type_code,
confirmation_number,
guest_country_name,
product_name,
product_description,
group_description,
considered_date,
is_meeting_room_flag,
is_pseudo_room_flag,
number_of_rooms,
room_nights,
adults,
children,
room_revenue,
food_revenue,
total_revenue,
other_revenue
}