Set a playbook's portal welcome message

Updated

Who can do this: People with permission to edit and publish the playbook and to edit its portal settings

Each playbook has its own portal welcome message. Customers see it on the project home page in the customer portal. In the standard layout, it shows to the right of their tasks. When a Portal Studio layout is published for the project, the page follows that layout instead. New projects created from the playbook start with its message.

Before you begin

  • You need permission to edit and publish the playbook, and permission to edit the playbook's portal settings.

  • The playbook is read-only until you start editing a draft. While it's read-only, the welcome message can't be opened for editing.

Edit the welcome message

  1. Go to Library and open the playbook.

  2. Select Edit to start a draft. If a draft already exists, select View draft, then Edit draft.

  3. On the playbook's Overview tab, select the Portal welcome message box.

  4. In the Portal welcome message dialog, edit the text.

  5. Optional: To add a merge field, enter /, select Merge Field, then choose the field from the picker.

  6. Select Confirm to save the message to the draft.

  7. Select Publish.

New playbooks start with a default welcome message from OnRamp. Replace it with one written for your customers. If a project's message is empty, the portal doesn't show a welcome message.

Personalize it with merge fields

The welcome message fills in these merge fields for each project:

Merge field

Shows

{{project_name}}

The project's name

{{vendor_name}}

Your organization's name

{{customer_company_name}}

The project's account name

{{project_owner}}

The project owner's full name

{{project_owner_first_name}}

The project owner's first name

{{project_owner_last_name}}

The project owner's last name

{{project_owner_email}}

The project owner's email address

A field shows as blank when the project has no account or no project owner. For more on how merge fields work, see Create and use merge fields.

Add a welcome video

You can embed a short video, such as a Loom, from the editor's Video option. A brief intro from the person leading the project helps customers put a face to the name.

What to include

A clear welcome message usually covers:

  • A personal welcome, using merge fields for the account and project owner

  • What the project covers and what happens next

  • What you need from the customer, and what they can expect from you

  • How to get help

If comments are allowed on the project, tell customers they can leave a comment on any task to ask a question. Keep it short: brief paragraphs and bullets read better than a wall of text.

How changes reach projects

Each project keeps its own copy of the message, called Project Welcome Message. To edit one project's copy, go to its Portal tab, select Settings, then edit Project Welcome Message. You can't edit it on an archived project, or without permission to manage the project's portal settings. See Using the Portal Tab.

Editing the playbook's message doesn't change projects that already exist. To apply it to them, push the change as a playbook update, where it's listed as Welcome message. If a project's Project Welcome Message was edited, that project keeps its edited copy by default. When you push the update, you can choose to overwrite the edited copy for that project. See Playbook and Library Overview.

In Portal Studio, the Welcome message widget shows the project's welcome message. When the message is empty, the widget is hidden from customers. When Aero is turned on for your organization, the playbook's Overview tab shows a Playbook health panel. It flags a playbook that still uses the default message, and Aero can suggest a replacement.

More in Customer Onboarding