MAE App Install

Commhub Configuration

Make sure commhub is not running (invoke tstop), then copy your commhub.ini to /usr/mae/conf/. Review the documentation for each MAE daemon you're using to determine what commhub.ini parameters to set.

For commhub spokes, declare a [spokes] section with hostnames and passphrases. Also, declare OS users allowed to access commhub in a [users] section with user names and comma separated list of allowed hosts.
For dbbroker, be sure to provide database type, name, server, user, password, and port.
For usergw, be sure to review HTTP port, server name, login page, access log, and first app upon login.
For userman, be sure to reivew the domain and allowed applications.
For supervisor, review the polling periods (in seconds).
For noticegw, specify your metavariables, e-mail command, instant messaging command, facebook command, and SMS.

Adding App Daemons to MAE Commhub

Create mgmttaskdb.csv file for each daemon (see tadd) and copy to /usr/mae/tasks.app/

Adding Database Tables

Create a table_tablename.sql for each DB table and copy to /usr/mae/db.app/.

Database Table Setup

After the tables are setup, you may want to initialize them. Or modify them from the defaults. Feel free to create scripts that end with .setup and install them in /usr/mae/db.app/. After tsetupdb runs, it will run any .setup scripts it finds. Upon successful completion (no error), it will rename the script to a .done file.

Database Documentation

Create your table field documentation in a file called propdoc.conf and copy it into /usr/mae/conf. Use this syntax:

tablename: Table description

tablename.fieldname: Field description

Multiple lines may be used to describe a table or field, but they must be preceded with their table name and/or field name as above.

After installing /usr/mae/conf/propdoc.conf, update the wiki documentation for MAE Database Architecture using

tstart dbbroker

makedbwiki -files /usr/mae > /usr/mae/html/doc/MAE_Database_Architecture.wiki

cd /usr/mae/html/doc && make

Augmenting MAE Documentation

Put your application-specific documentation in these files to integrate it into the MAE documentation.

MAE_Daemons_APP_DAEMONS.wiki - your application's supprt daemons (bulleted items)
MAE_Daemons_UI_APPS.wiki - your application's UI daemons (bulleted items)
msgbroker_APP_CHANNELS.wiki - your application's message channels (table rows)
MAE_Data_Types_APP_TYPES.wiki - your application's data types (a series of $include lines)
MAE_Utilities_UTIL_CHILDREN.wiki - your command line utility list (a series of $child lines)

Add your .wiki files to /usr/mae/html/doc/ and your image files into /usr/mae/html/images/.

You can convert all .wiki files into HTML files that can be served by usergw (as https://site/doc/filename) using

cd /usr/mae/html/doc

make

If you would like to create a site index or add a navbar to all the pages (both recommended), create a wiki2doc.ini configuration file and copy it to /usr/mae/html/doc during your install process.