Documentation / Tutorials / Awesome Enterprise

How to create Manage Screens using Awesome Enterprise

/ Awesome Enterprise / How to create Manage Screens using Awesome Enterprise

Table of Contents

  • Introduction
    • Manage, It’s Need and Purpose
  • Pre-Requisites and Dependencies
  • Building the Manage View
    • Manage View
    • Building “Manage” for “Contacts“ App
      • Step 1.1: Register Contacts CPT, with its meta fields & taxonomy
      • Step 1.2: Coding the Manage Part-1 Understanding args array of Manage.
      • Step 1.3 Coding the Manage Part-2 Filters and Search functionality of Manage.
  • Building the Single view of Manage
    • Single view of Manage
    • Building Single view of Manage for “Contacts“ App
      • Step 1.4: Create “single” module in the Contacts app
      • Step 1.5: Create “crud-single-contact-data” module in the Common Services.
      • Step 1.6: Create “lead-block” module in the Common Services.
  • Final Notes

Introduction

This tutorial is about building Enterprise Manage from scratch with step by step instructions. Before diving into the specifics, left first understand Manage with its need and purpose.

Manage, It’s Need and Purpose

“Manage” (verb) literally means,

 To succeed in doing or dealing with something, especially something difficult

In our case, we are dealing with difficult things like handling large datasets (few million record setswith the ability of CRUD operations on it. Make search operations blazing fast on these huge datasets or even creating & managing, custom & complex business workflows along with easy to use interface for all the stakeholders. And yes we do succeed to deal with these difficult things, by using “Manage” built on Awesome Enterprise.

The need for managing complex business workflows (along with its huge dataset’s) drives the purpose of Enterprise Manage.

One more thing, Enterprise Manage also solves another problem of handling these complex business process, all under a single umbrella with a unified and clutter-free interface to handle almost all things at one place instead of going back & forth between WordPress admin and frontend sections. This helps all the stakeholders to focus on what matters most important to them.

(Disclaimer: This feat is achieved by configuring things on various levels right from the server environment to custom data structures and everything in between.)

Pre-Requisites and Dependencies

Following is the list of dependencies for “Enterprise Manage.” Make sure that every dependency is met.

  1. PHP (7.0 +)
  2. MariaDB (10.3 +)
    • MariaDB is an open source (RDBMS) which is a compatible drop-in replacement for the MySQL database. One of the main reason to use MariaDB is the support of Common Table Expression (CTE) using  “WITH” keyword (CTE allows to refer to a subquery expression many times in a query as if having a temporary table that only exists for the duration of a query ).
  3. Redis Server
    • Redis is an open-source in-memory database project implementing a distributed, in-memory key-value store with optional durability.  It can be used as a database, cache and message broker.
    • Redis supports different kinds of abstract data structures, such as strings, lists, sets, sorted sets, maps e.t.c. for further details visit these resources,
      • Official Redis website
      • To learn more about Redis, an excellent ebook “REDIS IN ACTION” is available for free which discusses Redis, right from its core concepts (data structure supported by Redis ) to more advanced concepts including a real-world example of how Redis helped to solve that specific problem.
  4. Plugins
  5. Monomyth Enterprise Theme
  6. Awesome Enterprise Apps
    • Site-skin App
      • This App is responsible for configuration of CSS framework “awesome-css.”  
    • Backend Design App
      • This App is responsible for registering styles and scripts used for specific look and feel of Enterprise Manage.
    • Contact App
      • This App is a “Starter Awesome Enterprise App” which is used to build our Enterprise Manage.

Note: For details regarding Awesome Enterprise Apps, please visit this URL.

  1. Awesome Enterprise Services 

“Awesome Enterprise Services” allows reuse of the business logic which is common across various Awesome Apps, other Services e.t.c. These services are imported into WordPress Installation using WordPress Importer (in XML format).

Screenshot 1: Awesome Enterprise Services.

Following services are used in this tutorial,

    • DB Services
      • Responsible for all DB related operations.
        • meta_query.
    • Form Control Services
      • Responsible for the rendering of form controls such as input type text, radio, select boxes e.t.c. Following modules from “Form control service”are used in the tutorial.  
        • date
        • text
        • section
        • select
    • UI Services
      • Responsible for all rendering of UI blocks such as Menus, UI Cards e.t.c.  
      • Notification Services
        • Used for sending is notifications using Emails or SMS.
    • Search Services
      • Responsible for handling search functionality along with actions taken on the returned dataset, such as display data as datatable or export data into CSV format. 
        • datatable
        • csv
        • fasttable
        • search-submit
        • handler-scripts
        • new_ticket
    • Single Services
      • Responsible for functionality needed for “Single view of Manage.” 
    • Common Services
      • Common Services has generic, site-specific code used in other Services, Apps e.t.c.
        • search_filters
  1. MariaDB View
    • Responsible for creating a view named as all_terms, so that WordPress tables wp_terms, wp_term_taxonomy, and wp_term_relationships tables are available as a single view to query.

Code snippet 1: “all_terms” View.

  1. CPT named as “contact” with Name as post_title, Title, Mobile No., Email, Address, Designation as meta fields, County, City, Industry as taxonomies. 

Building the Manage View

Let’s first have a glimpse of how “Enterprise Manage” looks.

Manage view

Screenshot 2: Manage View

Manage view can logically be divided into various sections, as shown in above screenshot 1.

  1. Top menu: This is where we define menu items.
  2. Filters and Search: Filtering options available on the data,
    1. Meta
    2. Taxonomy
    3. Period search (Search based on date.)
      1. Select Period
        1. Day / Days
        2. Month / Months
        3. Years
      2. Before Date
      3. After Date
    4. Search
      1. Exact Search
      2. Partial Search

Note: Besides the above options, filters and search on custom table or even a custom SQL filter query is supported by Enterprise Manage.

  1. Handlers: In what format the data is to be Handled is defined by Handlers or a better way to explain it is what to do with the filtered data, display it, export it e.t.c.
    1. Table (Display Data Table )
    2. Excel / CSV (Export)
    3. PDF (Download)
    4. Pie Chart
    5. Line Graph
    6. Bar Graph
  2. Filtered Data: Filtered Data displayed in Tabular format.

Until now we had a view of how “Enterprise Manage” looks, now let’s build it step by step.

Building “Manage” for “Contacts“ App

The best way to learn something new, (especially in the world of programming ) is to take a real-world example and use it as a vehicle for learning. So for this tutorial, Let’s say we want to “Manage List of Contacts.”  The “Manage” should be able to handle operations such as Edit, Update, Search and filter e.t.c. on the list of Contacts.

Step 1.1: Register Contacts CPT, with its meta fields & taxonomies

To store the data of contacts we are using a CPT named as “contact.” For simplicity purposes, we are assuming there is data available for us to manage (around 50 Contacts).

For registering CPT, we are using CPT UI, and for handling CPT’s meta, we are using ACF which are third-party plugins. So it is left to the reader to create the required custom post type, its meta, and taxonomies.

A contact has its metadata such as

  • Name: (CPT title)
  • Title (CPT meta)
  • Mobile No. (CPT meta)
  • Email (CPT meta)
  • Address (CPT meta)
  • Designation (CPT meta)
  • Industry (Taxonomy)
  • County (Taxonomy)
  • City (Taxonomy)

Note: For this tutorial purposes we are considering few Contacts fields as our focus is on learning how to build Enterprise Manage. Although we have a limited number of contacts fields, they are sufficient enough to explain how to build an Enterprise Manage and understand its working.

Step 1.2: Coding the Manage Part-1 Understanding args array of Manage.

To start with first create a module in the “Contact app” and name it as “manage.” Contact App is already created and available to us. A brief tutorial on how to create an Awesome Enterprise App is available here. Inside this module copy paste following code snippet,

Code snippet 2: “manage” module in Contact App.

As seen in the above code snippet, we have declared and initialized args array. This array of shortcodes which be logically divided into sections as follows,

  1. After Submit Section:

The first section (generally) is a “after submit” using [after_submit] shortcode, which defines a “with” query ( Basically MariaDB’s Common Table Expression [CTE] referenced later in subqueries ) using [with ] shortcode inside a [query] shortcode and which is the “main query” for required resultset.

Inside [with] shortcode, all Contacts with post status as published is queried. Following sub-code snippet, 2-1 depicts this.

Sub-Code snippet 2-1: “published_posts” of post_type “contact” main query.

Next, we use [filter] shortcode(s) to filter data on post meta title and all terms of taxonomies contact_city, contact_county, and contact_industry.

Exact & Generic search operations are available to search through contact data. These operations looks for data for searched keyword in Mobile no., Email, address and designation field of Contacts.

If required we can use the shortcode [add_field], if we want to order or group the selected data. Following sub-code snippet, 2-2 depicts this. 

Sub-Code snippet 2-2: Filters applied to main “With” query.

Next, we transform/ transpose the data from row-based format to column-based format to display it in a tabular format.  Following sub-code snippet, 2-3 depicts this.

Sub Code snippet 2-3: transform / transpose data returned from “With” query.

Transpose means,

 “cause (two or more things) to exchange places.” 

The format of data returned from With query is,

Screenshot 3: Data before transform

so when we use transform/ transpose shortcode, above rows are transformed into the following format,

Screenshot 4: Data after transform

The next step is to specify columns required for fetching data, displayed in a tabular structure (as shown in screenshot 2).

Sub-Code snippet 2-4: Fetch contact data.

We are fetching data using [meta_keys] and [ taxonomies] shortcodes, and inside [meta] shortcode, as seen in the above sub-code snippet 2-4.

Note: The query built for fetching data (such post meta, taxonomies, or even for data from the custom table ) has the following format.

Where,

type: is a string,  “data_id” and “meta.”

meta_key: Specifies the column name of the table from which the data is fetched. It could be following column names,

  • To fetch any column name of Enterprise meta table with Columns stamp, object_id, coll_id, coll_type, meta_key, meta_value
    • Use [aw2_collection_keys] shortcode
    • Sample generated query:
      • SELECT ‘some_type’ AS type, data_id , coll_id as meta_key, ‘some_column’ as meta_value
  • To fetch meta, ( meta_key column of from wp_postmeta WordPress table )
    • Use [meta_keys] shortcode
    • Sample generated query:
      • SELECT ‘some_type’ AS type, data_id , meta_key as meta_key, ‘some_column’ as meta_value
  • To fetch taxonomies column of  all_terms view
    • Use [taxonomy] shortcode
    • Sample generated query:
      • SELECT ‘some_type’ AS type, data_id, ‘taxonomy’ as meta_key, ‘some_column’ as meta_value

The final part of “After submit” section is [table] shortcode, is as depicted in sub-code snippet 2-5.

Sub-Code snippet 2-5: Display contact data.

[column] shortcode inside the [table] shortcode, the maps the [meta_keys] and [taxonomy] shortcode inside [meta] shortcode (as seen in sub-code snippet 2-5) and displays the data in a tabular format (thanks [transform] / [transpose] shortcode).

  1. Filters section:

Sections which are to be displayed for filtering data are listed here. Following sub-code snippet, 2-6 depicts this.

Sub-Code snippet 2-6: Filters Section.

  1. Handlers section:

This section is (generally) the last section of the main args array tells, what to do with the filtered data. Or in other words what action to take on the filtered data. Below code snippet depicts this,  

Sub-Code snippet 2-7: Handlers section.

We have following handlers options available,

  • [fasttable
    • Display specific no. of records quickly (In our case 100 set by max_count shortcode parameter of the fasttable) .
  • [datatable]
    • Display table with limit set by [pagesize] shortcode (in our case Limit is 10 records )
  • [csv], [excel]
    • Export data as CSV or  Excel.
  • [pie-chart], [line-graph], [bar-graph]:
    • Display charts and graphs of the filtered data.

The concludes the discussion sections of the args array. Next step is to consume this array for displaying search and filters, handling its form submission and viewing data based on it.

Step 1.3 Coding the Manage Part-2 Filters and Search functionality of Manage.

args array is passed as an argument to the main template of search module of Common Services,  in the manage module of the Contact app. Also, auto_handler (required) parameter of the main template is set to fasttable.

When the Manage home screen loads for the first time, an ajax request is made to display data by default. The auto_handler parameter depicts what action to take on data. Following code snippet, 2-8 depicts this,

Sub-Code snippet 2-8: “args” array & “auto_handler” parameter passed to “search_filters” module.

Next, create “search_filters” module under Common Services and copy paste following code snippet inside it.

Code snippet 3: “search_filters” module of Common Services.

The main functionality of search_filters module is to build the HTML view of filters such as title, city industry and county (as seen in screenshot 1) with its form submit actions such as fasttable, csv (download CSV) e.t.c.

To understand search_filters module (above code snippet 3), let’s divide it into sections so that we can digest it one at a time.

  1. Global module variables section:

This is the first section before the main template, defining variables for drop down options of Title, City, County, and Industry select boxes.

Variable declared outside any template of the module, can be accessed in all the templates making them global with respect to the current module.

Sub-Code snippet 3-1:”Global module variables” section of “search_filters” module of Common Services.

  1. Main template section:

The main template is called from manage module of the Contact App as depicted at last line of code snippet 2.

Sub Code snippet 3-2:”Main” template which displays Search and filters along with its action options.

The first thing we do in the Main template is to create a ticket from Search Services. Ticket generation is a concept used for form submission. It generates a masked URL, to which the form data is to be submitted by AJAX.

Pro Tip:  To directly call Services on a button click, Tickets are used.

Following code snippet depicts this,

Sub-Code snippet 3-3: Generate masked URL for Form submissions.

The next thing we do is that we render the filter section (as depicted screenshot 1).  We loop through sections set in the main args array and render individual filters using Form Control Services.

Inside the loop two templates render_filter_sections (to render sections) inside which render_filter_fields (to render individual filter field) are called.

Sub-Code snippet 3-4: Loop to display Search and Filters sections.

Form Controls Service handles the logic for building the HTML of the filter fields of types such as date, text and select e.t.c.

Next, in the search_filters main template, submit action of Form (with id as search_form) is bound to the button of class “js-submit-job.” Also, the form attribute route_ajax is set to ticket created by a new_ticket.

Sub-Code snippet 3-5: Bind Form submit action to a button and specify its route_ajax.

Once the form is bound, “handler-scripts” module of Search Services creates buttons (defined in [handlers] section of main args array) and bind its click event of various handlers such as fasttable, table e.t.c.

Sub-Code snippet 3-6: “auto_handler” parameter of “handler-scripts” search service.

“handler-scripts” module is also responsible for  auto submit of the search form for the first time on page load using the autohandler parameter of search_filters module of Common Services

This concludes the Building the Manage view section of this tutorial and we achieve the functionality as depicted in the screenshot 1.

Building Single view of Manage

Let’s first have a glimpse of how the Single view of Enterprise Manage looks.

“Single” view of Manage

 

Screenshot 3: Single View of Manage. 

The “Single view of Manage” is for viewing a single Contact data along with the functionality to Edit and Update it. Screenshot 3 depicts this.

Building Single view of Manage for “Contacts“ App

Step 1.4: Create “single” module in the Contacts app.

Create a module in the contacts app named as single and paste in following code snippet,

Code snippet 4: “single” module in the Contacts app.

As seen from the above code snippet, we get the query string parameter of the zeroth index qs.0 (which is basically, the post id of Contact CPT that we want to edit) set into single_data environment variable.

Next, we call a template “get_contact_data” of “crud-single-contact-data” module of Common Services which sets the contact data of the into a single_data. environment variable

This variable is then used by the “editable_personal_details” template of lead-block module and  display module of Single services. 

Step 1.5: Create “crud-single-contact-data” module in the Common Services.

Create a module in the Common Services named as “crud-single-contact-data”  and paste in following code snippet.

Code snippet 5: “crud-single-contact-data” module of Common Services.

crud-single-contact-data module’s template  “get_contact_data” gives sets the Contact data in  an environment variable called single_data.contact_data to view & edit it.

Further, this module also has a template which handles the update logic, when the edit form of Contact is submitted.

Step 1.6: Create a module named lead-block in the Common Services.

Create a new module called as lead-block under Common Services and copy paste the following code snippet,

Code snippet 6: “lead-block” module of Common Services.

As seen from above snippet, first we create an array named as single_data.blocks as an environment variable, containing a list of shortcodes, which handles the logic required for viewing, editing and updating Contact details.

Single view of contact is achieved by [action] shortcode as seen in sub -code snippet 6-1. This shortcode uses [ atts ] shortcode to create a section called “Basic Information” on the single view of manage (as seen in screenshot 3 ). [atts] shortcode accepts two arguments contact_post_id and meta_data. these arguments receive parameters from the single_data environment variable.

Sub-Code snippet 6-1: [atts] and [action] shortcodes in the lead-block module.

Lastly, edit form of Contact is created using [field] shortcodes with [edit_service] responsible for displaying the form and [update_service] shortcode responsible for  updating the Contact data after edit form submit. Below sub-code, snippet 6-2 depicts this.

Sub-Code snippet 6-2: Single Contact Edit and Update options in the “lead-block” module of Common Services.

That’s it for the Single view of Manage screen. We are now able to View, Edit and Update a Single Contact.

Final Notes

This tutorial was an attempt to explain about “How to build Enterprise Manage” using a fictitious example “Contacts App.” Even though the tutorial is lengthy, it scratches just the surface of “Enterprise Manage.”

To explain each & every concept along with its working in one tutorial is impossible. Definitely, in the near future, more documentation, explanation of core concepts, more supporting tutorials of Enterprise Manage will be planned.

 

Categories
Most Popular