Modyo Docs

# Entries

Entries are the way to display the content created in a space to your sites. You can view your entries from sites created on the Modyo Platform, in the Channels module, or on external sites using our API.

In a space, entries are separated by content types. The type of content defines the basic structure and the requirements and validations necessary for an entry to be published.

Additionally, using the Channels and Customers modules, you can create sites capable of segmenting entries and showing them only to specific users.

# About the interface

In the entry interface, you can see a list of all the user-generated content, ordered by the date of the last update.

The columns for sorting the list of entries are:

  • Status: Draft, Published, Scheduled, or Archived.
  • Name: Name of the content.
  • Type: Type of content.
  • Updated: Date of the last saved update of the content.
  • Author: Name of the author of the content.

You can also filter the view with default filters:

  • Type: Type of content.
  • Status: Draft, published, scheduled, and archived.
  • Category: Category assigned to entries.
  • Language: Language of the content.
  • Translation: Translation status of the entry. If an entry has no version in the selected language, it is considered “not translated”.
  • Tags: Labels available in the account.
  • Search bar: Filter by the content of the title of the entries.

Tip

Click on the Filters menu at the top right of the list of entries to add or remove any of the filter options in the header.

# Bulk actions

Select one or more entries and click on the Bulk Actions box to:

  • Bulk edit: This option opens an interface where you can modify multiple entries at once, by selecting the fields you want to overwrite and applying the changes.

Important

The option to edit entries in bulk is only available for entries of the same type and is only visible if you filter the entries by type.

You can make changes to all fields of the type. Once the changes are made, click Next at the top of the screen to see the summary of your changes. Click “Save” to confirm the changes.

These entries will now have pending changes and you must publish them. To do this, you can make use of the bulk action “Publish”.

Warning

By using bulk editing of entries you are overwriting the values for the selected fields in all selected entries, so the values that existed before the bulk edit will no longer be available in the editable version.

To retrieve a specific value from an entry, access the entry editing view and select the Differences option to review the previous values of an entry.

  • Publish: Publish selected entries that have pending changes or are in a draft state.
  • Force publication: If team review is enabled, space administrators can use this action to force the publication of entries that have pending changes or are in draft status, without having to go through the review process.
  • Unpublish
  • Archive: Bulk archiving only has an effect on the selected entries that are not published. If you try to archive a published post, the action will have no effect.

Tip

Bulk actions run in the background, and you might not see the changes immediately. You will need to wait a moment and refresh your view after executing a bulk action.

# Create and Publish an Entry

To create an entry, follow these steps:

  1. In the side menu, select Content.
  2. Select your space.
  3. Click on Entries
  4. Click + New Entry.
  5. Select the type of content, name and identifier.
  6. Click Create.
  7. Once the entry is created, you can include the content you require. The entry will have the structure defined in the type of content you selected.
  8. Click Save.
  9. Click Publish.

Attention

If the name field is empty, the default identifier will be the UUID of the entry.

# Translate an Entry

To translate an entry, you must first add the language to your space. To do this, follow these steps:

  1. In the side menu, select Content.
  2. Click on your space.
  3. Click on Space Settings
  4. Click on Location.
  5. Select the language you want to add and click Add language.

Once your space has the languages you require, you can now translate your entries, for this purpose:

  1. In the side menu, select Content.
  2. Click on your space.
  3. Select Entries.
  4. From the list of entries, click on the entry you want to translate to open the editing view.
  5. Click on the language box next to the title of your post and select the language you want to translate your entry into.
  6. Click on the more actions button (...) and select Copy from Language.
  7. Select the language from which you want to copy the content.
  8. Confirm your selection.
  9. Enter your content in the fields.
  10. Click Save.
  11. Click Publish.

# Publish an Entry

To publish an entry in Modyo, follow these steps:

  1. In the side menu, select Content.
  2. Click on your space.
  3. Select Tickets.
  4. From the list of entries, click on the entry you want to publish.
  5. At the top of the screen, click Save.
  6. If you have administrator permissions, the Save button changes to Publish and you can proceed to publish your post. Otherwise, another user with Administrator permissions can do so. If team review is active, it will go through that process before it is published.

You can find more information on team review in the Key Concepts (opens new window) section of our documentation.

# Unpublish an Entry

Unpublishing an entry allows you to switch the entry to Draft state and hide it from the public. If team review is turned on, you'll need to go through that flow again to publish it.

To unpublish:

  1. In the side menu, select Content.
  2. Click on your space.
  3. Select Entries.
  4. From the list of entries, check the box for the entry you want to unpublish.
  5. Expand the Bulk Actions menu
  6. Click Publish.

# Delete Entries

To delete an entry:

  1. In the side menu, select Content.
  2. Click on your space.
  3. Select Entries.
  4. From the list of entries, click on the entry you want to delete.
  5. Click on the more actions button (...) and select Delete. If the entry is not archived, this option will not be active, first select Archive and then select Delete.
  6. Click Ok to confirm.

# Preview

Modyo allows you to see what your post will look like published on multiple sites, before you publish it.

In addition, you can preview the content as a user without a session or as a user with a Modyo session. We recommend starting or closing the Modyo session on the site before entering preview mode to avoid security errors such as x-frame-options or mixed-content.

Tip

You'll need to pre-configure the content page in the app to activate the preview option. For more details on how to configure it, see the content (opens new window)section of the documentation.

To preview your content:

  1. In the side menu, select Content.
  2. Click on your space.
  3. Select Entries.
  4. From the list of entries, click on the entry you want to preview.
  5. Click on the preview icon at the top right.

Attention

We recommend that you consider:

  • You can only preview content in the site's language. If the entry is in another language, the preview shows a 404 error.
  • If the Space isn't associated with a site, you'll only be able to see the JSON code of the entry you're developing.

# Edit an Entry

To edit an entry, follow these steps:

  1. In the side menu, select Content.
  2. Click on your space.
  3. Select Entries.
  4. From the list of entries, click on the entry you want to edit.
  5. Modify the fields you require.
  6. Click Save.
  7. Click Publish. If the entry is being reviewed as a team, reviewers should update their view to note the changes.

# Categories

Categories are a fundamental tool in Modyo for organizing your Entries.

When you create a category, Modyo generates a unique path in the URL that provides access to the resource, whenever it is published.

To view your categories, click on the side menu in Content and then select Categories.

# Create a Category

To create a category:

  1. Click on Content
  2. Select Categories
  3. Click on the + New Category button.
  4. In the pop-up window, enter the name, path and, optionally, a parent category.

When you assign an entry to a category, Modyo adds the identifier as a prefix to the URL of the entry, for example:

An entry with URL: test.modyo.com/visita-chile and category 'travel' would now be test.modyo.com/travel/visita-chile.

Tip

When you enter the name of the category, the route is automatically set as an identifier. To change it, click on the path.

If you modify the route, be sure to update all the links linked to it.

# Delete a Category

To delete a category:

  1. Click on Content
  2. Select Categories
  3. Click on the (...) button, after the name of the category, for more actions
  4. Select Delete.
  5. Click OK to confirm the deletion.

Tip

When you delete a category that has assigned entries, the entries are not deleted, however, they will not be assigned to a category. If you want to assign them a new category, you must do so again.

Attention

If you delete a parent category, all subcategories associated with it will be deleted. Entries linked to those categories will be left without an assigned category.

# Tags

Tags allow you to add more detail to your posts by combining them with Liquid on your content pages.

When creating posts, you can add a tag that will appear both in the source code and in our content API, allowing you to add specific functionality to that tag.

# Identifier

The identifier is a unique value used to generate the URL of an entry. When you create an entry, the platform assigns an identifier to it. If you want to create a more friendly link, you can modify it when creating the post or later when editing it.

The identifier must be a unique value for entries of the same type. If you try to save two entries with the same identifier, the platform will modify the last one when you publish the entry.

Important

If you want to modify the identifier of your entry after its creation, you must click on the lock in the identifier field and confirm that you want to change it, since making changes to the identifier breaks all references to the content through the API or the SDKs.

# Private content

Enable the private content option so that your content is exclusive to users who have a session on the platform.

Depending on how you're consuming the content, you may need to take some additional steps to access it:

  • Through the public API: Refer to the section on private content in the API.
  • Through Liquid: By signing in to your site, your users will be able to view private content.

# Segments

Segmented content is essential for any entity or company that wants to send specific information to a group of users.

To enable an entry to be visible to a specific group of users:

  1. Check the private content option
  2. Enable segmentation
  3. Select the user segment that the entry is aimed at.
  4. Click Save.

To create a specific segment, review the Segments section.

# Consume externally

You can access the content created in the Content module from anywhere, using our API. To get the UUID of an entry, follow these steps:

  1. In the side menu, select Content.
  2. Click on your space.
  3. Select Entries.
  4. From the list of entries, click on an entry
  5. Click on the preview icon.
  6. Click on API Link. You'll be redirected to a new page that uses the API to get the content of the post. The result will look similar to this:

URL: https://test.modyo.com/api/content/spaces/test-space/types/nuevo/entries/45fa2ef7-bf12-47a3-8ff7-f7d1f5f36844

{
  "meta":
  {
    "name": "MyNewEntry",
    "slug": "mynewentry",
    "tags": [],
    "type": "newType",
    "uuid": "45fa2ef7-bf12-47a3-8ff7-f7d1f5f36844",
    "space": "test-space",
    "author":
    {},
    "locale": "es-cl",
    "private": false,
    "targets": [],
    "category": "mycategory",
    "created_at": "2022-02-24T12:44:24.000-03:00",
    "updated_at": "2022-02-25T10:06:46.000-03:00",
    "published_at": "2022-02-25T10:06:46.000-03:00",
    "version_type": "current",
    "category_name": "MyCategory",
    "category_slug": "mycategory",
    "unpublished_at": null,
    "available_locales": ["es-cl"]
  },
  "fields":
  {
    "My items": "..."
  }
}

For more information about our API and the different actions you can perform, see Management API.

← Media →