Client Folder Structure

PxStat Application Client Side folders and code files list, includes configuration and examples.

The Root folder contains all files and folders that are needed to display an application on screen. They can be broken down to the following main files and folders:

root/

css
entity
js
template
config.json
config.json.live
config.json.test
config.json.uat
index.html
index.js
web.config

`index.html`

This is the entry page for the application. The file contains all necessary CSS and JavaScript resources as well as the HTML structure to display the Client Side of the Application.

`index.js`

This is required by the /index.html and it loads the following from the JQuery $(document).ready:.

Navigation Menu
Header
Footer
Spinner, Modals, alerts etc,
Default /entity/data

// Default entity on page load is the Data Page
  api.content.goTo("entity/data/", "#nav-link-data");

`config.json`

Contains default configuration parameters and constants.

Example:

Default System Language: language.iso.code

"language": {
		"iso": {
			"code": "en",
			"value": "English"
		}
	},

Default Date Display: mask.datatime.display

"mask": {
		"datatime": {
			"ajax": "YYYY-MM-DDTHH:mm:ss",
			"display": "DD/MM/YYYY HH:mm:ss",
			"file": "YYYYMMDDTHHMMss",
			"dateRangePicker": "DD/MM/YYYY HH:mm"
		}	
	},

Each Deployment environment have specific config.json file:

config.json.live
config.json.td
config.json.uat

Template Folder

The template folder /template contains code for the headers, footers, navigation, spinners and modals to be used by the application with the following structure.