Creating a Custom User Interface (CUI) Implementation

Overview

This use case provides information about customizing the user interface for the AgileApps platform UI. A custom user interface (CUI) implementation changes the overall look and feel of the layout of the runtime UI of the platform.

For information on creating a basic CUI, see Creating a Simple Custom User Interface (CUI). This section provides details on creating an advanced CUI.

Actors

UI designers use the CUI to create their own runtime experience with the help of HTML, CSS, and JavaScript. They can also include Smart UI components from the available library. For information on Smart Components, see Smart Components for AgileApps.

Before You Begin

1. Have the knowledge of HTML, CSS, and JavaScript.

2. Have an understanding of the file and directory structure for a CUI.

3. Have a basic understanding of the AgileApps platform UI.

4. Installed GitHub.

Creating a CUI Implementation

A new CUI implementation involves the following steps:

1. Creating the CUI

2. [[#Packaging the CUI|Packaging the CUI]

3. Deploying the CUI

Creating the CUI

1. Create a directory and git clone the boiler template from GitHub as follows:

/* Clone from git repository using git bash */
git clone https://github.com/agileapps-dev-com/agileapps-cui.git

2. Configure the webpack development server as follows:

a. Go to agileapps-cui directory and open the webpack.config.js file in Notepad or any other text editor.

b. Update the target value into your agileapps instance path. An example is as follows:

3. Install any package dependencies. In the following example, we are installing development setup dependencies:

4. Start the development server by accessing the URL at https://localhost:8054/simple/index.html where localhost is your machine name.

5. Modify the content in ~/agileapps-cui/src/simple. You can create more CSS, HTML, and JavaScript files as per your requirement. However, ensure to adhere to the recommended file structure guideline as shown here:

Note: The CUI directory should have an index.html file as the entry file. Other files are optional.

Packaging the CUI

After you create the CUI, you have to package it for deployment. Archive the CUI you create by running the following command: npm run archive simple

Note: simple is the directory name in ~agileapps-cui/src

If you change the directory name or create a new directory, use that value instead of simple. The package will be available in ~/agileapps-cui/dist/ directory. After you finish packaging, next you have to deploy the package.

Deploying the CUI

To deploy the CUI, you need to meet the following prerequisites:

1. You should have file system access to the AgileApps instance.

2. The packaged CUI archive file should be available.

Deploy as a WAR/webapp File

Currently, the CUI supports only the direct deployment to the webapps directory. Perform the following actions:

1. Shut down the AgileApps instance.

2. Extract the packaged.zip file. For example, simple.zip into the webapps directory as a sibling to networking in the agileapps installation directory.

3. Start the agileApps instance.

4. Access the CUI using https://agileappsinstancename/simple/index.html where agileappsinstancename is your AgileApps instance.