Use the Get started guide
Twelve steps in four phases, each showing what Sojourn found in your org just now, on the first screen of Sojourn Settings after install.
Get started is the first line of the Sojourn Settings menu, under Capture. It lists the twelve steps that take a new install to a first report, in four phases. Each step shows its status as Sojourn found it in your org just now, why the step matters, what it changes, what to do, and a How it works behind the scenes note that stays folded until you open it. A button opens the screen or the Setup page where you do the step. Where a step needs reading before you do it, a link such as Which set for whom or Run the jobs on the guide opens the page on this site that covers it; it shows while the step is not done, and on step 1 always. While the guide is not complete, step 4 done offers Add another object, which opens Tracked objects with the Add object dialog open. Only people with the Sojourn Admin permission set see the guide; see Assign permission sets.
Sojourn checks your org and never does a step for you: it changes nothing in Setup, and assigning a permission set or making a Flow stays your work.
When the guide opens#
Sojourn Settings opens on Get started while Open this guide first when Sojourn Settings opens is on and a required step is left. The switch is on after install. You can turn it off or on at any time from the progress card at the top of the guide.
Sojourn turns the switch off by itself the first time it finds every required step done and no step needing attention. Sojourn Settings then opens on the Overview, and Get started stays in the menu. Turning the switch off is a settings change, so it needs the Customize Application permission, which system administrators have. Without it, the guide says that Open this guide first could not be turned off, and Sojourn tries again the next time an admin who holds that permission opens Sojourn Settings.
A link that names its own screen, such as the addresses in Install Sojourn, opens that screen and not the guide.
What each status means#
| Status | What it means |
|---|---|
| Done | Sojourn found the step true. The step folds to a line, with the date where a record holds its own date. |
| To do | A step that counts is not true yet. |
| Not started | An optional step with nothing done yet. It carries the Optional tag and never holds the guide open. |
| Needs attention | Step 5 only: a Tracked object needs a capture Flow and has none. The step names the object, and the guide is not complete while it stands. |
| Could not check | Sojourn could not read what the step needs. The step says what it could not read and does not block the others. A required step at Could not check is not done. |
Every step that is not done opens by itself, and every done step folds to its line and its buttons. Choose a step's title to open or fold it.
A step stays true only while the org does. Sojourn reads every step again each time Sojourn Settings opens, so a job turned off, a Flow deactivated, or a sandbox refresh puts the step back to To do or Needs attention.
Could not check#
Most reads run as you, in user mode, so a step shows Could not check when your user is refused the data. The permissions that matter:
- View Setup and Configuration is needed to read the capture Flows (steps 4 and 5) and the edition (step 1). Without it, step 1 is still decided on your business hours, and the edition is left out.
- View Setup and Configuration, Assign Permission Sets, or Manage Users: any one of them lets Sojourn count who holds the permission sets (step 2).
- Steps 3, 7, 11, and 12 run no read that can fail. Step 6 reads the scheduled jobs the way the Jobs screen does, so no user permission applies to it. Steps 8, 9, and 10 read Sojourn's own objects, which Sojourn Admin grants, so Could not check there means the read failed: choose Check again, and if it happens again, ask a Sojourn admin to look at the Health Monitor.
The exact reads, and what each needs, are in the security notes that ship with the package.
Check again#
Check again in the progress card reads all twelve steps again and shows when it last did ("Checked just now", "Checked 5 minutes ago"). Steps 2, 5 (Re-check Flows), and 10 carry a button of their own beside their other buttons, since you fix those elsewhere and then come back. Each of them is the same single re-read of every step.
The four phases and twelve steps#
The tables say what makes each step Done and link to the page that covers the step; this page does not repeat them. Steps marked Optional never hold the guide open.
Before you start#
| Step | Done when | Read |
|---|---|---|
| 1. Check the prerequisites | Setup has at least one active business hours. The edition is shown and never blocks the step. | Check the prerequisites |
| 2. Assign permission sets | At least one person holds Sojourn Admin, and at least one holds Sojourn Manager or Sojourn User, directly or through a permission set group. | Assign permission sets |
Capture#
| Step | Done when | Read |
|---|---|---|
| 3. Turn on capture for the org | Tracking enabled is on. A new org starts with it on, so this step begins Done. | Track an object |
| 4. Track your first object | An active Tracked object has an active Tracked field, and its capture pill reads Tracked by package or Flow active. | Track Cases and open your first report |
| 5. Set up a capture Flow for other objects | Every active Tracked object other than Case, Lead, and Opportunity has an active capture Flow. Required only when such an object exists, which is the Plus plan; an object whose pill reads Flow missing makes the step Needs attention. | Track an object |
Keep Intervals current#
| Step | Done when | Read |
|---|---|---|
| 6. Turn on the jobs | Live values, Reconcile, and Summaries are all scheduled. | Run the jobs |
| 7. Choose how long to keep Intervals | On the Plus plan, a retention choice is saved; Keep everything counts as a choice. On the Free plan the step is Done by itself, because Sojourn keeps everything. | Keep or purge Intervals |
Make the time useful#
| Step | Done when | Read |
|---|---|---|
| 8. Set goals and queue business hours (Optional) | At least one active Goal that you can see exists; a Goal you deactivated is not counted. The step also counts the queues with their own business hours. | Set goals and business hours |
| 9. Backfill past Intervals (Optional) | A History Backfill has completed, or a Catch up has run, on any Tracked object. | Backfill past Intervals |
| 10. Check capture is live and open your first report | You can see at least one Interval. Once it is Done, the step also says how many Intervals there are and which Sources wrote them. | Track Cases and open your first report |
| 11. Put the timeline on record pages (Optional) | You mark it done; Sojourn cannot read your record pages. | Show the timeline on a record |
| 12. Decide who sees the packaged dashboards (Optional) | You mark it done; Sojourn cannot read who the dashboards run as or who their folder is shared with. | Install Sojourn |
On the Free plan, the steps that belong to the Plus plan carry a Plus plan tag that links to Upgrade to Plus; see Free and Plus plans.
The two steps you mark done#
Steps 11 and 12 are changes in Setup and in Lightning App Builder, which Sojourn cannot read. Each shows a Mark as done box. Tick it once the work is finished, and the step shows who marked it and when ("Marked done by Alex Dawson on 22 Oct 2026"), and counts as Done from then on. To take a mark back, untick the box: the step returns to Not started, and the other step keeps its own mark. Saving or taking back a mark needs the Customize Application permission, like the other Settings saves. Sojourn keeps the marks as org settings.
The marks and the switch travel in the settings file: a set-up made in a sandbox and imported in production brings Open this guide first and both marks with it. A mark whose person is not in the other org shows the date without a name. See Move settings between orgs.
The Overview banner and the menu count#
While the guide is not complete, whether or not it opens first, the Overview opens with a banner above its header card: how many steps are done, the required steps still to go by name, and any object that needs attention, with Continue to open Get started. The banner takes the place of the Overview's retention line, since the guide covers retention, and leaves once every required step is done and none needs attention.
The Get started line in the menu shows a count such as 3 of 12 while any of the twelve steps is not done. It shows no count when all twelve are done, and no count and no banner when Sojourn could not load the guide.
You are done when
- Every required step reads Done, or Done by itself on the Free plan, and no step needs attention.
- The guide shows Set up complete, and Open this guide first is off.
- Sojourn Settings opens on the Overview with no banner.
Updated in release 1 This page changes in the same pull request as the feature it describes.