homesupportdrupal 8

requirements

drupal 8: version beta14+

php:

  • domdocument
  • curl
  • (video) fopen with “allow_url_fopen = true”

installation

1. download .zip file from https://github.com/contentlead/braftondrupal8module.

drupal8_1

2. in the drupal admin bar, click the “extend” button.

drupal8_2

3. click the “install new module” button (example.com/admin/modules/install).

4. click the “choose file” button and select the .zip file downloaded in step 1.

5. click the “install” button.

6. assuming the installation was successful, click the “enable newly added modules” link (example.com/admin/modules).

7. scroll down or search for “brafton importer module” and click the checkbox next to it.

8. scroll to the bottom of the page and click the “install” button.

basic setup

  • in the drupal admin bar, click the “configuration” button.
drupal8_3
  • find the link for “brafton importer module settings” and click it. this brings you to the brafton importer config page (example.com/admin/config/content/brafton).
drupal8_4

under “general options”

  • turn “master importer status” to “on”.
drupal8_5
  • set your “api root” to be either “brafton”, “contentlead”, or “castleford”.

under “article options”

  • turn “article importer status” to “on”.
  • enter your api key in the “api key” field.

under “video options” (if applicable)

  • turn “video importer status” to “on”.
  • enter your public key in the “public key” field.
  • enter your private key in the “private key” field.
  • enter your feed number in the “feed number” field.

scroll to the bottom and click the “save configuration” button.

now your site is set to import content every time the drupal cron runs (default is every 3 hours), which can be configured at example.com/admin/config/system/cron.

manual control

apart from running periodically (and automatically), you can also import articles and/or videos manually. at the brafton importer config page (example.com/admin/config/content/brafton), under “manual control”, there is a button to manually import articles and a button to manually import videos. running the importer manually does the exact same thing as when the importer runs on schedule. that is, the corresponding xml feed is checked and any articles are imported that do not already exist on the site.

category and archives views

upon installation of the module, two drupal “views” are created: “brafton archive” and “brafton categories”.

the views provide two drupal “blocks”: “brafton archive block” and “brafton categories”.

access your blocks by clicking on the “structure” link in the drupal admin bar, then clicking on the “block layout” link.

drupal8_6

the “brafton archive block” is for linking to all categories in a sidebar.

the “brafton archive block” is for linking to all month-year combinations in a sidebar.

drupal8_7

configuration options

general options

master importer status:allows the importer module to run periodically via the drupal cron.

api root:the brand associated with the xml feed (brafton, contentlead, or castleford).

brafton categories:for using article categorization from the xml feed.

overwrite any changes made to existing content:normally the importer module will pass over articles from the xml feed that already exist as drupal articles. however if this option is checked, the importer will overwrite/update the existing drupal articles with the corresponding xml information.

publish status:import drupal articles as published nodes or unpublished nodes. unpublished nodes will not display to the public.

article options

article importer status:allows the importer module to import articles periodically via the drupal cron.

api key:this is your unique key provided by your account manager to access your xml feed.

content author:choose the author (drupal user) of imported articles. select “get author from article” to use the author name listed in the xml feed.

publish date:xml articles come with 3 dates. choose which one you want to use as the official article publish date.

video options

video importer status:allows the importer module to import video articles periodically via the drupal cron.

public key:provided by your account manager.

private key:provided by your account manager.

feed number:the number of the feed under the client. usually 0.

content author:choose the author (drupal user) of imported video articles.

publish date:xml articles come with 2 dates. choose which one you want to use as the official article publish date.

atlantis js switch:inserts link to javascript library into the head section of the site. using this library changes the look of the videos and allows advanced video functionality like call-to-actions (ctas) and social sharing.

cta switch:enables your videos to have call-to-actions (ctas).

atlantis pause cta text:text of link that appears upon video pause.

atlantis pause link:url of link that appears upon video pause.

pause asset gateway id:the form id associated with the asset gateway account. entering an asset gateway id disables the pause link.

atlantis end cta title:title text that appears when video ends.

atlantis end cta subtitle:subtitle text that appears when video ends.

atlantis end cta link:url of link that appears when video ends.

end asset gateway id:the form id associated with the asset gateway account. entering an asset gateway id disables the end link.

atlantis end cta text:text of link that appears when video ends.

ending cta button image:image to use instead of text for end link.

ending background image:image to display as background at end of video.

archive uploads

article archive file:browse your local computer for an xml file to import articles from.

error reporting

displays a log of any error or warning messages triggered by the importer. note that all fatal errors are automatically reported to the brafton servers.

debug mode:while in debug mode, all errors and warnings will be logged locally. outside of debug mode, only fatal errors are logged locally.

updating

once the importer module is installed, you can update to newer version through the drupal admin interface (example.com/admin/reports/updates/update).