Synergy Press Plugin Docs

Documentation for the Synergy Press Plugin

Dashboard

The dashboard is the plugins main page, in addition it will provide an overall status of resources implemented by this plugin. Such as API configuration, site configuration, packages…

Synergy Press Dashboard

API Configuration

This plugin relies on Form Synergy and it’s APIs, and a trusted connection with Form Synergy is crucial and must be established in order to proceed to the next step.

API Configuration

Site Configuration

Some information may be pre-populated from WordPress variables, it is recommended to take a quick peak and adjust any discrepancies.

Site Configuration

Plugin Options

General options and features related to this plugin can be found under the plugin options tab.

HeartBeat

The Form Synergy API heartbeat is not related nor will it affect the WordPress heartbeat.
Interruption
The first measure to detect interruptions between visitors and Form Synergy, during interruptions, requests will be routed locally and handled by WordPress resources in order to prevent loss of any inquiries.
Automated triggers
May include trigger information. (Implemented by Form Synergy).
Frequency
The minimum heartbeat frequency is 7,500 milliseconds and can be adjusted to fit your needs.
Heartbeat

Plugin Mode

Easy mode
In order to create and manage essential modules along with their objectives, advanced must be dissabled.
Advanced mode
Alternatively, if a strategy and it’s modules already exists, enable advanced mod.
Getting started
  1. You will need to locate the strategy ID
  2. Next, within the plugin, click on the interactions tab, add the strategy ID in appropriate field and update.
  3. During the update process, the plugin will import all modules available in that strategy.
Locating the strategy ID
Using the API:
When a strategy is created, the strategy ID can be found within the response.
Using the console:
Enter the website / domain you wish to administer, click to manage the strategy in question, select the strategy tab in order to reveal it’s contents.
Plugin mode

Interaction Presets

Unlike easy mode, in advanced mode, we can implement interactions directly into the source code or within the post content. This option will stop Synergy Press from automatically implementing interaction presets.
Interactions preset

Interaction Offset

In certain cases, CSS style sheets may affect the positioning of interactions! Causing them to shift from their intended position!

A simple offset can fix the problem on all interactions. For better placement accuracy, each interaction can be independently manipulated using data-attributes.

Interaction offset

Packages

While in easy mode, this tab will provide management over a strategy, default modules and objectives.
Strategy
A strategy contains modules and objectives.
Modules
A module is responsible to provide the contents of an interaction. It is composed of a subject, body, form inputs and a couple of buttons. While in easy mode, enabling and updating modules can be handled directly through the plugin three essential modules.
Essential modules
This plugin ships with three essential modules that every website and web apps should have.
Triggers
A trigger is required to load a module and display its contents within an interaction. In order to trigger an interaction, a reference class name can be retrieved from each module. Simply add the class name to the appropriate triggering element.
Objectives
While using this plugin in easy mode, objectives only handles notifications and their methods.
Strategies Packages

Interactions

While in advanced mode, the packages tab will be replaced by interactions.
Strategy
While in advanced mode, when a strategy ID is provided, any module residing within the strategy will be imported.
Modules
While in advanced mode, module management focuses on advanced implementation of interactions.
Reference ClassName Image 1
Reference class names can be retrieved under the tab labeled as ‘Reference ClassName’.
Using a className as trigger Image 1
While in advanced mode, simply add the className to the element of your choice. Any events triggered using reference className will refer to its associated parameters.
Using a className to manage display options Image 1
While in advanced mode, simply add the display className to an element which will serve as position. This plugin will update each element containing display options classNames with the appropriate data tags.
Parameters Image 2
While in advanced mode, within each module, you will find a tab labeled as ‘Interaction Parameters’. Its contents will revile a parameters editor.
Display options Image 3
While in advanced mode, within each module, you will find a tab labeled as ‘Display Options’. Its contents will revile a json editor.
Autoload trigger and parameters
While in advanced mode, you may disable autoload on trigger and display options separately.
Reference ClassName Parameters Display options

Localize Interactions

If connection difficulties with the Form Synergy service are encountered, this plugin can switch gears and function within WordPress resources by localizing modules, and preventing the loss of any inquiries.
Debug
While debug is active, this plugin will force requests back to the Synergy Press plugin. This feature is only meant for debugging purposes.
Localize Interactions

Free account

This is not a trial period. You can use a free account until you decide to upgrade.

Subscription

You may upgrade your account at your convenience, or when you see fit. It is definitely not a requirement.

Basic package

Our basic package enables access to similar features to it’s paid alternative.

Access to leadBoard

LeadBoard is free to all Form Synergy account holders.