Short feature description
The module connects Desk-Net with a Drupal 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 Drupal creating a post in that system. Updates made to the story in Drupal are synced back to Desk-Net.
- Breaking news and other stories can initially be created in Drupal and the module creates a story list entry in Desk-Net.
To learn more about the concept of the Desk-Net and Drupal 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 email@example.com).
- You need to have admin access to a Drupal site (version 7.54 or higher). This site must not be placed behind a firewall, i.e. it must be accessible via the internet.
Installing the module
You install the module in your Drupal backend via the Downloads section.
Once installed you will see a line entry called "Desk-Net" on the page Modules in the section Administration.
Connecting Desk-Net and Drupal
You need to "inform" both systems about the other's login credentials. You do this in two steps.
- Desk-Net to Drupal
In the Drupal backend go to the tab "Drupal Credentials" in the Desk-Net module. Keep this page open and now access your Desk-Net account.
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 "Drupal". At least initially leave the setting "All statuses" untouched.
Now enter the URL, API User and API Secret data that is displayed in Drupal 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".
- Drupal to Desk-Net
In the Drupal backend go to the page "Desk-Net Credentials" in the Desk-Net module.
Enter the API credentials that you have received from Desk-Net and click on Save.
Done - now your Desk-Net account and your Drupal site are connected.
Configuring the module
Once you have successfully completed the connection of Drupal 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 tabs in the Desk-Net module:
- Match status levels
- Match categories
- Define content import settings
Matching status levels
You can use multiple status levels whereas Drupal provides you with Unpublished and Published. These can be matched so that a status change in Drupal is immediately and appropriately reflected in Desk-Net and vice versa.
To do so access the tab Status Matching in the Desk-Net module in Drupal. It displays two sections:
- Top section "Desk-Net to Drupal": On the left you find the status levels of your Desk-Net account (they can be customized in the Desk-Net admin area).
The menus on the right list the Drupal status levels.
Using these menus please define what status should be set in Drupal depending on what status is set in Desk-Net.
The module also displays the "status" Deleted/Removed allowing you to define what status should be set in Drupal if a story is removed in Desk-Net.
- Section "Drupal to Desk-Net": Use this section to define what status level in Desk-Net should be set depending on the status level set in Drupal.
The categories in Desk-Net and Drupal can be matched on the tab Category Matching in the same way the status levels are matched (see above).
Users can upload content per assignment in Desk-Net. This content is then exported to Drupal.
The module allows you to define where this content should be exported to:
- Files such as picture or video files can either be inserted into the article's body AND at the same time they are stored in the Media Library. Alternatively you can ask the module to move the files to the Media Library only.
Please note that in order to import pictures into the article's body you need to have the WYSIWYG editor installed.
- Text will always be added straight to the article's body.
Uploaded content is never inserted into an article that has the status Published in Drupal.
The module automatically matches user profiles in Desk-Net and Drupal 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 module tries to match the email address of the assignee of the first text assignment.