Aline Managed Package — Post-Installation Instructions
These instructions are for the Salesforce Administrator responsible for configuring the Aline Managed Package after it has been installed in your Salesforce org. Complete each section in order.
Prerequisites
- The Aline managed package has been successfully installed in your Salesforce org. Installation links for every released version are listed in Package Versions.
- Salesforce edition: Lightning Experience is required — every Aline component is a Lightning Web Component. Any edition that supports managed packages and custom objects (Professional with API access, Enterprise, Unlimited, or Developer) is suitable.
- You have System Administrator access, or an equivalent profile that can assign permission sets, edit page layouts, and use Lightning App Builder.
- You have received your API Token from your Aline representative. The token is required — the integration will not work without it.
Step 1 — Assign Permission Sets to Users
The package ships with two Permission Sets. Every user who needs to interact with Aline must be assigned at least one.
| Permission Set | Who should receive it |
|---|---|
| Aline Admin | Salesforce administrators and anyone who needs to configure the integration or manage all Workflow / Document records |
| Aline Standard User | Sales reps and other end users who launch workflows and view Aline data |
How to assign a Permission Set
- Navigate to Setup → Users → Users.
- Click the name of the user you want to assign.
- On the user detail page, click Permission Set Assignments → Edit Assignments.
- In the Available Permission Sets list, select Aline Admin or Aline Standard User (or both, if the user is an admin who also launches workflows).
- Click the Add arrow to move it to Enabled Permission Sets.
- Click Save.
Repeat for each user who needs access to Aline features.
Tip: You can also go to Setup → Users → Permission Sets, open the desired set, click Manage Assignments, then Add Assignments, select users, and click Assign.
Step 2 — Configure the Aline API Credentials
The package includes a dedicated Aline Configuration page for entering your API credentials. Only users with the Aline Admin permission set can save configuration.
Steps
- Click the App Launcher (waffle icon in the top-left corner).
- Search for Aline Configuration and open it.
- Enter the following:
- API Token — the token provided by your Aline representative. This field is masked for security.
- Launch Mode (under Advanced) — controls what happens when a user launches a workflow:
- Post (default) — sends data directly to Aline and shows a success screen; sales reps stay in Salesforce.
- Redirect — sends data to Aline and opens the Aline workflow in a new tab.
- Click Save Configuration.
- A green success banner will confirm the credentials have been saved.
Important: The API Token is stored in a Protected Custom Setting. Once saved, it cannot be retrieved or viewed through the Salesforce UI or API — it is only readable by the package's Apex code. If you need to rotate the token, return to this page and enter a new value.
Leave blank to keep existing token: The API Token field is write-only — once a token has been saved, the field is no longer marked required. To change other settings (Launch Mode, Enable Download Documents, etc.) without re-entering the token, just leave the API Token field blank and click Save.
Enable Download Documents — nothing for you to configure. The Generated Documents datatable (the list with per-row Download buttons on the workflow launcher success screen) is switched on entirely by a Custom Metadata record that your Aline representative creates for your org. You will not see an "Enable Download Documents" checkbox by default, and once the capability is enabled the datatable is already on — there is no second step. If you want this datatable, ask your Aline representative to enable it. See Optional capabilities enabled by Aline below.
If a checkbox labelled Enable Download Documents does appear on the page, it is a legacy control retained for upgrade safety. Ticking or unticking it has no effect in version 0.5.0 — the Custom Metadata record is the only thing that turns the datatable on or off.
Note on Base URL: The Aline Base URL is set to the standard Aline endpoint (
https://app.aline.co) and is read-only — you cannot change it from this page. If your environment needs a different Base URL, contact your Aline representative, who can unlock the field for your org. If a different Base URL is set and its host differs from the Remote Site Settings shipped with the package, an administrator must add a matching Remote Site Setting or the callouts to Aline will fail.
Verifying the configuration
After saving, the page will display a green Configuration Status indicator. If it shows a warning about missing fields, double-check the API Token value and save again.
Optional capabilities enabled by Aline (feature flags)
Most orgs need nothing here. The package works out of the box, and no feature-flag records ship with the package. These are optional per-org capabilities that your Aline representative turns on for you when a specific need comes up — they are not something you configure during a standard setup.
| Capability | What it does when your Aline representative enables it |
|---|---|
| Editable Base URL | Unlocks the Aline Base URL field on the Aline Configuration page so you can point the org at a non-standard Aline environment. Read-only otherwise. |
| Verbose diagnostic logging | Also records successful traffic to the Aline Error Log, not just failures. Used temporarily while investigating an issue, then turned back off so log storage isn't consumed. |
| Generated Documents datatable | Reveals the Enable Download Documents checkbox in the Aline Configuration page, which in turn shows the post-launch Generated Documents list on the launcher success screen. |
| Override calculated fields | Adds a small edit (pencil) icon next to read-only calculated fields on the launch form, letting a user send a different value to Aline for the generated document without changing the value in Salesforce. Off by default. |
If your Aline representative asks you to enable one, they will provide the exact steps. To turn a capability back off, the corresponding record is deleted — again, normally done by your Aline representative.
About Supported Objects
The launch form pulls Salesforce field values from a defined set of objects. Which objects are permitted is controlled by a Custom Metadata Type — Aline Supported Object — and the package ships with working records, so a fresh install needs no configuration here.
| Object | Read (show on the form) | Update (write back on launch) |
|---|---|---|
| Opportunity | ✅ | ✅ |
| Account | ✅ | ✅ |
| User | ✅ | — (read-only) |
Adding another object. If Aline templates need fields from an object not listed above, go to Setup → Custom Metadata Types → Aline Supported Object → Manage Records → New, enter the object's API name, and tick Allow Read and/or Allow Update. No package upgrade is required.
⚠️ Allow-listing an object is necessary but not always sufficient. The launch form can only resolve fields on the record the launcher was opened from (the Opportunity), that record's Account, and its Owner. Adding an object with no such relationship — a child object such as Opportunity Products, for example — will pass the allowlist but render no fields, and each dropped field is written to the Aline Error Log. Talk to your Aline representative before adding objects beyond the three above.
⚠️ Do not delete the shipped records. This list is fail-closed: if the
Opportunityrecord is deleted or its Allow Read box is unticked, Opportunity fields silently stop appearing on the launch form — with no error message. If a user reports "my fields disappeared," check here first.
Step 3 — Add the Launch Workflow Quick Action to the Opportunity Page Layout
The Launch Aline Workflow button is delivered as a Quick Action and must be added to the Opportunity page layout.
Steps
- Navigate to Setup → Object Manager → Opportunity → Page Layouts.
- Click the page layout used by your sales team (commonly Opportunity Layout).
- In the Page Layout Editor, click the Mobile & Lightning Actions category in the left palette.
- Locate Launch Aline Workflow in the list of available actions.
- Drag Launch Aline Workflow into the Salesforce Mobile and Lightning Experience Actions section of the layout. Place it near the start of the action bar for prominence.
- Click Save.
Note: If you use multiple Opportunity page layouts (for example, different layouts per record type), repeat this for each layout where the action should appear.
Verifying the Quick Action
Navigate to any Opportunity record. You should see the Launch Aline Workflow button in the action bar near the top of the record. On mobile it appears in the Actions menu.
Step 4 — Add the Aline Workflow Explorer to the Opportunity Record Page
The Aline Workflow Explorer is a Lightning component that displays a hierarchical tree of all Aline activity for an Opportunity — workflows, their documents, and each document's versions — in a single view. This is the recommended way for sales teams to see Aline activity directly on the Opportunity.
Steps
- Open any Opportunity record.
- Click the gear icon (top right) → Edit Page. Lightning App Builder opens.
- In the left palette, scroll to Custom — Managed and locate Aline Workflow Explorer.
- Drag the component onto the Opportunity page. The main content area is recommended — the component works best with horizontal space.
- With the component selected, use the right panel to configure which optional columns to display (Status, Doc Type, Version, Created, Link type). The Name, Type, and Download columns are always shown.
- Click Save → Activate → Assign as Org Default (Desktop).
- Return to the Opportunity record to see the component in place.
Verifying
Open an Opportunity that has Aline activity. You should see the Aline Workflow Explorer card with workflows auto-expanded, documents collapsed, and a download icon on each document and version row.
Step 5 — (Optional) Add Aline Related Lists to the Opportunity Page Layout
If you prefer Salesforce's native related lists in addition to (or instead of) the Workflow Explorer, you can add them to the Opportunity page layout.
Steps
- Navigate to Setup → Object Manager → Opportunity → Page Layouts.
- Open your Opportunity page layout.
- Scroll to the Related Lists section of the layout.
- In the palette, click Related Lists.
- Drag Aline Workflows into the Related Lists section.
- Drag Aline Documents into the Related Lists section.
- (Optional) Double-click each related list to customize the columns:
- Aline Workflows — recommended: Workflow Name, Stage, Workflow URL, Created Date
- Aline Documents — recommended: Document Name, Status, Type, Document URL, Created Date
- Click Save.
Note: The Workflow Explorer component (Step 4) covers the same data in a richer hierarchical view, so this step is optional.
Step 6 — (Optional) Confirm Download Quick Actions
The package ships two Download Quick Actions that are pre-added to their respective page layouts:
- Download Latest on the Aline Document layout
- Download on the Aline Version layout
Clicking them retrieves a short-lived secure link from the Aline platform and opens the file in a new browser tab. No extra setup is required.
Also available in the Workflow Explorer: The Aline Workflow Explorer (Step 4) includes a download icon on every Document and Version row, backed by the same action. Sales reps can download files straight from the Opportunity without navigating into each record — this is usually the most convenient entry point.
Verifying
- Open any Aline Document record → confirm the Download Latest button appears in the action bar.
- Open any Aline Version record → confirm the Download button appears.
- Open an Opportunity with Aline activity and confirm the download icon appears next to Document and Version rows in the Workflow Explorer.
- Click any of the above — a new browser tab opens with the file.
Note: If the API credentials haven't been configured (Step 2), the button will display an error. Complete Step 2 first.
To customize: To reorder, remove, or add more actions on the record pages, go to Setup → Object Manager → Aline Document / Aline Version → Page Layouts → Mobile & Lightning Actions.
Step 7 — (Optional) Review the Aline Error Logs
The package writes a record to Aline Error Log (Aline_Error_Log__c) any time a call to or from Aline fails — bad credentials, network errors, Aline-side exceptions, invalid inbound requests, etc. These records are visible only to users with the Aline Admin permission set.
Steps
- Click the App Launcher → search for Aline Error Logs and open it.
- Browse recent entries. The ship-provided layout is organized into Summary, Endpoint, Error Details, Payloads, System Information — admins can triage without a developer.
- Use the Error Type and Log Level fields to filter (ERROR vs DEBUG).
Notes
- ERROR entries are always captured — no configuration needed. ERROR rows are written for any non-2xx response, any callout exception, and any HTTP 200 response that includes a GraphQL
errors[]envelope (this last case is what surfaces business-level failures returned by Aline even when the network call itself succeeded). - DEBUG entries (truly successful traffic) are only captured when your Aline representative has enabled debug logging for your org. Contact them if you need deeper tracing for an issue.
- Request and response bodies are captured (truncated at 131 KB). Headers are deliberately not stored.
Step 8 — Verify End-to-End Functionality
Once the required steps are complete, perform a quick smoke test.
- Log in as a user with the Aline Standard User permission set.
- Open any Opportunity.
- Click Launch Aline Workflow in the action bar. The launcher modal should open and display the available templates from Aline.
- If you see a "Configuration not found" error → complete Step 2.
- If you see a "Permission" error → complete Step 1.
- Select a template. The launch form opens with its inputs grouped into collapsible accordion sections — Required Fields, Optional Fields, Aline-only fields, and Signers — in a two-column layout. Confirm the fields render and are editable.
- If the template defines signer roles, the Signers section shows a Name and Email picker for each. Start typing a name or email and confirm the dropdown lists members of your Aline org; picking one fills both fields. (Typing a brand-new email by hand also works, for external signers.)
- Calculated fields (formulas and roll-up summaries) are shown read-only with their current value — this is expected. They become overridable only if your Aline representative has enabled the Override calculated fields capability for your org.
- Click Launch Workflow and confirm the launch completes and a success screen appears.
- After a workflow is created, confirm that it appears in the Aline Workflow Explorer component on the Opportunity (or in the related list if you added Step 5).
About Cross-Opportunity Documents and Workflows
The package supports the common scenario where a single document or workflow applies to multiple Opportunities — for example:
- A Master Service Agreement (MSA) that governs several Opportunities at the same account
- A bundled deal workflow that covers multiple product-line Opportunities
This is handled automatically behind the scenes via two junction objects included in the package:
Aline_Document_Opportunity__c— links one Document to many OpportunitiesAline_Workflow_Opportunity__c— links one Workflow to many Opportunities
The Aline Workflow Explorer (Step 4) shows both direct-linked and junction-linked records automatically, so sales teams see the full picture on each Opportunity without any extra configuration.
If you'd like to also surface these junction relationships via native related lists (for example, an Aline Documents (M2M) related list on the Opportunity page), you can add them through the page layout editor. No extra configuration is required for the integration itself to work.
Troubleshooting
| Symptom | Likely Cause | Resolution |
|---|---|---|
| "Launch Aline Workflow" button not visible on Opportunity | Quick Action not added to page layout | Complete Step 3 |
| Aline Workflow Explorer component not visible | Component not added to the Opportunity record page | Complete Step 4 |
| Workflow launcher shows "Configuration not found" | API credentials not saved | Complete Step 2 |
| Workflow launcher shows a permissions error | User missing permission set | Complete Step 1 |
| Templates list is empty in the launcher | Incorrect API Token; or network access issue | Verify credentials in Step 2; contact your Aline representative if the issue persists |
| Aline is not creating Workflow / Document records in Salesforce | OAuth between Aline and Salesforce not configured | Contact your Aline representative to verify the Aline-to-Salesforce connection |
| Users can see Aline records but cannot edit them | User only has Read permission | Assign Aline Standard User or Aline Admin as appropriate |
| Download button shows an error | API Token missing or invalid | Complete Step 2 |
| Opportunity or Account fields no longer appear on the launch form | A shipped Aline Supported Object record was deleted, or its Allow Read box was unticked — the list is fail-closed and gives no error | See About Supported Objects and restore the record |
| Fields from a newly added object don't render on the launch form | The object is allow-listed but has no relationship path from the Opportunity | See the warning in About Supported Objects; check the Aline Error Log for dropped-field entries |
| Enable Download Documents checkbox is missing from the Configuration page | The capability has not been enabled for your org | Ask your Aline representative — see Optional capabilities enabled by Aline |
| Base URL field is greyed out and cannot be edited | Read-only by design | Contact your Aline representative if your environment genuinely needs a different Base URL |
| A call to or from Aline is failing silently | An error was captured but not surfaced in the UI | Check Aline Error Logs (Step 7) for ERROR-level entries — the endpoint, status, and response body are captured for triage |
If an issue persists after trying the steps above, contact your Aline representative.
Summary Checklist
- Step 1 — Assign Aline Admin permission set to administrator(s) and Aline Standard User to sales users
- Step 2 — Enter API Token (and optionally set Launch Mode) on the Aline Configuration page
- Step 3 — Add Launch Aline Workflow quick action to Opportunity page layout(s)
- Step 4 — Add Aline Workflow Explorer component to the Opportunity record page
- Step 5 (optional) — Add Aline Workflows and Aline Documents related lists to Opportunity page layout(s)
- Step 6 (optional) — Verify Download Latest and Download quick actions on Document and Version layouts
- Step 7 (optional) — Review Aline Error Logs for any captured failures
- Step 8 — Perform end-to-end smoke test
No action needed for Optional capabilities (feature flags) or Supported Objects in a standard setup — both are covered above for reference and troubleshooting.
