DOCSEARCHbyAlgolia
Submit Docs

QReserve Documentation

website·Indexed 33 days ago

https://get.qreserve.com/documentation

Documentation for QReserve, featuring guides on setting up usage fees, booking buffers, training prerequisites, and asset maintenance. Includes a comprehensive Internal API reference for managing users, resources, and site properties, as well as technical specifications for custom scripts, control flow, and basic types.

Tokens
97.8K
Snippets
270
Records
735
Agent score
65%

What's inside QReserve

  1. Overview of QReserve Rate Scripts

    Rate Scripts allow for the dynamic calculation of pricing for reservations and requests in QReserve. By attaching a Rate Script to a rate, developers can implement custom pricing logic that reacts to reservation details, user information, and other execution context variables.

  2. Overview of Invoice Scripts

    Invoice Scripts allow developers to customize how invoice items are generated when a reservation or Actual Usage record is added to an invoice. They can be attached to a resource to dynamically modify, add, or remove invoice items based on custom business logic.

  3. Overview of QReserve Sandbox Server (The Lab)

    The Lab is a specialized sandbox environment for Enterprise customers to experiment with features and train users using a copy of production data. To ensure consistency and prevent long-term testing impacts, the environment is reset weekly, typically around 4 AM UTC on Sundays.

  4. Overview of Actual Usage Reports

    The Actual Usage Reports page allows administrators to compare physical resource usage against scheduled reservation times. It tracks check-in methods, session durations, and timing variances (e.g., late check-outs). To use these reports, actual usage methods (check-in and check-out) must be enabled on the site.

  5. Overview of QReserve Credentials API

    Credentials in QReserve are records associated with users within a site or portal. They can be used to restrict resource access, filter users for messaging, or drive logic in reservation and rate scripts.

    Important Compatibility Note: Credentials were historically called training. Consequently, many API endpoints and fields still use the term training instead of credentials.

  6. Overview of Credentials Management

    The credentials module (formerly known as training) allows administrators to define record classes (e.g., 'Lab Safety' or 'Facility Membership') and assign them to users. These records can have expiry dates, which trigger automated warning emails to users during the month prior to expiration. Credentials can be used to restrict reservations based on whether a user holds a valid, non-expired record.

  7. Overview of QReserve Resource Rates

    QReserve allows administrators to associate one or more rates with any reservable resource to provide cost estimates to end users and generate usage reports. Rates can be configured to apply automatically based on user group membership, day-of-week, and time-of-day. If multiple rates are available, users can select the appropriate one during booking, or moderators can assign it later. If at least one rate is available, a rate must be selected for the reservation unless the 'Request a Quote' option is enabled.

  8. Overview of Check-In Desk Kiosk Mode

    Check-In Desk Mode transforms a kiosk into a check-in station that presents a list of names of people scheduled for reservations. This mode supports both registered users and non-registered visitors.

  9. Overview of QReserve Platform

    QReserve is a reservation and asset management platform used for managing digital assets, booking events, and organizing resources. It provides a scalable solution for streamlining these processes and offers an API for integration.

  10. Overview of Approver Scripts

    Approver Scripts allow developers to dynamically determine the approval workflow for reservations by attaching a script to a resource. These scripts enable customized approval processes that adapt to business requirements based on specific conditions.

  11. Monitor site growth and activity via the Usage dashboard

    Administrators can access the Usage tab under Site Settings to view a high-level analytics dashboard. The dashboard includes an interactive chart that tracks three primary metrics on a month-by-month basis:

    • Active Users: The total count of distinct users engaging with scheduling workflows each month.
    • Active User Limit: The maximum monthly active user threshold allowed by the current subscription tier.
    • Reservations: The total volume of bookings and reservation requests logged across all site resources per month.

  12. Use the built-in sneq IDE for script development

    QReserve includes a built-in IDE for the sneq language, accessible when editing scripts. The IDE provides automatic syntax parsing and highlighting. If parsing errors occur, the invalid syntax is highlighted with an icon; mousing over the icon reveals the specific parsing error. The 'Save' button is only enabled once the script parses successfully.