Document version: 1.0
Note: The legacy plugin is no longer being supported by Percolate. While it may continue to function, continued functionality is not guaranteed.
In order to use this plugin you will need an API key issued to you from Percolate, along with your user ID.
The WordPress-Percolate connector is an installable WordPress plugin made available to Percolate clients. The plugin is designed specifically for WordPress, and includes support for common WordPress concepts like Custom Post Types, post categories, Media Library, and Featured Images.
It is tested up to WordPress 4.7.2, and is hosted on Github.
The plugin can be configured for Percolate licenses by using a Percolate API key combined with License and Channel information, both configurable via dropdown menu. For each configured license, custom templates in Percolate can be mapped to Post Types in WordPress. The content from each post created in Percolate is pushed to WordPress every 5 minutes, using the WordPress built-in, PHP-driven cron. For each post, WordPress content is created based on the field mappings and import rules.
Percolate custom creative templates support most commonly-used blog page elements.
- Importing posts
- Importing post images (Featured Image and in-line in post body)
- Importing post tags as WordPress tags
- Importing and mapping Percolate Topics as WordPress categories
- Importing custom schemas
- Usage of custom blog entry templates
- Avoiding post duplication
- Configuration of import logic (import draft vs. queued posts)
- Search Percolate DAM in WordPress Media Library
| Component | Description |
|---|---|
| Plugin core | Core and model/view files |
| Public library support | Supporting libraries from Angular, Boostrap, et al. |
| Additional files | For CSS compilation, markdown, testing, etc. |
This section describes how to install the Percolate-WordPress plugin and perform initial configuration.
As a first step, please ensure you have the latest Percolate-WordPress plugin distribution, available on Github.
- Select "Add New"
- Add the Percolate-WordPress .zip file and select “Install Now”
- Under “Manage Channels,” select “Add New”
- Add user API key to unlock list of available Licenses
- Provide your preferred name for configured channel in WordPress (e.g. “Percolate Posts”)
- Select Percolate License, Platform, and Channel
- “Continue”
- Percolate License Topics will appear on the left
- Select WordPress categories for each Percolate topic.
- Unmapped Topics will not import
Note: after this step, you may “Save” without configuring templates, and return at any time.
This process requires that Custom Creative templates have been configured for your License in Percolate. For assistance with Custom Creative templates, please reach out to your Percolate Engagement Manager or Product Specialist.
In addition to template mapping, you can set specific import rules to be set for each License:Channel configuration:
| Earliest import | Percolate statuses imported | Description |
|---|---|---|
| Draft | "Publishing," "Queued," "Draft" | Import all approved drafts and posts |
| Queued | "Publishing," "Queued," | Import all posts that are done being drafted |
| On Schedule | "Publishing" | Import posts only at their scheduled publishing times |
- Each custom template associated with the configured Channel can be mapped to a WordPress Post Type
- For each of the default WordPress Post fields, select a Percolate field to be mapped
- In the “Earliest import” dropdown, select the workflow step at which you’d like Percolate content to import
- To avoid “Queued” posts automatically publishing at their scheduled times, select
“Set status to Draft in WP”
- By default, imports of “Queued” and “Publishing” posts will be scheduled for publishing in WP
- Note: “Drafts” imported from Percolate will never publish automatically
- Additional Custom Creative fields can be mapped to WordPress shortcodes
- While using special markup for Percolate-importing fields is not required,
it is recommended for clarity
- All basic title/body/image mappings still apply
This section describes the setup and functionality of the basic Percolate-WordPress asset integration that comes bundled with the post import plugin.
- Enter a Percolate API Key to unlock a list of Licenses
- Select the License that will be used for asset search
- Select image size and alt text, and import
Once Channel and template configuration are complete, you can test the module by creating a Post in Percolate, and forcing the import job to run with the “Import” button on the plugin homepage.
The following steps require that a custom WordPress Channel has been added to your Percolate License. For assistance with custom Channels, please contact your Percolate Engagement Manager or Product Specialist.
- Select desired WordPress Channel and Template
- Compose your post
You should see that:
- All configured fields have imported
- All tags have been imported
- Topics are mapped correctly
- Images have imported and are available in Media Library
- Manual settings UI
- Adding support for Percolate's overhauled v5 Taxonomy API
- Image import backward compatibility for WP < v4.8
- Complete rewrite of image importing
- Only fetch draft and queued posts upon import
- Fix inline image import to WP
- Approvals workflow fix
- Several small enhancements and fixes
- Custom taxonomy support
- User mapping pagination
- Better detection for the installed version of ACF
- Added Post Syncing - changes from Percolate automatically get picked up
- Added MetaBox support - schema fields can be mapped to MetaBox fields too
- Bugfixes
- WPML support
- PHP 7 support
- Code refactoring
- Fixing post transitioning & logs
- ACF multi-select support
- Versioning fix
- Bugfixes for post transitioning
- User mapping added
- Percolate fields can be mapped to multiple ACF groups' fields
- Bugfixes
- Post transitioning fixes
- UI optimisations for ACF
- Bugfixes
- Percolate API calls are handled with WP HTTP API
- Percolate's schema versioning is implemented
- Bugfixes and optimisation
- Transition post upon WP publish
- Draft | Queued post status support
- Draft posts from Percolate will become drafts in WP
- Percolate's Select field can be mapped to ACF True/False field
- Custom approvals workflow support
- 5 minute CRON interval
- Bugfixes / improved compatibility with other plugins
- Initial release with support for custom platforms/templates.
For change history of the Percolate-Wordpress legacy plugin, please refer to the original repository: WP-Percolate
Please do not remove this version declaration
Current Version:4.x-1.2.6