Modyo Docs

# Modyo Platform

Modyo Platform is the technological foundation on which Modyo applications such as Channels, Content, and Customers operate. Here you will find everything necessary to perform the most relevant cross-cutting configurations.

Modyo Platform presents the main Modyo interface from which you have access to all relevant sections.

# Get Started! 🚀

Modyo provides all its administrator users with a learning section containing links and content from our community.

Optional

The Let's Get Started! section can be disabled from the account's general options.

# My Tasks

Team Review is a tool that allows you to control the content publishing process in Modyo. When activated, each element must go through review stages before publication.

Team Review adds a level of supervision and collaboration between the content editor and a team of reviewers. This tool is configured individually for each Site and Space.

# Team Review

Team Review is a tool that allows you to control the content publishing process in Modyo. When activated, each element must go through review stages before publication.

Team Review adds a level of supervision and collaboration between the content editor and a team of reviewers. This tool is configured individually for each Site and Space.

When an editor or developer considers that the element they are working on is ready, they can submit it for review.

This task can be performed by users enabled by default or by a team selected by the editor.

These reviewers are responsible for approving or rejecting the element, and determine if it is ready for publication.

Each step of this process takes the element through different states, which are recorded in a history for later auditing.

# Configuration

To activate team review, follow these steps:

  1. From the side menu in Modyo Platform, select a space or site.
  2. Expand Space/Site Settings and select Team Review.
  3. Click Enable team review.

The available options are:

  • Enable team review: Activates or completely deactivates team review in this context (site or space).
  • Number of approvals: Determines the number of users who must approve the element for it to be ready for publication. When the required number of approvals is reached, the element's status will change from "Awaiting review" to "Approved".
  • Restrict reviewer selection: By default, any user with the necessary permissions can approve elements awaiting review. However, when this option is enabled, only reviewers selected by the editor can perform the approval.

Attention

While approval is limited, any user with permissions can comment on the element.

  • Force review: This option allows you to select a list of users, from which at least one approval is required for the element to change to "Approved" status. This is independent of the number of approvals configured previously. Even if an element has the necessary number of approvals, it will remain in "Awaiting approval" status if no user from the list has approved it.

  • Require all: This option extends the previous restriction to all selected users. In this case, approval from all users on the list will be required for the element to change to "Approved" status.

Attention

When you make changes to the team review configuration, elements that were already awaiting review will continue to be governed by the rules prior to the changes.

For those elements to adjust to the new configuration, they need to be rejected and submitted for review again.

# About the Interface

# Team Review

When the team review option is activated and changes are saved, the main green button Submit for review is displayed.

When submitting for review, the bar changes status to indicate if conditions are missing or if you don't have sufficient permission.

When clicking, the right side section will indicate the requirements to publish the element.

If review from any reviewer is required, (required) will appear next to their name in the list of reviewers.

To the right of each reviewer is their review status. A yellow circle is shown if they haven't reviewed, and a green check if they have approved the element.

All users who have access to the element's editing view will see an Approve button below the list of reviewers.

Users with the necessary permissions can click the Approve button to approve the element. Those without permissions see the button disabled.

When approving the element, the user's approval is recorded and a green check is shown next to their name in the list of reviewers.

When enabling team review, in the element's action bar, to the left of the main green button and to the right of the differences button, you can find the option to open the element's activity tab.

Opening this tab shows a chronological list of actions performed on the element, with the option to view details of each action. At the end of the tab is the option to leave a comment.

When a comment is left or an action is executed on the element, a notification is sent both to the person who submitted for review and to users on the list of reviewers.

# Versioning

As a backup mechanism, when publishing an element, Modyo automatically generates and maintains a number of versions that can later be recovered if necessary.

This system is available for Widgets, Pages, Navigation, Templates, and Spaces.

# Version Types

Version Description
Editable The Editable version preserves changes made to the element since its last publication or since its creation if it has never been published. This version goes through the team review process when activated. At the time of publication, the "Editable" and "Published" versions contain the same content.
Published This version saves the content visible on the site and is available to all users. In this state, internal resources like Widgets and Templates can already be used in creating any site or page. The published version doesn't necessarily have the same content as the editable version, except at the exact moment of publication, as it may contain changes that are still in the testing or review process.
Backups Backups are previously published versions of elements. Each time an element is published, Modyo saves the previously published version as a backup.
Scheduled When you schedule a publication, the editable version goes into a scheduled state. When the time comes for publication, that scheduled version takes the place of the version that is published at that time. This way, you can schedule a future change to elements and continue working on the editable version.

Modyo only allows one scheduled version of each element. If you schedule a second modification to the element, you overwrite the previous schedule.

In addition to scheduling publication, you can also schedule unpublishing. When the time comes, the published version will become a backup, leaving the element in question without a published version.

When scheduled actions are executed, Modyo may take a few minutes to complete them. Modyo will send you an email notification when the action has been completed.

There are elements (home, navigation, and templates) that cannot be unpublished. If unpublishing is scheduled together with other elements, it will have no effect on these specific elements.
Approved This state appears when team review is enabled and means that an element in this state is ready to be published. Any change made to an element in this state will take the element to an editable state and must go through the review process again to be published.

If you want to review a specific version of an element, you can access "Version Differences" to see the changes made and revert them if necessary.

Versions

By default, Modyo saves the last 20 published versions of each element, so when making the twenty-first publication, you will be deleting the backup of the element's first publication.

This value can be modified through environment variables and is applicable to all accounts on it.

# Revert a Change

Within versioning, there are two actions that allow you to interact with backups: reset and rollback. By default, the differences modal shows the published version on the left and the editable version on the right.

You can change which versions to compare by changing the values in the version selectors at the top of the modal.

Follow these steps to revert to a published version in an Entry:

  1. From Modyo Platform, expand Content and select Spaces.
  2. Select your Space and then click on the Entry you want to version.
  3. Click Differences.
  4. In the modal that appears, select the version you want to rollback to and then click Rollback to this version.

When any of the actions is applied, the version selected on the left is always taken, so that if reset, the version on the left will be taken to the editable version, and if rollback is done, the version on the left will be taken to the published version.

Tip

Versioning can be performed in the following modules:

  • In Content: Entries.
  • In Channels: Pages, Navigation, Templates, and Widgets.

# Reset

In this case, the backup takes the place of the editable version, so all existing changes will be lost, and you can continue working on potential changes to that version to republish it.

# Rollback

In this case, the backup returns directly to the published version of the element, without touching the editable version.

This is useful when something was published by mistake and it's necessary to return to one of the stable versions. Allowing you to resolve the problems that the version with errors may have had.

Important

Since this is a potentially risky action, only site or space administrators have permission to execute this action.

# Locks

Locks is a Modyo functionality that allows you to modify a resource safely, avoiding concurrency issues that may occur when another user is working on it simultaneously. This way, Modyo prevents work loss or document overwriting.

# What Elements Use Locks?

Locks is mainly used in Content and Channels, but can also be used in other sections where elements are edited such as Settings and Customers.

# How to Use Locks?

Locks is implemented in different ways within the platform. In Content and Channels, multiple users can enter a resource, with only one being able to edit and save those changes, while others will only see the last version saved on the platform.

If a second person tries to make a change, a message will appear indicating that the element already has changes and that what they are trying to modify is obsolete.

In other sections like Customers and Settings, Locks will not allow simultaneous viewing of the resource, so if it is being edited, another user cannot access the work view.

In this case, only an Administrator can take control, activating editing for themselves and discarding the unsaved progress of the user working on it.

Take Control

If an Administrator wants to take control of a view, they must click on the element in use and on the next screen, click the Take Control button.

When the Administrator takes control, the user using the resource receives a message preventing them from continuing to make changes, so any changes the user is making must be saved and backed up offline.

After taking control, the Administrator only has two hours to make unsaved changes. After that time, the resource is released again and can be taken by any other user.

# Preview Modes

Preview modes allow you to preview changes made to publishable elements such as entries, pages, navigation, widgets, or templates. Access to this mode is at the top right of the site. You can recognize that you are in preview mode when you see the bar at the top of the site.

The preview bar contains the following interactive elements:

  • Template selector: Allows you to switch between the published and editable version of elements belonging to the template builder.
  • Content selector: Allows you to toggle between the published and editable version of elements belonging to the content application that are being used on the site through the Liquid content SDK.
  • Navigation selector: Allows you to switch between the published and editable version of elements belonging to the navigation builder.
  • Page selector: Allows you to toggle between the published and editable version of elements belonging to the page builder.
  • Content view selector: Allows you to switch between the published and editable version of the content entry being previewed in custom content views. This view doesn't directly use the Liquid content SDK, so content in these views won't be affected by the content SDK selector.
  • Widget selector: If you are previewing pages that contain custom widgets, a list of widgets present on the page will be displayed, allowing you to select whether you want to view the editable or published version of each one. Once the selection is made, you must click the "refresh" button for the widget configuration to take effect.
  • Minimize tab: Allows you to hide the preview bar to avoid interference with elements located at the top of the site. Once minimized, the tab will remain visible to restore the bar in preview mode.
  • Edit element: When clicked, you access the editing view of the element being viewed, whether it's an entry, page, widget, or default site template.
  • Share link: Allows you to copy a link that can be shared with other users. Opening the link provides direct access to preview mode with the configuration that was in place when the link was copied. To access preview mode, you need to have a session initiated in the administrator account.
  • Exit preview mode: Closes preview mode, removing the bar and keeping the tab at the current site URL.

Attention

Changing the content selector in the preview bar will have no effect on content you are using through the JavaScript SDK or content API. It will only affect content used through the Liquid SDK.

← Configuration →