Implementing Clarity’s Content Publishing Workflow

In the previous sections, you learned about the tools Liferay provides for managing digital assets and web content, and you put some of them to use in enhancing Clarity’s enterprise marketing website. However, content creation and management isn’t a one person operation. In reality, this process usually involves multiple team members across departments. Each contributor is expected to collaborate, create content in parallel, and send content through a review process before publishing.

Here you’ll learn how teams can use Liferay’s publishing tools and workflow to effectively collaborate on content creation and coordinate campaign roll outs. This includes reviewing, previewing, and approving content before publishing it to the live site.

Publishing Tools

Liferay provides two publishing tools for content creation and site building: Staging and Publications. With each tool, you can edit sites and content in a working environment without affecting end users. However, these tools achieve this in different ways, using different frameworks that have varying integration with other Liferay features.

Staging

Liferay Staging provides a shared working environment for making changes to individual sites and asset libraries before publishing these changes to your live environment. When enabled, Liferay creates a separate copy of the original site or library and hosts them on either the same server (Local Live) or on separate servers (Remote Live).

All editing is then restricted to the staged site or asset library. When ready, you can publish your changes manually or schedule them to publish at a later time. Then the staged changes are copied to the live environment.

Publications

Like Staging, Publications is a change-tracking tool for editing sites and content. However, under the hood, Publications is very different from Staging. Rather than duplicating all content and keeping two separate datasets in sync, Publications works with versioned records. Essentially, it uses a database column to keep track of changes and determine which version of the content is displayed.

When enabled, contributors can create working environments called ‘publications’ where they make edits without affecting the production environment’s published site. Each publication is company-scoped and can group changes across multiple sites and asset libraries. Also, while Staging provides a single working environment for all team members, Publications users can create as many working environments as they need. And since these working environments are independent of each other, contributors can work on their own timelines and publish their changes without impacting other projects.

During the publishing process, Liferay checks for conflicts with production and prompts the user to review and resolve them. Some conflicts can be resolved automatically, while others require manual resolution. In case you need to roll back your changes, Publications maintains a detailed history of published changes, so you can quickly revert changes if needed.

By default, access to a publication is limited to its creator. However, creators can invite other members and assign them roles specific to each publication. Since publications are independent, contributors can make and publish their changes without affecting one another. Contributors to a publication can work on their own timelines and publish their changes when ready.

Staging vs. Publications

Publications is recommended over Staging in nearly all use cases because it provides a superior collaboration experience and greater integration with other Liferay features. The one exception is if your production and working environments must be hosted on separate servers. Currently, this is only possible with Remote Live staging.

Workflows

Liferay Workflow defines approval processes for Liferay entities. These processes can help improve task visibility, eliminate bottlenecks in business processes, and reduce the time and resources required to complete tasks. By default, Liferay includes a Single Approver workflow, but you can define your own workflows using a visual designer.

Once you’ve defined a workflow, you can associate it with different content types and folders. This flexibility enables you to fine-tune approval processes for different individuals or teams within your organization. For example, you may require multiple team members across multiple departments to approve new products, while only requiring a one approver single manager approval for blog posts.

Workflows are supported by both Staging and Publications.

These are some of the features that make workflows a critical part of publishing and governing content with Liferay:

• Automate repetitive tasks like approvals, notifications, and content routing to save time

• Reduce the risk of human error from manual processes with automated steps and rules

• Assign specific tasks and approvals to designated users, clarifying roles and responsibilities and creating transparency throughout the process

• Improve communication by automating notifications that keep stakeholders informed about progress and status

• Improve review processes with structured feedback loops

• Build flexible solutions by customizing workflows for your specific needs

• Integrate workflows seamlessly with other Liferay features, including headless APIs

Exercise: Configuring Publications and Workflow for Content

You can leverage Publications with Workflow to implement robust publishing processes for site and content changes. Here you’ll enable publications and configure a single approver workflow for any new articles published to Clarity’s website as Ian Miller.

To do this,

1. Sign in as Ian Miller.

   • Username: [e-mail]
   • Password: learn

2. Open the Global Menu (), go to the Applications tab, and click Publications.

3. Toggle Enable Publications and click Save.

   This redirects to the Publications application page.

4. Click Add () to create a new publication.

   Alternatively, you can click the Publications drop-down menu at the top of the page and select Create New Publication.

5. For Name, enter Article Publication.

6. Click Create.

7. Return to Clarity Public Enterprise Website.

8. Open the Site Menu (), expand Content & Data, and click Web Content.

9. In the Web Content tab, click Actions () for the Articles folder and select Edit.

10. Expand the Structure Restrictions and Workflow section and select Set the default workflow for the folder’s content (Articles).

11. Select Single Approver in the drop-down menu.

12. Click Save.

    

You have set up a publication for tracking changes to Clarity’s article web content, along with a workflow for approving new articles before they are published to the production site.

Next, let’s learn how to invite other users to work on the publication you created.

Inviting Users and Assigning Roles in a Publication

The Publications application has an option to invite users to collaborate in a publication. These users can be invited even if they don’t have Publications permissions assigned to them.

Here you’ll invite Christian Carter and Clara Murphy to contribute to the Article Publication process as Ian Miller.

To do this,

1. Go to the Publications application click Actions () for Article Publication and select Invite Users.

   Alternatively, you can click the Publications drop-down menu at the top of the page, select Review Changes, and click Invite Users ().

2. Click the role drop-down menu and select Editor.

3. For People, enter Christian Carter.

4. Repeat steps 3-4 to invite Clara Murphy using these values:

   Name	Role
   Clara Murphy	Publisher

   

5. Click Send and click OK to confirm.

Great! Now Christian Carter and Clara Murphy can contribute to the publication. Next, you’ll go through the publishing workflow.

Exercise: Managing Changes with a Content Publishing Workflow

Publications provides a convenient way to manage changes to your Liferay instance. With it, you and your team can create and collaborate on blocks of changes called ‘publications’. You can then publish those changes to production when ready.

In this exercise you’ll add a new article as Christian Carter, then review it with the single approver workflow and push the changes to production as Clara Murphy. These changes will be done in the Article Publication process.

Creating and Submitting a New Article to the Workflow

Here you’ll create a new article and submit it for approval as Christian Carter.

To do this,

1. Sign in as Christian Carter.

   • Username: [e-mail]
   • Password: learn

   Note that the publications menu now appears at the top of the page and a new notification for the publication invitation was received.

   

2. Click the user profile icon, go to Notifications, and select the publications invitation.

   

   This opens the details page for Article Publication.

3. Click the Publications drop-down menu at the top of the page, click Select a Publication, and select Article Publication.

4. Return to Clarity Public Enterprise Website, open the Site Menu (), expand Content & Data, and click Web Content.

5. Go to the Articles folder, click New, and select Article.

6. Enter these values:

   Field	Value
   Title	Clarity x Warby Parker
   Image	revolutionizing_industry (from the Marketing Assets library)
   Headline	Summer 2024 Collaboration
   Content	Eyewear enthusiasts rejoice! Fan favorites Clarity and Warby Parker have joined forces for a collaborative collection.

7. Click Submit for Workflow.

Great! You just created a new article and submitted it for review in the Article Publication. Next, you’ll learn how to approve and publish changes.

Reviewing Content in a Workflow and Publishing a Publication

Here you’ll finish reviewing the article and pushing all changes to production as Clara Murphy, Christian Carter’s manager.

To do this,

1. Sign in as Clara Murphy.

   • Username: [e-mail]
   • Password: learn

   The publications menu now appears at the top of the page and two new notifications for the publication invitation and review request were received.

   

2. Click the Publications drop-down menu at the top of the page, click Select a Publication, and choose Article Publication.

3. Click the Publications drop-down menu again and select Review Changes.

   This directs to the publication details page with a list of changes.

4. Click Publish.

   This action will fail because the publication includes unapproved changes.

   

5. Click the user profile icon and go to My Workflow Tasks.

6. Go to the Assigned to My Roles tab to see the pending workflow task.

7. Click Actions () for the workflow task and select Assign to Me.

8. Enter a comment and click Done.

   This assigns the task to Clara Murphy and redirects you to the Assigned to Me tab. Here she can review and approve or reject the Christian Carter’s article.

9. Click Actions () for the task and select Approve.

10. Enter a comment and click Done.

11. Click the Publications drop-down menu again and select Review Changes.

    The change’s status is now Approved.

12. Click Publish, verify there are no conflicts, and click Publish again to add the changes to production.

    

Conclusion

Great! You’ve successfully used workflow with publications to review and publish web content. Next, let’s explore how you can create business forms in Liferay.

Up Next: Building Clarity’s Contact Us Form

Additional Resources

See official documentation to learn more about Liferay’s publishing tools:

• Publishing Tools
• Workflow