Skip to main content

System Admin Cheat Sheet

A quick reference guide for System Admins.

Jared Elliott avatar
Written by Jared Elliott
Updated over a year ago

Contents


Accessing System Settings

System Admins will see a gear icon on the left side of O3.

When you hover your mouse over it, you should see System Admin.

Clicking on this will bring you to your site's system settings.

User Management

Creating System Users

Manually

(1) Expand the User Admin dropdown and (2) click on Users.

Then click on the + above the grid.

The Username, Display Name, and Email fields are required by default. Your site's User Data Requirements might require additional fields.

SAML Single Sign On is enabled by default. If you don't have MFA configured for your organization, uncheck this box.

We always recommend providing a Default Plant. This helps O3 support understand what set of configurations they should refer to when providing support and troubleshooting.

Once their account is created, you'll be brought to their Details page.

Via Import

The following headers are required for your import file:

  • Username

  • Email

  • Display Name

If your organization uses SSO, you'll want to make sure SAMLSINGLESIGNON is set to TRUE.

You can also add users to a project and assign them access by using the Project and Role fields. You can only add one Role and Project per line.

See below to see how your import file may look.

To import your users, (1) expand the User Admin dropdown and (2) click on Users.

Then click on the Upload button above the grid.

Enabling the Send Welcome Email to New Users will send users a welcome email, which includes their login credentials and instructions.

Once you click Begin Import, you'll be brought to the Import Details page.

Pay close attention to import messages - these can be helpful in figuring out where your import went wrong.

Editing System Users

You can see a user's account info by double-clicking their entry in the grid.

To edit their account info, (1) click on the action menu icon > (2) Edit.

Reactivating a User's Account

Always confirm why a user's account is inactive. This might have been a deliberate change that was made or could be due to inactivity (as per your site's Login Settings).

After enabling edits for a user's account (see above), enable or disable Active to reactivate or deactivate their account.

Unlocking a User's Account

After a certain number of failed login attempts, a user's account is locked.

To unlock their account, (1) click on the action menu icon > (2) Unlock Account.

Users can reset their password via the login menu or you can send a password reset link via the action menu.

Managing Projects

You can see what projects a user has access to by scrolling down to their Projects grid.

To add them to a project, click on the +.

Then choose a project and determine what type of access they will have.

You can edit their project access by clicking on the desired project.

You can remove them from a project by highlighting the project and then clicking on the Delete icon.

User Data Requirements

(1) Expand the User Admin dropdown and (2) click on User Data Requirements.

This is where you can set the "requiredness" of your users' account info.

System Required cannot be edited. These fields are hardcoded.

We recommend setting Default Plant as Always Required. You can adjust the requirdness of fields by dragging them to a different column.

This helps O3 support understand what set of configurations they should refer to when providing support and troubleshooting.

Creating an API User

(1) Expand the User Admin dropdown and (2) click on API Users.

Then click on the + above the grid.

After creating the API User, you'll be brought to its User Details page.

To edit an user, (1) click on the action menu icon > (2) Edit.

API Users can be added to specific projects and should only be given the minimum roles and permissions necessary to perform their intended functions.

To regenerate its API key, click on Regenerate Key.

User Groups

Creating & Managing User Groups

(1) Expand the User Admin dropdown and (2) click on User Groups.

To create a new User Group, click on the + above the grid.

After entering its info, you're brought to its Details page.

Here you can add users to the User Group by clicking on the +.

To modify an existing User Group, double-click on it in the grid. In the Details page, (1) click on the action menu icon and (2) choose Edit.

User Group Members

You can see members across all User Groups in a single grid by going to User Group Members.

Grouping by User Group conveniently shows you each User Group as well as its members.

Creating & Managing Roles

(1) Expand the User Admin dropdown and (2) click on Roles.

To create a new role, click on the + above the grid.

Roles can be assigned to plants, meaning these roles are only available to projects in that plant.

After creating your role, you'll be brought to its Details page.

This matrix lets you determine what this role has access to. Check or uncheck the box to allow or restrict access as needed.

Note: users will need View access if you are allowing them to Create or Update items. They do not get his permission by default.

To modify an existing role, double-click on it in the grid. In the Details page, (1) click on the action menu icon and (2) choose Edit.

Login Settings

(1) Expand the User Admin dropdown and (2) click on Login Settings.

See below for an explanation of the login settings.

Requiring Special Characters in Passwords

Enabling the Require Special Characters in Passwords will require special characters to be in your users' passwords.

Enforce Password Expiration

Enabling the Enforce Password Expiration box means your users will have to update their password every X days.

Expire Inactive Accounts

Enabling the Expire Inactive Accounts box means that accounts are deactivated after X months of not logging in.

Make sure this makes sense for your users' schedules. If your team is on a rotational schedule, make sure their account isn't going to be deactivated every time they get relieved.

Enable Inactivity Timeout

The Enable Inactivity Timeout box lets you set a time limit for user inactivity within O3. If they are idle for X minutes, they will be logged out.

Plant/Project Management

System Lookups

(1) Expand the Project Admin dropdown and (2) click on Lookups.

You can change the Lookup Type you're managing at the top.

To create a new lookup option, enter it at the bottom and click Add.

You can delete options by clicking on its X.

Note: some Lookup Types are hardcoded and cannot be modified through the UI.

Creating Plants

This section covers how to create plants. If you want to learn more about managing plants, check out our Plant Admin Cheat Sheet.

(1) Expand the Project Admin dropdown and (2) click on Plants.

All existing plants can be found in the grid.

Click on the + at the top to create a new plant.

Creating Companies

(1) Expand the Project Admin dropdown and (2) click on Companies.

Click on the + above the grid to create a new company.

To edit a company, double-click on its name in the grid.

System Settings

File Upload Settings

(1) Expand the System dropdown and (2) click on File Upload Settings.

Users are only able to upload files with the permitted file extensions in the list.

If they try to upload an invalid file, they'll receive the below error message.

To allow a file type, enter the extension in the list.


Check out some of our other Cheat Sheets!

Did this answer your question?