Strapi v3

The destination Strapi v3 connector allows content to be transformed from motation and saved to Strapi versions 3.4.0 to 3.5.2

Specifics

The source Strapi v3 connector is able to sync both content and media files.

Syncing Collection Types

Given the way the Strapi system stores and manages collection types, it is best practice to not sync collection types to a destination Strapi. This means that collection types should be synced via the SCP connector or created prior to a content sync and aligning the source content to the destination content via Impulse's functionality.

UID Field

Impulse expects users to use the UID field provided in strapi as a UUID for contents. Rather than rely on the auto incrementing ID of contents use the UID field and provide every content a UUID so that it can be queried and searched for. This is not only the best way to work with Impulse, but also the best way to build your Strapi deployment.

This is field can be referenced in the job options. Performing a sync without the UID field created for a collection type and the job option set is unsupported. We expect you to set up your Strapi v3 system and the destination endpoint job option this way.

User Permissions

To sync content to the Strapi system, you will need to pass a user's login credentials into the endpoint config. The user requires the appropriate permissions to be able to sync the content. The permissions required are the same as the admin UI permissions. If the user is able to use the admin UI, it will work in Impulse.

Because the adapters communicate with Strapi through Strapi’s REST API, the JWT timeout for that adapter user should be long enough to complete a sync.

The easiest option is to create a super user and use those credential for Impulse.

Same System Only

Strapi v3 has a few field types that are synced only to another Strapi system.

Those fields are:

Relationships
Component
Dynamic Zone

Endpoint Config

When saving an endpoint for a Strapi v3 repository via REST instead of the UI you must use the following key:value pairs in the payload.

contentRepo:strapi
contentRepoVersion:3.4.0

Unsupported

Users, roles, and permissions are unable to be synced.

Multiple collection types per job. You can only sync one collection type per job. Setting multiple collection types will result in only one of them being synced.

Syncing image files from a non Strapi source.

Syncing relationships from a non Strapi source.

DotCMS binary field is not populated with the image when synced to Strapi destination.

DotCMS constant field has no value when synced to Strapi destination.

DotCMS custom field has no value when synced to Strapi destination.

Strapi v3 adapter does not support running as a remote adapter apart from Impulse.

Adapter Properties

Property	Purpose
strapiURL	The URL to access the Strapi system.
user	The user with appropriate permissions.
password	The password for the user with appropriate permission.

Property

Purpose

strapiURL

The URL to access the Strapi system.

user

The user with appropriate permissions.

password

The password for the user with appropriate permission.

Job Options

Name	Description	Data Type	Required	Default Value
path	The path to pickup media files.	Array	No	No Default Value
contentType	The content type to pickup.	Array	No	No Default Value
uniqueId	Unique ID field of the collection types being synced to.	Array	No	No Default Value
deliverContentType	The option to deliver the collection type or not.	Boolean	No	true

Name

Description

Data Type

Required

Default Value

path

The path to pickup media files.

Array

No Default Value

contentType

The content type to pickup.

Array

No Default Value

uniqueId

Unique ID field of the collection types being synced to.

Array

No Default Value

deliverContentType

The option to deliver the collection type or not.

Boolean

true

path and contentType Job Options

The path and contentType Job Options are used to search for contents that match the options criteria, the returned contents are used to compare against the source endpoint contents to define what needs to be synced to this destination connector.

Requesting specific contents of collection/single types.

To get the content of a collection type (or a single type) you must provide the API ID of the content type in the details of the endpoint like this:application::<api-id>.<api-id>

Example:

Syncing media files from the media library

Media files in the media library are treated as files that live under a path. As such, the details to get files would be as follows: /uploads/files/<file-id>

Example 1: all media files

Example 2: specific media file with Id 1

Example 3: media files in a range

This example will get all media files within the query range. I.e. 2 files starting at the second in the list.

Example 4: multiple media files by id

Note: This list may change order. It is based on modification date of the files. You may want to verify the query before using it.

Using UID Field

To use the UID Field as the primary id to sync based off rather than the default content auto incrementing id, set the value of the Uniqueid job option with the following pattern: application::<api-id>.<api-id>.<UIDFieldName>

Syncing Collection Types

To choose whether you sync a collection type or not set the Delivercontenttype job option. Best practice is to set this flag to false due to how Strapi handles creating and updating collection types.

When setting this flag to False, it is then expected that the content model is fully managed through other options. I.e. Another job, manually, etc.

If the content models do not match between source and destination the content may not sync as expected. You can view the Aligning Mismatched Content doc for more information on how to handle this case.