Docs Getting started
Getting started
Install the app in your consultancy's Salesforce org, give your team access, and add your first client.
Before you start
You need:
- A Salesforce org for your consultancy. Monitoring runs here and its data is stored here. Use your production org for real clients, and a sandbox to try things out. Salesforce doesn’t allow commercial use of Developer Edition orgs.
- A System Administrator in that org, to install the app.
- Your licence key, from the email we sent with your trial or purchase. It starts with
ohm_live_.
1. Install the app
- Open the install link from your email, and log in to your consultancy’s org as an administrator.
- Choose Install for Admins Only. You give everyone else access with permission sets in step 2.
- Salesforce warns that the package hasn’t been through AppExchange review. That’s expected: we sell directly for now. The security overview explains what the app does. Confirm to continue.
2. Give your team access
The app has two permission sets. Assign them in Setup > Users > Permission Sets.
| Permission set | Give it to | It lets them |
|---|---|---|
| OrgHealth Dashboard User | Every consultant who works with clients | Open the app, see the clients assigned to them, and work incidents |
| OrgHealth Manager | Practice leads and admins | Also see every client, add and remove clients, assign consultants, and change settings |
Managers who add clients also need some Salesforce permissions of their own, to create connections and email addresses. The Add client window checks these first and says if any are missing.
3. Activate your licence and start monitoring
- Open Org Health from the App Launcher. It opens in its own browser tab. Bookmark that tab if you like. If you see an empty Org Health app with no tabs instead, you’ve reached it some other way: open it from the App Launcher.
- In Settings > Licence, a Salesforce administrator pastes your licence key and chooses Activate licence. The app checks it with our licence service and shows your plan and limits. How licences work
- In Settings > Collection schedule, choose Start collection (every 30 minutes by default). The checks run as the person who starts them, so use a manager who will stay active and who can reach your clients: anyone who has added a client can. If that person leaves, choose Restart as me.
4. Add your first client
Go to Manage clients > Add client, name the client and choose the environment, such as Production or a sandbox. Then pick how to monitor it:
- Flow errors only: two Setup changes in the client org and nothing to install. Set it up
- Full monitoring: a read-only connection, set up by the client admin’s login, a script or a checklist. Connect a client
When the first check passes, the client appears on Portfolio. Assign consultants to it from Manage clients > Assign people, so they see it and get its alerts. Any manager can assign. When the manager isn’t a Salesforce administrator, the person’s access follows a few seconds later.