Organizations

In the Q-SYS Reflect hierarchy, an Organization is the entity that is registered with Reflect. In most cases, this is a company name – for example, a hotel chain, restaurant chain, and so forth. Organizations can contain one or more Sites.

Note: Refer to the Overview topic to understand the relationship between Organizations, Sites, Systems, and Peripherals.

Add an Organization

Before adding an Organization to Q-SYS Reflect, you must have the Subscription ID that was generated during the Reflect subscription process.

  1. From the Organizations page, click + New Organization.
  2. Enter your Organization Name – for example, your company name.
  3. Paste the Subscription ID.
  4. Click Create.

Your new Organization appears in the table. Select it to perform management tasks, including renaming the default Site name.

Manage an Organization

To manage an Organization:

  1. Click Organizations from the Q-SYS Reflect menu.
  2. Select an Organization from the table.

The Overview tab contains Q-SYS Reflect subscription information and lists its associated Sites.

Renaming and Deleting the Organization

Click Rename to choose a new Organization name. Click Delete Organization to remove the Organization from Q-SYS Reflect.

CAUTION: When you delete an Organization, all of its Sites, membership information, and data are also deleted.

Subscription Details

  • Software Tier: This indicates the purchased Reflect software subscription tier. For more information, see Q-SYS Reflect Subscriptions.
  • 3rd Party API: 'Yes' indicates Third-Party API access is allowed as part of your subscription. For more information, see API Tokens.
  • Systems: This shows the number of Q-SYS Reflect System licenses that you have Purchased as part of your subscription, as well as the number currently In Use with actively registered Q-SYS Systems.
  • Prevent System license use from exceeding purchased quantity: When enabled, no additional Cores can be registered with Q-SYS Reflect if the Systems "In Use" count is already at the maximum allowed under the purchased subscription.

Tip: If you have recently changed your Q-SYS Reflect subscription, such as upgrading or downgrading the Software Tier or the quantity of purchased Systems, click Refresh License Info to show the latest subscription details.

Sites

This area lists the Sites associated with the Organization. By default, a new Organization contains a single Site named "Site". Click Rename to give the Site a new name. Other actions:

  • Click a Site name to see a list of its associated Systems. For more information, see Systems.
  • To create a new Site, click + New Site and give it a name.
  • Click Delete to remove the Site from the Organization.

    CAUTION: If you delete a Site from an Organization, all Site membership information and data from all associated Systems is removed.

This tab lists all the Owners of the Organization. As an Organization Owner, you can remove other owners and invite new owners from the Invites tab.

Tip: For more information about Reflect user roles, including Organization Owners, see Reflect Users and Roles.

Use the Invites tab to invite individuals to become Organization Owners.

  1. Click + Invite Owner.
  2. Type the individual's Email Address and optionally write a custom message.
  3. Click Send Invite.

Invites remain in Pending status until the individual accepts the invitation from the email. Other actions:

  • Resend Invite: If the individual did not receive the original invite, click to send another invitation email.
  • Cancel Invite: Click to rescind the invitation.

    Note: When you cancel an invite, the individual does not receive an email indicating the cancellation. Rather, the "Accept Invitation" button within the original invitation email links to a "Invitation Link Expired" page.

Use the API Tokens tab to manage access to the Q-SYS Reflect Third-Party API. The Third-Party API allows end-user monitoring applications (for example, SolarWinds) and managed service provider tools to obtain real-time status and events information from Q-SYS Reflect.

Download the API File

To use the API, download the YAML file to see what API requests are supported:

  1. Click Download API File, or right-click here.
  2. Save the qrem-public-api.yaml file to a location on your PC.
  3. Open the YAML file in a text editor to see what API requests are supported. See API Requests for more information.

Granting API Access

To grant API access to a third-party app:

  1. Click + New Token.
  2. Specify a Token Name, and then click Add.
  3. Click Copy to copy the token to the clipboard.

    CAUTION: This is the only opportunity to copy the token. Once you close window, only the last four characters of the token are visible within the list.

  4. Paste the token into an API request.

Revoking API Access

  1. Select a token name from the table.
  2. Click Revoke.