Sitecore Integration in Content Workflow

Content Workflow's integration with Sitecore enables content editors to easily import and update content from Content Workflow in Sitecore. Editors can define mappings to specify which templates and fields should be imported using Template Mappings. This integration also allows editors to update the workflow status in Content Workflow for all successfully imported items. Brimit developed and maintains the integration in collaboration with Content Workflow.

Versions Supported

The module supports Sitecore 8.1, 8.2, 9.0 and 10.3

How to Install Sitecore

The Content Workflow connector is a Sitecore module delivered as a Sitecore package. To install the module, follow these steps.

1. Download the package for your version of Sitecore here.
   • Content Workflow Connector-2.10_SC8.1 SC8.2.zip
   • Content Workflow_Connector-2.10_SC9.0.zip
   • Content Workflow Connector SC10.3.zip
2. Navigate to the  Sitecore Menu > Development Tools > Installation Wizard.
3. Select Upload Package and search for the package you downloaded. Upload the Content Workflow package and select Next.
4. Verify the package information and click Install.

How to Configure Sitecore

A Content Workflow account module is created during the installation. The module stores user credentials that connect the Content Workflow account via the API and plugin settings. You have to set all of these parameters to start.

1. Navigate to Content Workflow.
2. Open the Content Editor and navigate to /sitecore/system/Modules/ContentWorkflowByBynder item.
3. You can scroll down the page to the Credentials section and add your credentials.
4. Enter your Content Workflow User Email Address, API Key, and Platform URL > Save.
   • Your email address is case-sensitive.
5. You can find instructions on generating your API Key in our API Documentation.

(Optional) Update your Settings

You can customize the following settings once you've set up your credentials.

1. Select the Test Connection
2. After setting your credentials, you can test the connection to the Content Workflow platform by going to System> ModusystemontentWorkflowByBynder >Test Connection.

Introduction to Template Mappings

To bring content from Content Workflow, the content editor must establish connections between the Templates in Content Workflow templates in Sitecore and their respective fields. Follow these instructions to create these mappings.

How to Set up Template Mapping

1. Select Mappings located on the Content Workflow ribbon. This will take you to the Manage template mappings section.
2. Select Add Mapping. This will bring up the Field Mappings dialog, which lets you specify which templates and fields should be mapped.
3. Add the mapping details.
   • Specify a name for the mapping. The mapping name will distinguish mappings on import dialogs. Set the default location (optional).
   • This helps specify the default location (node) in Sitecore where imported Items will be stored. The field is also used in the multi-location import dialog to pre-fill the location pickers.
   • Select the Content Workflow Project and Template and the corresponding Sitecore template.
   • Specify the Content Workflow project and template you want to map and choose the corresponding Sitecore template (only templates stored under the Templates Root Folder will be visible there).
4. Map the Content Workflow fields to Sitecore fields. 
5. All tabs and fields will be dynamically populated once you've added the mapping details (as above). You can now choose which Content Workflow fields (on the left-hand side) map to which Sitecore fields (on the right-hand side).
6. Select Save Mappings Configuration.
7. ​Once complete, you're ready to migrate over your content.

Important Notes

• The drop-downs display only fields that can be mapped. For example, it is not possible to map a text field from Content Workflow to an image field in Sitecore.
• The right-side dropdown displays all fields from the selected Sitecore template and fields from all base templates, which the current template inherits.
• The plugin supports many-to-one field mappings for text and guidelines field types. This means that it is possible to map, for example, two Content Workflow fields into one Sitecore field. The content of such fields will be concatenated and placed in the Sitecore field.

How to Map Radio and Select Fields

While text and attachment fields map directly into fields within Sitecore Radio, select fields that can include different options require an additional layer of mapping.

As seen below, there are two extra fields for a radio or checkbox field:

The first (1) is the list of drop-downs for each field of a certain type from the Content Workflow; you must select an element representing a pointer to a folder containing a list of options for a specific field.

For the second (2), you must select an element representing a pointer to a template of a specific option type. This is necessary so that when a certain option is in the Content Workflow but not in Sitecore, it will be imported and created based on the selected template. This is the same template type as the items in the folder selected in step 1.

Supported Field Types

How to Import Content into Sitecore

1. Choose the Sitecore item from the list and click Import in the top bar.
2. After all the mapping criteria are set, close the dialog and navigate to the content tree.
3. Choose the Sitecore item under which you want to add items and click the Import on the Content Workflow ribbon.
4. Select the Content Workflow project to import your content from.
5. An import content dialog will appear, showing an empty grid.
6. At this stage, you can select any Content Workflow project with a mapped template.
   • You can also filter items by content workflow status and template. 
7. Select the Items you want to migrate.
8. Select the items you want to import using the checkboxes, then click Next. This will launch the confirmation screen.
9. Specify the language and destination and select the Item's status.
10. On the confirmation screen, you can go over the selected Items.
11. Then, specify the language and destination for the Items being imported.
    • If a template for an item has more than one mapping defined, the system will drop down with possible mappings next to each item.
    • You can also select the status that will be assigned to the Items in Content Workflow after a successful import.
12. Select Import to begin the import process.
13. The process can take some time, depending on the number of imported items.
14. View the import results. After the import is finished, the import result screen will appear, where all imported and unimported Items are shown with their respective descriptions.
15. It's now possible to open an Item in Sitecore or Content Workflow.
16. The import results page will list all successful and failed imports.
    • There are two reasons why an import may have failed. The error messages will show as Template fields mismatch and template not found.

How to Update Content in Sitecore with Changes Made in Content Workflow

You can update Sitecore items imported from Content Workflow.

1. Navigate and select the update option in the top bar.
2. Select the node under which you want to update items and click Update.
3. Select the items to update.
4. The pop-up dialog will show all items under the selected node previously imported from Content Workflow.
5. You can select the items to update and click Next.
6. View the results screen. The update process is similar to the import process. It ends with a results screen where you can view how many items were updated and if there are any errors.

Updated July 22, 2024 20:00