Embed Streamline workflows directly on Salesforce Lightning record pages so your team can start and complete a workflow without leaving the record they are working in.
You add the Streamline Embed component to a Lightning page in Lightning App Builder, choose the workflow it starts, and your Salesforce users run it right on the page.
With this feature, you can:
- Put a Start button for a workflow on an Account, Contact, or any other record page.
- Run the workflow in the page, so users do not switch tabs or sign in to Streamline separately.
- Start every workflow with the signed-in Salesforce user's details, such as name and email, already available to the workflow.
- See the workflow sessions that were started from a record on that record by adding the Streamline Projects component to the same page.
Who Has Access?
- Streamline admins and builders: Build the workflow and create the trigger that starts it in the Streamline for Salesforce app.
- Salesforce users: Start the workflow from the page. Assign these users the Streamline User permission set. Their normal Salesforce access to the record still applies.
Key Capabilities
- Start a workflow from a record page: The component shows a message and a Start button on the page. When a user selects Start, the workflow opens in the same page.
- Match workflows to the page: On a record page, the list of workflows shows only triggers built for the object of that page. An Account page lists Account triggers.
- Customize the Start area: Change the message, the button label, and the button color.
- Signed-in user information: The workflow receives the Salesforce user's ID, first name, last name, email, and username.
- Session tracking on the record: When the trigger has Store Session Statuses turned on, the sessions started from a record are saved against that record. To show them on the record page, add the Streamline Projects component to the page.
- Works with multi-step workflows: Forms, Documents, and Sign steps can all run in the embedded view.
- Large and small screens: You can add the component to Lightning pages for desktop and phone.
Before You Begin
Make sure that:
- Streamline for Salesforce 1.15.0 or later is installed in your Salesforce org.
- Your Salesforce org is connected to Streamline.
- You have a Streamline admin or builder to create the workflow.
- You can edit Lightning pages in Salesforce (the Customize Application permission or equivalent).
Part 1: Build the Workflow
The workflow must start with an Incoming Webhook step. This is what the Start button triggers.
- In Streamline, create a workflow.
- Add an Incoming Webhook step as the first step.
- Choose how the webhook is secured:
- HMAC: Streamline for Salesforce signs the request. Use this when you want the request to be verified.
- No authentication (public): The request is sent without a signature.
- Add the steps you want users to complete, such as a Form, a Document, or a Sign step.
- Publish the workflow.
Part 2: Create the Trigger in Salesforce
The trigger connects the workflow to Salesforce and is what you select in Lightning App Builder.
- In Salesforce, open the Streamline for Salesforce app.
- Create a new trigger (button) and select your workflow's Incoming Webhook.
- Set the Object to the object whose record page will show the component, for example Account.
- If you want to track sessions on the record, turn on Store Session Statuses.
- Save the trigger.
Note: The workflow list on a record page only shows triggers for that page's object. If you do not see your trigger, check that its Object matches the page you are editing.
Part 3: Add the Component to a Lightning Page
- In Salesforce, open a record of the object you want to add the workflow to.
- Select the Setup gear, then select Edit Page.
- Lightning App Builder opens. In the Components list, find Streamline Embed and drag it onto the page.
- Select the component and set its properties:
| Property | What it does |
|---|---|
| Workflow trigger | The workflow that starts when a user selects Start. |
| Start message | The text shown above the Start button. If you leave it empty, the page shows "Start begins the workflow and embeds it on this page. It does not open a new tab." |
| Start button label | The text on the button. If you leave it empty, the label is Start. |
| Start button color | The button color, as a hex code (for example #0A66C2 or #06C), an rgb() or rgba() value (for example rgb(10, 102, 194)), or a CSS variable (for example var(--brand-color)). Named colors such as red are not supported, and the button stays black. If you leave it empty, the button is black. The button text switches between black and white so it stays readable. |
| Workflow trigger | The workflow that starts when a user selects Start. |
| Start message | The text shown above the Start button. If you leave it empty, the page shows "Start begins the workflow and embeds it on this page. It does not open a new tab." |
| Start button label | The text on the button. If you leave it empty, the label is Start. |
| Start button color |
5. Select Save.
6. If this is a new or unassigned page, select Activate and choose where the page is used.
To show the sessions started from this record, also drag the Streamline Projects component onto the page. Streamline Embed starts the workflow. Streamline Projects lists the sessions saved against the record.
Part 4: Give Your Users Access
- In Salesforce, go to Setup and open Permission Sets.
- Open Streamline User.
- Select Manage Assignments, then select Add Assignments.
- Select the users who should start the workflow and select Assign.
Users who already have Streamline User or Streamline Admin do not need anything else.
Part 5: Start the Workflow from the Page
After the page is active, your users can run the workflow:
- Open a record on the page you edited.
- Find the Streamline Embed section with your message and button.
- Select Start (or your custom label).
- Complete the workflow in the page.
While the workflow is starting, the button is disabled and shows Starting…. If you set a custom button label, the button shows that label followed by an ellipsis instead, for example Begin…. If something goes wrong, an error message appears under the button.
To start another session, reload the record page.
Feature Considerations
- The page object and the trigger object should match. The list of workflows on a record page is filtered to the page's object. A trigger built for a different object does not appear.
- What the workflow receives. Start sends the signed-in Salesforce user's ID, first name, last name, email, and username to the workflow. Fields from the record that is open on the page are also sent.
- Session tracking needs a matching record. Sessions are saved against the page record only when Store Session Statuses is on, and the page record is of the trigger's object. If a matching record cannot be found, the workflow still starts, and no session status is saved.
- Sessions show through the Streamline Projects component. Saved sessions do not appear in a standard related list on the record. Add the Streamline Projects component to the record page to see them. The trigger record also lists every session started from it.
- The workflow opens in the page. Starting a workflow does not open a new tab.
- The page height is fixed. The workflow area is 600 pixels tall on Lightning record pages.
- One workflow per component. To offer multiple workflows, add multiple components and choose a different trigger for each.
Troubleshooting Common Issues
The Workflow trigger list says "No access: assign a Streamline permission set." The admin editing the page does not have a Streamline permission set. Assign Streamline Admin or Streamline User to that admin, then reopen Lightning App Builder.
My trigger is not in the Workflow trigger list. Check that:
- The trigger's Object matches the object of the page you are editing.
- The trigger has an Incoming Webhook.
The page shows "Select a Streamline workflow trigger in this component's properties." No workflow is selected yet. Select a Workflow trigger in Lightning App Builder and save the page.
A user selects Start and sees an error. The most common cause is that the user does not have a Streamline permission set. Assign Streamline User and ask them to try again. If the error continues, check that the workflow is published and that its Incoming Webhook is active.
The workflow does not appear after selecting Start. Check that the workflow is published and that its first step is an Incoming Webhook. If the page stays blank, your browser or Salesforce Content Security Policy might be blocking the embedded workflow. Ask your Salesforce admin to confirm that Streamline is allowed to display in your Salesforce org.
The session does not show on the record. Turn on Store Session Statuses on the trigger, and check that the trigger's object matches the record's object. Then check that the Streamline Projects component is on the record page. Sessions are not shown in a standard related list.
Summary
With Embed Workflows in Salesforce Lightning Pages, your Salesforce users can start and complete Streamline workflows right on the record they are working in. Build a workflow that starts with an Incoming Webhook, create a trigger for it, add Streamline Embed to a Lightning record page, and assign the Streamline User permission set to your users. They select Start, complete the workflow on the page, and you can follow each session on the record with the Streamline Projects component.
Comments
0 comments
Please sign in to leave a comment.