Difference between revisions of "Funnel Settings"

From Funnel Settings
Jump to navigation Jump to search
m
 
(25 intermediate revisions by 5 users not shown)
Line 1: Line 1:
= <strong>System Document</strong> =
= <strong>System Documentation</strong> =
''<big>version 2.1.0</big>''
''<big>version 2.1.0</big>''


==== INTRODUCTION ====
=== Introduction ===
“Funnel Settings” is a tool specifically developed to work with WordPress platform. WordPress is the World’s leading CMS platform which allows users to optimise and customise front-end content easily without the need of a web developer. Funnel Settings is a WordPress plugin that can be easily installed and customised by any novice user.
“Funnel Settings” is a tool specifically developed to work with WordPress platform. WordPress is the World’s leading CMS platform which allows users to optimise and customise front-end content easily without the need of a web developer. Funnel Settings is a WordPress plugin that can be easily installed and customised by any novice user.


The plugin integrates with two major APIs. 1) Earnware 2) Konnektive CRM. Earnware is used for collecting email addresses and Konnektive CRM handles all transactions.
The plugin integrates with two major APIs. 1) Earnware 2) Konnektive CRM. Earnware is used for collecting email addresses and Konnektive CRM handles all transactions.


==== TECHNICAL REQUIREMENTS ====
=== Technical Requirements ===
{| class="wikitable"
{| class="wikitable"
!
!
Line 31: Line 31:
|}
|}


== Document Version Control ==
=== Document Version Control ===
{| class="wikitable"
{| class="wikitable"
!Date
!Date
Line 45: Line 45:
|Overall
|Overall
|}
|}
== ShortCodes ==
[opt_in_form] => to integrate opt-in form to the page
[checkout_page] => to integrate order-input form to the page such as shipping details, card details and order summary etc
[checkout_form_v2] => variation of checkout page which has different styling and checkout component orders
[checkout_form_canada_v2] => another version of checkout form
[order_confirmation] => Final order summary details to display. responsible for calling Konnektive API and get order details by order Id and displaying those.
[next_step] => passing to step details to process
[sticky_footer] => page footer
[st_client_ip] => To integrate client IP address to page
[order_id] => to integrate Order id to the page
[order_date] to Integrate order date to the page
[order_summary] => used in the checkout_page as a helper shortcode. Which call the API to get order details.
== Enums ==
{| class="wikitable"
!Name
!Allowed values
|-
|page_type
|checkout, opt-in, additional_sale, skip_sale
|}
== See Also ==
[[Process Flow]]
[[User Interfaces]]
[[Admin interface|Admin Interface]]

Latest revision as of 03:15, 9 May 2022

System Documentation[edit | edit source]

version 2.1.0

Introduction[edit | edit source]

“Funnel Settings” is a tool specifically developed to work with WordPress platform. WordPress is the World’s leading CMS platform which allows users to optimise and customise front-end content easily without the need of a web developer. Funnel Settings is a WordPress plugin that can be easily installed and customised by any novice user.

The plugin integrates with two major APIs. 1) Earnware 2) Konnektive CRM. Earnware is used for collecting email addresses and Konnektive CRM handles all transactions.

Technical Requirements[edit | edit source]

Latest Tested Version
PHP 7.4
WordPress 5.8.1
Advanced Custom Fields Pro (ACF) 5.10.2
Elementor (optional) 3.4.4
Elementor Pro (optional) 3.4.1
Wordfence Security (optional) 7.5.5

Document Version Control[edit | edit source]

Date Version Author Section(s) Amendments/Comments
05th Oct 2021 Initial Lucky All Overall

ShortCodes[edit | edit source]

[opt_in_form] => to integrate opt-in form to the page
[checkout_page] => to integrate order-input form to the page such as shipping details, card details and order summary etc
[checkout_form_v2] => variation of checkout page which has different styling and checkout component orders
[checkout_form_canada_v2] => another version of checkout form
[order_confirmation] => Final order summary details to display. responsible for calling Konnektive API and get order details by order Id and displaying those.
[next_step] => passing to step details to process
[sticky_footer] => page footer 
[st_client_ip] => To integrate client IP address to page
[order_id] => to integrate Order id to the page
[order_date] to Integrate order date to the page
[order_summary] => used in the checkout_page as a helper shortcode. Which call the API to get order details.

Enums[edit | edit source]

Name Allowed values
page_type checkout, opt-in, additional_sale, skip_sale

See Also[edit | edit source]

Process Flow

User Interfaces

Admin Interface