- Admin Console Guide: Introduction
- What is the Admin Console?
- Create a Team
- Invite and Manage Members
- Set Team Scope
- Cloud Integrations
- Admin Console Options
- 📖 Campaigns
- 📤 Deployments
- 💽 Databases
- 🤖 Service Accounts
- 📈 Telemetry
- ⚙️ Team Settings
Admin Console Guide: Introduction
What is the Admin Console?
The Admin Console is a web app for creating and managing PixieBrix teams, viewing user telemetry, troubleshooting errors, and more. You can access the Admin Console at https://app.pixiebrix.com/.
The Admin Console has multiple sections, some of which may be hidden depending on your role. Let’s analyze each section below:
Teams enable multiple accounts to share mods, service integration credentials, team databases, and more.
When you first sign up to PixieBrix, you will have an individual account. Additionally, if your email address is assigned to an Enterprise Plan, your account will also be part of that Team.
You can create a Team and invite your friends and colleagues.
Create a Team
To create a Team, click Create Team at the top of the Admin Console, enter a team name, and click Create Free Team Account.
If you are already a member of a team, click the Team Selector in the top nav bar
Then, click the Create Team button at the bottom of the dropdown:
Invite and Manage Members
To invite team members, input their email addresses, assign roles, and click Invite Team Members. Follow this link for more on Team Roles.
Invitees will receive an email that includes a link to Accept the Invitation. Clicking the link will guide the team member through PixieBrix onboarding.
Also within the Members tab, you can click on any team member’s name to change their role, view error telemetry, and more.
Set Team Scope
Finally, an Admin can set a Team Scope to enable team members with a Developer role to create/edit team mods and bricks.
An Admin can set the Team Scope in the ⚙️ Settings screen of the Admin Console.
Cloud Integrations enable Admins to share access to APIs and 3rd-party services across your PixieBrix installs and team members.
Alternatively, team members can configure Personal Integrations in the Extension Console. Credentials for Personal Integrations are stored locally in the web browser.
Admin Console Options
See below for information on Admin Console screens for configuring Pro, Business, and Enterprise teams.
A Campaign is a reporting entity to track engagement for a set of team members.
Groups are sets of team members that have access (read or edit) to any number of bricks, databases, and shared Cloud Integration configurations. Additionally, an Admin can associate a Deployment with one or more Groups to have PixieBrix automatically deploy a Mod to those team members.
Deployments enable an Admin to automatically provision PixieBrix mods to groups of team members.
Team Databases enable a mod to store data across runs, installs, and team members.
A Team Database is a key-value store. Each record is referenced by a unique key, and stores a JSON object.
🤖 Service Accounts
Service Accounts are API-only accounts. Like their human counterparts, Service Accounts have a Role and can be added to a Group(s). Unlike human team members, Service Accounts do not count toward your Organization's subscription utilization.
Telemetry provides engagement and errors information to help you detect, diagnose, and debug problems with mods.
⚙️ Team Settings
At the bottom of the Admin Console you’ll find your teams’ Settings, which enable an Admin to configure:
- Your team’s name
- Your team’s scope (the identifier after the @ sign that provides a unique namespace for brick and mods your team creates)
- Your team’s default role: the role automatically assigned to any new team member associated via email domain or Group membership (Enterprise-only)