Syncing

overview this documentation guides administrators through setting up the kordiam (formerly desk net) plugin for the purple hub the plugin enables synchronization between kordiam editorial planning system and wordpress based purple hub installations table of contents best practice initial setup channel mapping status sync settings post type status mapping channel field mapping legacy settings additional settings best practice there are various ways to set up purple with kordiam, and we will keep supporting existing setups until informed otherwise however, in order to set up the kordiam connection with purple in the most optimal way, we advise the following best practice treat kordiam as your planning tool for allocating resources and purple hub as your creating and publishing tool published content is what will reach reading customers, therefore, the hub should be the leading source for all your content, the single point of truth this will mean that after an article has been created in kordiam, there will be a one time object creation from kordiam to purple hub after that, there will be no further syncing from kordiam to purple hub, only from purple hub to kordiam not all metadata will sync between kordiam and purple hub see the diagram below to understand what will sync and when with the different possibilities in purple to map channels to variants (also known as custom post types) and statuses, it is also possible to create more complex mappings, including having print variants of an article initial setup wordpress credentials configure the basic wordpress connection credentials required for the plugin to function this is typically set up once during initial installation kordiam credentials enter the kordiam api credentials to establish the connection between systems this is a one time configuration during initial setup important always remember to click the "save" button at the bottom of each settings page after making changes channel mapping navigation kordiam plugin → channel mapping purpose maps kordiam channels to specific post types in purple hub when a channel is created in kordiam, it will automatically create a post with the corresponding post type in the hub configuration steps navigate to the channel mapping settings page you'll see a list of all channels configured in kordiam for each channel, select the corresponding purple hub post type from the dropdown example kordiam channel "your channel name" maps to → post type "your post type" how it works when a channel is assigned to a post in kordiam, a post is automatically created in purple hub with the mapped post type the channel must also be configured in kordiam to create posts on the hub side posts can be linked as variants if the variant linking setting is enabled status sync settings navigation kordiam plugin → status sync settings important must be activated using the checkbox at the top of the page understanding status types there are two different status types that should not be confused story status (top of kordiam interface) the overall editorial status channel status (bottom of kordiam interface) individual channel publication status this settings page configures the story status synchronization post type priority (iro key) defines the hierarchy for determining which post variant controls status and title synchronization back to kordiam how it works when multiple variants of a post exist (e g , online, print, newsletter) the post type highest in the priority list is used to sync status and title back to kordiam lower priority posts in the hierarchy will not affect the kordiam story status example configuration post type a (priority 1 highest) post type b (priority 2) post type c (priority 3) in this example changes to "post type a" will sync back to kordiam changes to "post type b" or "post type c" will not sync back if the "post type a" variant is deleted, the next highest priority post takes over status mapping (story status) maps wordpress post status to kordiam story status common mappings wordpress "published" → kordiam "accept" wordpress "draft" → kordiam "pitch" example if a post is published in the hub, the story in kordiam automatically receives the "accept" status post type status mapping navigation kordiam plugin → post type status mapping prerequisite only functions when "only allow initial sync from kordiam" is enabled in syncing settings purpose maps wordpress post status to kordiam channel status (not story status) this controls the status shown at the bottom of the kordiam interface for individual channels configuration steps enable "only allow initial sync from kordiam" in syncing settings navigate to post type status mapping configure mappings for each post type that has a channel mapping available for only post types configured in channel mapping will appear here status options wordpress statuses published, draft, scheduled, etc kordiam channel statuses dynamically fetched from kordiam (custom statuses per installation) option "do not sync" select this for statuses that shouldn't trigger synchronization how it works example post type your post type mapping wordpress "published" → kordiam channel status "published" result when the post is published in wordpress, the channel in kordiam shows "published" status "only allow initial sync from kordiam" navigation kordiam plugin → syncing settings syncing when enabled posts are created in the hub when a new channel is assigned in kordiam subsequent changes in kordiam are not synced to the hub only changes in the hub sync back to kordiam (based on the settings above) this gives hub editors full control after initial post creation date synchronization the publication date from the kordiam channel is automatically synced to the hub post the post with the highest priority in the hierarchy (as defined in post type priority) is used for date synchronization channel field mapping navigation kordiam plugin → channel field mapping important must be activated using "enable channel field mapping" checkbox purpose maps kordiam categories and metadata to wordpress taxonomies or acf (advanced custom fields) when posts are initially created configuration steps enable "enable channel field mapping" select a post type from the dropdown (only post types with channel mappings appear) view the list of available kordiam categories for that channel mapping options for each kordiam category, you can map to 1\ taxonomy mapping field type select "taxonomy" taxonomy choose the wordpress taxonomy term select the term to assign example kordiam category "category name" maps to → taxonomy "your taxonomy" → term "your term" result posts with this category in kordiam automatically get assigned the specified term in the taxonomy 2\ acf field mapping field type select "acf field" acf field choose the custom field (only fields available for that post type appear) value enter the value to assign example kordiam category "category name" maps to → acf field "your acf field" (string field) → value "your predefined text" result the acf field receives the specified value when the post is created important notes only taxonomies and acf fields configured for the specific post type will appear in the dropdowns these mappings only apply during initial post creation multiple mappings can be configured for each post type legacy settings the following settings are maintained for backward compatibility with existing customers but are generally not recommended for new installations with multiple channels status matching navigation kordiam plugin → status matching limitation only works for a single channel when to use customer has only one channel no need for the more complex multi channel settings when not to use customers with multiple channels (e g , online, print, newsletter) in these cases, use the new "status sync settings" and "post type status mapping" instead category matching navigation kordiam plugin → category matching limitation only works for a single channel when to use customer has only one channel simple category mapping needs when not to use customers with multiple channels in these cases, use the new "channel field mapping" instead task matching navigation kordiam plugin → task matching purpose maps kordiam tasks to wordpress fields status rarely used in practice most customers don't require task mapping additional settings > should not be used > should not be used content settings > no sync of content possible > no sync of content possible navigation kordiam plugin → content settings purpose when enabled, text content from kordiam tasks is synced to the post during initial creation current usage not commonly used in production environments syncing navigation kordiam plugin → syncing key setting "enable syncing to kordiam" typical configuration usually deactivated in purple hub installations reason in most workflows, synchronization is one way (kordiam → hub for initial creation, hub → kordiam for status updates), not bidirectional for all content changes kordiam id in url navigation kordiam plugin → kordiam id in url purpose adds the kordiam id to the wordpress post slug (url) recommendation not recommended unless there's a specific use case current usage no known customers using this feature configuration workflow for new customers for customers with multiple channels configure channel mapping map all kordiam channels to post types configure status sync settings set up post type priority and story status mapping enable "only allow initial sync from kordiam" in syncing settings configure post type status mapping map post statuses to channel statuses for each post type configure channel field mapping map categories/metadata to taxonomies or acf fields skip legacy status matching and category matching for customers with single channel option 1 (simpler) configure channel mapping configure status matching configure category matching skip advanced multi channel settings option 2 (future proof) follow the multi channel workflow above (recommended if customer might add channels later) important reminders always save changes by clicking the "save" button at the bottom of each settings page test thoroughly in a staging environment before deploying to production document your mappings for future reference and troubleshooting status types matter understand the difference between story status (top) and channel status (bottom) priority hierarchy remember that only the highest priority post type syncs back to kordiam troubleshooting tips posts not syncing from kordiam verify wordpress and kordiam credentials are correct check that channel mapping is configured for the specific channel ensure the channel is properly configured in kordiam to create posts status not updating in kordiam check post type priority ensure the post type you're editing has highest priority verify status mapping is correctly configured confirm "only allow initial sync from kordiam" is enabled if using post type status mapping categories/fields not mapping ensure "enable channel field mapping" checkbox is enabled verify the taxonomy or acf field exists for that post type check that the mapping is saved correctly changes from kordiam overwriting hub edits enable "only allow initial sync from kordiam" to prevent subsequent updates from kordiam