Short feature description
The plugin connects Desk-Net with a WordPress site and syncs data back and forth.
Two main use cases are supported:
- A story is planned and coordinated in Desk-Net. The meta-data of that story is sent to WordPress creating a post in that system. Updates made to the story in WordPress are synced back to Desk-Net.
- Breaking news and other stories can initially be created in WordPress and the plugin creates a story list entry in Desk-Net.
To learn more about the concept of the Desk-Net and WordPress integration please visist the concept post.
Before you start
These preconditions must be met before you get started:
- You must be Desk-Net customer or at least have a free test account (learn more about Desk-Net and get your free test account)
- You need to have received the API credentials for your Desk-Net account (if you have a Desk-Net account please request them from firstname.lastname@example.org).
- You need to have admin access to a WordPress.org or WordPress VIP site (version 4.4.0 or higher). This site must not be placed behind a firewall, i.e. it must be accessible via the internet.
Installing the plugin
You install the plugin in your WordPress backend via the page Plugins > Add New.
If you have received the plugin code as a zip file please use the Upload Plugin feature to install it.
Once installed you will see a line entry called "Desk-Net" in the navigation bar of your WordPress backend.
Connecting Desk-Net and WordPress
You need to "inform" both systems about the other's login credentials. You do this in two steps.
- Desk-Net to WordPress
In the WordPress backend click on the label "Desk-Net" in the navigation bar and you will be taken to the page "WordPress Credentials". Keep this page open and now access your Desk-Net.
In Desk-Net go to the list of platforms in the admin area and select the platform you want to connect for editing. Access the tab "Advance Settings".
At "Data export / API" select "Default / WordPress". At least initially leave the setting "All statuses" untouched.
Now enter the URL, API User and API Secret data that is displayed in WordPress into the corresponding fields in Desk-Net. Please don't forget to click Save below.
You may want to test the connection by clicking on "Test connection".
- WordPress to Desk-Net
In the WordPress backend go to the page "Desk-Net Credentials" in the Desk-Net plugin.
Enter the API credentials that you have received from Desk-Net and click on Save Changes.
Done - now your Desk-Net account and your WordPress site are connected.
Configuring the plugin
Once you have successfully completed the connection of WordPress and Desk-Net the two systems start exchanging data.
You can now, however, define in more detail how and when data should be synced. This is done on the following pages in the Desk-Net plugin:
- Match status levels
- Match categories
- Insert Desk-Net ID in the URLs
Matching status levels
Both in Desk-Net as well as in WordPress you can set status levels. These can be matched so that a status change in WordPress is immediately and appropriately reflected in Desk-Net and vice versa.
To do so access the page Status Matching in the Desk-Net plugin in WordPress. It displays two sections:
- Top section "Desk-Net to WordPress": On the left you find the status levels of your Desk-Net account (they can be customized in the admin area).
The menus on the right list the WordPress status levels.
Using these menus please define what status should be set in WordPress depending on what status is set in Desk-Net.
The plugin also displays the "status" Deleted/Removed allowing you to define what status should be set in WordPress if a story is removed in Desk-Net.
- Section "WordPress to Desk-Net": Use this section to define what status level in Desk-Net should be set depending on the status level set in WordPress.
Matching categories (to be released in early March 2017)
The categories in Desk-Net and WordPress can be matched on the page Category Matching in the same way the status levels are matched (see above).
Desk-Net ID in URL
Each and every Desk-Net story features a unique ID across all Desk-Net accounts. You can opt to have the ID included in your WordPress URLs in order to more easily identify stories on your website and/or to allow a better identification of stories in other systems that may receive the URL.
The default of this feature is OFF.
Once you activate this feature the following will happen:
- URL generated by WordPress without this feature: http://www.your-blog.com/new-story-1
- URL generated by WordPress with this feature turned on: http://www. your-blog.com/12345678/new-story-1 (with "12345678" being the Desk-Net story ID)
Users can upload content per assignment in Desk-Net. This content is then exported to WordPress.
The plugin allows you to define where this content should be exported to:
- Files such as picture or video files can either be inserted into the post's body AND at the same time they are stored in the Media section. Alternatively you can ask the plugin to move the files to the Media section only.
- Text will always be added straight to the post's body.
Uploaded content is never inserted into a post that has the status Published in WordPress.
Please note the following restrictions in WordPress which can cause files not to be transferred:
- The default maximum file size for a file uploaded to WordPress is 64Mb which is significantly lower than the 2Gb allowed in Desk-Net.
- WordPress has restrictions on what type of file types can be uploaded (see list of file types allowed by WordPress).
The plugin automatically matches user profiles in Desk-Net and WordPress based on the email address.
If an email address exists in both systems the corresponding user is matched.
In case a story with multiple assignees is created in Desk-Net the plugin tries to match the email address of the assignee of the first text assignment.