Follow

Pugpig Software & Service Specification

This document describes the standard Pugpig software product and services licensed and supported under the Pugpig Customer Agreement.  It will be updated regularly.

Pugpig Authoring Service
Pugpig Distribution Service
Pugpig Client Framework

Pugpig Authoring Service

The Pugpig Authoring Service is available for our Pugpig Express and Pro customers.

Pugpig Express Authoring Service:

You will be given an account on the multi-tenanted distribution service, which is entirely managed and supported by Kaldor. The service consists of:

  • A tailored version of WordPress
  • Core Third Party CMS plugins, the Pugpig Connector plugins, and the Pugpig Responsive Theme for WordPress
  • Supported Third Party WordPress Plugins: WCK Professional, Meta Box, Mailgun
  • 99.9% system availability with published maintenance windows
  • Managed daily backups with 7 day retention, plus 15 day and 30 day snapshots

Pugpig Pro Authoring Service:

Kaldor will host and manage a dedicated instance of the Pro Authoring Service. You can choose between using WordPress or Drupal as your base Content Management. The service consists of:

  • A dedicated Amazon EC2 instance (size either m3.medium or m3.large depending on the sizing)
  • Operating system managed and patched by Kaldor
  • You will get 100GB of storage on the server
  • Core Third Party CMS plugins managed and upgraded by Kaldor
  • The Pugpig Connector plugins managed and upgraded by Kaldor
  • Supported Third Party WordPress Plugins: WCK Professional, Meta Box, Mailgun
  • Supported Third Party Drupal Modules: references, features, ckeditor, admin_menu, image, options, list
  • You will get SFTP access to the CMS to allow you to upload custom modules/plugins and themes
  • Both a staging and production CMS so you can test code changes before pushing them live
  • Custom code is not supported by Kaldor under the Software Licence Agreement
  • 99.9% system availability with published maintenance windows
  • Managed daily backups with 7 day retention, plus 15 day and 30 day snapshots

Pugpig Connect and Toolkit customers are responsible for their authoring tools. They can use our supported Wordpress, Drupal and Adobe Experience Manager (AEM) connectors on their own environments. Alternatively, they can use a third party CMS connector or even build their own.

Pugpig Connect or Toolkit Connectors

Currently available for Drupal, WordPress, Adobe Experience Manager (AEM)

If you are using Pugpig Connect or Toolkit, you will need to connect to a server to retrieve content. A simple option is to copy or File Transfer Protocol (FTP) static files onto the server. However, Pugpig becomes more powerful when it talks to an existing Content Management System (CMS) to allow you to use existing content in your Pugpig editions. In order to do this, a connector needs to be installed on your CMS and will provide the interface required to publish content to your application. Kaldor have built connectors for Drupal, Wordpress and Adobe Experience Manager (AEM) systems. Other connectors are available with third party suppliers and you can write your own connector for a CMS using the Pugpig API.

You can download Wordpress and Drupal connectors from our website. The Wordpress downloaded zip contains a group of plugins and the Drupal downloaded zip contains a group of modules. There is a default set of Pugpig Connector plugins and modules that should be enabled to get your connector working and a set of optional ones which can be enabled based on your requirements and use. Our Connectors share a number of common features and code and some features may be developed across connectors and platforms at different times. Our Product roadmap provides a good indication of what features are coming in future releases and when they are planned for.

Third Party Software notes

The following Pugpig Connectors are built on top of open-source Content Management System platforms.

WordPress
Our Pugpig Wordpress Connector runs on WordPress Core (version 3.5+). Pugpig Wordpress WordPress is distributed under a GNU General Public License. More details can be found here: https://wordpress.org/about/gpl/

Drupal
Our Pugpig Drupal Connector runs on Drupal Core (version 7.1.8+). Drupal is also distributed under a GNU General Public License. More details can be found here: https://www.drupal.org/about

With Drupal we also have the following dependencies that aren’t part of Core:

  • references (version 7.x-2.0)
  • node_reference (version 7.x-2.0)

Details of both can be found here: https://www.drupal.org/project/references

The downloaded zip files for these connectors comprise code written and supported by Kaldor and licensed under a GNU General Public Licence.

All Pugpig Connectors should make use of the Pugpig Application Programming Interface (API) which specifies the way that the Pugpig apps communicate with the server. The specification covers the expected content format and the security API. The API exists in the form of documentation, along with test harness implementations.

Pugpig Distribution Service:

The Pugpig Distribution Service is available for Pugpig Express, Pro and Connect customers. You will be given an account on the multi-tenanted distribution service, which is entirely managed and supported by Kaldor.

  • 99.9% system availability with published maintenance windows
  • Managed daily backups with 7 day retention, plus 15 day and 30 day snapshots

You can find out more about what this service offers you here.

Pugpig Toolkit customers are responsible for their distribution tools and add-ons. We can provide standalone PHP to work from as a code accelerator.

Pugpig Client Framework

The features available across our Pugpig Client Framework are available here. Below is an overview of the client framework products we offer.

Pugpig SDK
Pugpig App Containers
 - Pugpig for Magazines
 - Pugpig for Continuous Publishing

Pugpig SDKs

Currently available for iOS, Android, Windows 8 (beta), Web (beta)

The Pugpig SDKs are a set of compiled libraries that provide core services to power every Pugpig app. Where appropriate, the SDKs include basic example user interfaces (UIs), provided as a starting point for using the majority of app controls we offer.  These basic UIs can be customised and extended or re-designed to suit your requirements. They can be downloaded from the Pugpig website. There is not always feature parity between the operating systems. The features covered by the SDK are:

  • ppAuthentication - Authentication API
  • ppDocuments - Downloading / processing Documents
  • ppSharing - Integration with social networks and email
  • ppSearch - In-document search (offline)
  • ppAnnotations - In-document note-taking
  • ppScrapbooking - Duplication and storage of documents
  • ppAnalytics - Hooks to track various events
  • ppSounds - Ability to play audio files
  • ppBridge - Javascript (JS) Bridge functions for galleries, camera, analytics, calendar events, etc.

Pugpig App Containers

The Pugpig App Containers are packaged applications built on top of the Pugpig SDK with more sophisticated UI and features you can switch on, configure and theme. The flavours currently available are:

Pugpig for Magazines
Currently available for iOS, Android, Web

An application with a UI and feature set appropriate for periodicals. There is not always feature parity between the operating systems. The product is intended to be used as provided, and it can be themed and configured in predefined ways.

Pugpig for Continuous Publishing
Currently available for iOS, Android

An application with a UI and feature set appropriate for regularly updated content. There is not always feature parity between the operating systems. The product is intended to be used as provided, and configured in predefined ways.

Pugpig for Continuous Publishing and Pugpig for Magazines products share a number of common features (detailed here), some of the UI for these features may differ across the products. The features listed may be developed across products and platforms at different times and our Product roadmap provides good indication of what features are coming in future releases and when they are planned for.

Third Party Notes:

Our Pugpig for Magazines and Continuous Publishing products currently incorporate the following third party software: 

  • Urban Airship Web API (currently in iOS only)

A third party Push Notification service, we interface with Urban Airships Developer Web API not their client SDK.

  • Google Analytics (in iOS, Android, Windows and Web)

A third party analytics service used across all our products and platforms.

Our Pugpig for Magazines on Web product incorporates some additional third party code and Javascript (JS) libraries, as listed below:

Please follow the links to find the licence terms on which the software is made available.

Integrated Third Party Software

Some of our products use third party and open source software. Where applicable we have made Third Party Software notes on what is currently integrated in the Pugpig software against the products listed above. In accordance with the Software Licence Agreement, the customer is responsible for obtaining all licences, upgrades and support in respect of any such third party software, although support will be provided by Kaldor in relation to the integration of the third party software listed in this document with the Pugpig software described above.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk