Issuu on Google+

AIMSlite Installation Guide 03 March 2006 v1.3


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Revision History Date 5 August 2005

Version v1.0

Description First release

Author G.McLachlan

8 February 2006

V1.1

Second release

G. McLachlan

8 February 2006

V1.2

Third release

G. McLachlan

3 March 2006

V1.3

Fourth release

G. McLachlan

Š Social Change Online Pty Ltd. 2005 This document is the Intellectual Property of Social Change Online Pty Ltd. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, nor made accessible in any information storage and retrieval system - without the express written permission of Social Change Online Pty Ltd.

�Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 2 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Contents

1

INTRODUCTION ................................................................................ 5

2

AIMSLITE INSTALL/CONFIGURE .................................................... 6 Requirements ........................................................................................ 6 Assumptions ......................................................................................... 6 1. Edit your site’s .siterc properties file .............................................. 7 Configurations:............................................................................................ 7 Testing .siterc properties.............................................................................10 2. Setup server environment.............................................................. 10 3. AIMSlite Install................................................................................. 11 Export Application from CVS.....................................................................11 Deploy & build property files .....................................................................11 Deploy AIMSlite moduleconfigs, workflow and default sections.xml .........11 Initialise DB sequence and message tables..................................................11 Generate/compile application and deploy compiled application ..................12 4. Start the remaining services .......................................................... 12 5. Deploy AIMSlite skin and data ....................................................... 12 Deploy initial skin and templates ................................................................12 Seed initial DB data....................................................................................12 Launch a web browser. ...................................................................... 13 Login to /maintain/ .....................................................................................13 AIMSlite management................................................................................14 Step 1: Manage skin and deploy templates form .........................................15 Step 2: Managing individual sections..........................................................18 Edit Section ................................................................................................18 Section edit form ........................................................................................19 Adding/editing sub-section/modules ...........................................................20 Add/edit sub-section/modules form.............................................................21 Step 3: Rebuild Sections .............................................................................22 7. Create the client’s details............................................................... 24 Create organisation .....................................................................................24 Client organisation details...........................................................................25 Edit default permission groups....................................................................26 Create the client’s user login details............................................................28 Clients login details ....................................................................................28 8. Branding .......................................................................................... 29 9. Test................................................................................................... 29

3

ADDING EXTRA MODULES TO AIMSLITE ....................................... 30

4

MISCELLANEOUS ADDED EXTRAS .................................................. 30

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 3 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

DOM Utilities........................................................................................ 30 Additional Apache Ant scripts ........................................................... 30 pg_dump via ant .........................................................................................30 PSQL insert ................................................................................................31

�Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 4 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

1 Introduction Purpose This document provides a detailed description of how to install and configure an AIMSlite website.

Scope All the AIMS4 product components that comprise the AIMSlite set are covered. Sufficient information is provided to guide development of a production AIMSlite website. This document does not cover setup of the serving environment, ie; Tomcat, Apache, JBOSS and PostgreSQL.

Audience The audience for this document includes: • Project Managers (project scoping, detailed configuration spec preparation) • Developers (website rollout) • Support personnel (maintenance and support, help desk queries)

Complementary reference documents Document

Purpose

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Location

Page 5 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

2 AIMSlite Install/Configure AIMSlite is made up out of the following repackaged AIMS4 components with the addition of 4 configuration and setup modules. The modules listed in italics are symlinked in the CVS repository to AIMS4 product: AIMSliteModuleListBean.xml, AIMSliteSectionsBean.xml, AIMSliteSectionsModulesBean.xml, AIMSliteSetupBean.xml, AttachedAdminRecipientsBean.xml, AttachedFeedbackFormsBean.xml, AttachedFilesBean.xml, AttachedMaillistsBean.xml, AttachedRecipientsBean.xml, BasicModuleBean.xml, BasicModuleBrowseBean.xml, BrandingBean.xml, ChildItemBean.xml, EditListBean.xml, FeaturesBean.xml, FormFeedbackBean.xml, FormFeedbackRequestBean.xml, FormSubscribeBean.xml, FormSubscribeRequestBean.xml, FragmentsBean.xml, GroupItemBean.xml, HelpBean.xml, InfoPagesBean.xml, ItemSortOrdertBean.xml, LinksBean.xml, MultiAttachmentsBean.xml, MultiRecipientsBean.xml, NewsBean.xml, NewsTypeBean.xml, NoticeBoardBean.xml, OrganisationBean.xml, RoleItemBean.xml, SectionsBean.xml, SiteFormsBean.xml, SitePagesBean.xml, SubscribeListBean.xml, SubscribeRecipientListBean.xml, TopicsBean.xml, UserItemBean.xml, UserItemRoleBean.xml, UserOrgGroupBean.xml AIMSlite has: 5 x Sections/Topics modules with optional News and/or InfoPages modules 1x News module 1 x InfoPages module – part of Section/Topic 1 x Noticeboard module 1 x Features module 1 x Home page Fragment module 1 x SitePages module 1 x Help module 1 x Email subscribe list – (independent of AIMS system)

Requirements • • • • • • •

Shell access. Sudo chmod on UNIX flavour systems (disabled on windows). A web browser (IE only for installed product. AIMSlite installation will work on most of the recent versions of major browsers). Apache ant 1.5+. Ability to setup Apache, Tomcat, JBOSS and postgreSQL. Ability to follow all the install steps listed in this document. Valid .siterc file.

Assumptions • • •

Deployment of AIMSlite hasn’t been tested on a Windows based machine. The .siterc properties definition file is critical to a successful AIMSlite installation taking special note that correct file paths are defined. AIMSlite ‘htdocs-pub’ is not a symlink of ‘htdocs’ in CVS or locally. Most files under htdocs-pub are deployed during installation. Any changes to ‘htdocs’ will need either an update to ‘htdocs-pub’ on the locally deployed site or a redeployment of the application.

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 6 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

1. Edit your site’s .siterc properties file NB: mysite = the directory from which your site is served. Open (mysite)/.siterc

Configurations: This .siterc definition is an extension of the standard AIMS4 .siterc properties file. ##### Site configurations id=666 site=aimslite sitebase=/var/www/${site} siteurl=${site}.socialchange.net.au ##### AIMSlITE properties skin=aimslite_layout1 #skin=aimslite_layout2 #skin=aimslite_layout3 printversion=yes rss=yes search_index=${site} section_id_start=12 section_id_end=23 ##### Organisation configurations org=AIMSLite orgname=AIMSLite contactname=Social Change Online streetaddress=248 Johnston St, Annandale NSW 2038 postaladdress=Locked Bag 199, Annandale NSW 2038 phone=+61 2 9692 5100 fax=+61 2 9692 5192 email=info@socialchange.net.au mailinglist_title=${org} Mailing List mailinglist_description=News mailing list for ${orgname} mailinglist=${site}-news mailinglist_server=list.socialchange.net.au adminmaillist=greg@socialchange.net.au protestEmailCC=greg@socialchange.net.au ##### Metadata publisher=${orgname} creator=${orgname} description=An AIMS lite site subject=AIMS, CMS, GIS, BIG ##### System configurations tomcat=tomcat3 tomcat_home=/var/tomcat/${tomcat} tomcat_connector=tom3 tomcat_username=tomcat apache=${site}.conf apache_home=/usr/local/apache dbhost=localhost dbname=aimslite dbuser=aimslite jboss_home=/usr/local/jboss jboss=jboss-${site} anthome=/usr/ant ant_exec=/usr/ant/bin/ant javahome=/usr/java/j2sdk1.4.2_02 java_home=/usr/java/j2sdk1.4.2_02 �Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 7 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

jnp=jnp://localhost:21${id}/ ip=10.10.1.20 username=pepelepew status=active

�Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 8 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Variable Site variables

Definition

Example values

id

The id should be unique. Check the uniqueness by viewing the file /etc/sites The id is primarily used to create unique port numbers for the application server. This value should be unique. By default, it is used to create other variable names etc. within the siterc. Typically this is the directory name of your virtual server, ie; site.socialchange.net.au or /var/www/site Path to your virtual server. The public URL of your site (omit http://). Typically on SCO development sites, the site url is made using the site value. You can hard code a value here if the construct doesn’t fit you purpose.

134

org orgname contactname streetaddress

The short name of the organisation. The long name of the organisation. The primary contact’s name. The street address of the organisation.

postaladdress

The postal address of the organisation.

KFC Kentucky Fried Chicken Colonial Sanders 1313 Mockingbird Lane, Mockingbird Heights, LA, 3541 PO Box 1313, Mockingbird Heights, LA, 3541 +61 2 9666 666

site

sitebase siteurl

aimslite-demo

/var/www/aimslite-demo www.kfc.com

Organisation details

phone

The phone number of the organisation. fax The fax number of the organisation. email The primary email of the organisation. Metadata (Used on home page – a temporary fix) publisher DC.Publisher creator DC.Creator description DC.Description

subject

DC.Subject

+61 2 9676 666 thecolonial@kfc.com

KFC The Colonial Deep fried southernstyle chicken coated in 11 secret herbs and spices. KFC, Kentucky Fried Chicken, The Colonial, Plump, Heart disease.

AIMSlite variables skin

This is the skin you wish to deploy. Choices are: aimslite_layout1, aimslite_layout2 or aimslite_layout3 Turns printversion functionality on or off. Turns rss functionality on or off.

printversion rss

aimslite_layout2

yes or no yes or no

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 9 of 31


AIMS-Lite Installation Guide search_index

section_id_start

section_id_end

v1.3, as at 3 March 2006

The name of the swish-e search index. See ‘http://lgsadev2:81/searchmaint’ interface for setting up search configurations. The sections record id start. Used for the sections workflow loop (This flakey approach will be replaced by the query DB processor to grab the number of sections and their ids?). If you are installing out of the box, set this to 12. The sections record id end. Used for the sections workflow loop. If you are installing out of the box, set this to 23.

aismlite-demo

The Tomcat you are using. Location where Tomcat is installed. The connector used so Apache and Tomcat can communicate. The name that Tomcat is started as. The name of your apache virtual conf. Location where Apache is installed. The host name of your database. The name of you DB. The username used to access your DB. The jboss server you are using. Location where jboss is installed. Location where the jdk is installed. The java naming provider. The ip address of the box the virtual server is running on. Location where ant is installed. Location of ant binaries. Your username for the box.

tomcat99 /var/tomcat/tomcat99 tom99

12

23

System variables tomcat tomcat_home tomcat_connector tomcat_username apache apache_home dbhost dbname dbuser jboss jboss_home javahome jnp ip ant_home ant_exec username

nobody aimslite-qat.conf /usr/local/apache localhost aimsliteqat aimsliteqat jboss-aimslite-qat /usr/local/jboss /usr/local/java jnp://localhost:134 10.10.1.158 /usr/local/ant /usr/local/ant/bin/ant p_hallas

Testing .siterc properties You can test to see if all the properties required to deploy AIMS Lite have been declared in the siterc properties file: After exporting a version from CVS (See Step 3 below), launch a shell: shell> cd (mysite)/deployer/aimslite shell> ant check-siterc

NB: This check will only test to see if the property is declared not if its correctly defined.

2. Setup server environment Set up Apache, Tomcat, JBOSS and PostgreSQL. Start Apache, don’t start Tomcat or JBOSS. ”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 10 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

3. AIMSlite Install Export Application from CVS You will require shell access to the cvs server and a basic understanding of cvs commands. Launch shell shell> cvs export –d project_name –r CURRENT_RELEASE products/aims4 NB: For the CURRENT_RELEASE, check with Terry V.

Deploy & build property files Requires the .siterc file to be configured – see step 1 for details of .siterc configurations Deploys these files using settings in .siterc: build/ant.properties generator/ant.properties generator/src/jndi.properties htdocs/WEB-INF/conf/auth.properties (also htdocs-pub/WEB-INF) htdocs/WEB-INF/conf/project.xml (also htdocs-pub/WEB-INF) htdocs/WEB-INF/conf/maillists.xml (also htdocs-pub/WEB-INF) htdocs/WEB-INF/conf/env.xml (also htdocs-pub/WEB-INF) htdocs/WEB-INF/conf/mod.xml (also htdocs-pub/WEB-INF) htdocs/WEB-INF/conf/sections.xml (also htdocs-pub/WEB-INF) htdocs/maintain/.htaccess Launch shell (You’ll need sudo chmod on UNIX flavour systems) shell> cd (mysite)/deployer/aimslite shell> ant deploy-properties

A word about deploy targets To see all ant targets, type: shell> cd (mysite)/deployer/aimslite; ant -projecthelp

Alternatively, to see help for deploy targets, type: shell> cd (mysite)/deployer/aimslite shell> ant help

Deploy AIMSlite moduleconfigs, workflow and default sections.xml This target copies the module and workflow configurations from the deployer/src/ directories to the top level config and workflow directories ready for building. It then expands the module configurations and supporting workflows and copies the resulting files to the WEBINF directory. Also builds the default sections.xml configuration file. Launch shell shell> cd (mysite)/deployer/aimslite shell> ant deploy-application

Initialise DB sequence and message tables This target creates the initial sequence and tables in the database required by the AIMS4 application. They are itembody_sequence, item_sequence, jms_messages and jms_transactions. Launch shell shell> cd (mysite)/deployer/aimslite ”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 11 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

shell> ant deploy-db

Generate/compile application and deploy compiled application This target compiles the core code used by AIMS4. It also compiles the deployed module configurations and packages the compiled code along with supporting code into a java archive file (.jar). The compiled application is deployed to the JBOSS application server. Launch shell shell> cd (mysite)/deployer/aimslite shell> ant deploy-generate

NB: You will need to run this twice as an error is thrown. This is in the AIMS4 product and occurs during the generation of mew2 – Javadoc error.

4. Start the remaining services Start JBOSS Start Tomcat Make sure you ‘tail’ the logs of both JBOSS and Tomcat when starting them - make sure no errors occur during start up. If you do have errors they have to be remedied before proceeding.

5. Deploy AIMSlite skin and data Deploy initial skin and templates The initial ‘skin’ is set in the .siterc file. Options are aimslite_layout1, aimslite_layout2 and aimslite_layout3. Other skins will be added when they become available. The ant target deploys all supporting page wrappers, indexes, fragments and templates for building these. Launch shell (You’ll need sudo chmod on UNIX flavour systems) shell> cd (mysite)/deployer/aimslite shell> ant deploy-skin

Seed initial DB data The initial data includes default AIMSlite setup configurations, default user permissions, groups and access roles (including superuser), default sections data, branding data, site pages, home page welcome fragment and a feedback form. Launch shell shell> cd (mysite)/deployer/aimslite shell> ant deploy-data

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 12 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

6. Configure skin, define sections and create user access Launch a web browser. Login to /maintain/

Click on the ‘Manage AIMSlite’ link. You will notice on this page that access to the managing content links aren’t available yet.

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 13 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

AIMSlite management

There are four steps to configuring AIMSlite via a browser. Step 1 is deploying the chosen skin and setting colours and fonts for that skin. Step 2 is managing the individual sections and their supporting modules within the site. Step 3 rebuilds all ssi page wrappers for all sections. Step 4 refreshes the runtime xml configurations in WEB-INF/config. Step 1: Click on link, ‘Manage skin and deploy templates’.

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 14 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Step 1: Manage skin and deploy templates form

Possible configurations (colours must be either hexadecimal or a CSS named colours): Site name Skin Fonts • Content font • Wrapper font Header/Banner • Banner bg colour • Image left bg colour • Image right bg colour • Banner dividing line colour • Banner strip bg colour Navigation box • Box top bg colour • Box bottom bg colour • Box dividing line colour • Navigation arrow • Level 1 nav off bg colour • Level 1 nav on bg colour • Level 2 nav bg colour • Navigation arrow, level 2 Subscribe box ”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 15 of 31


AIMS-Lite Installation Guide • • • •

Subscribe Subscribe Subscribe Subscribe

v1.3, as at 3 March 2006

title colour title box colour box border colour box bg colour

Footer strip • Footer bg colour • Footer links colour • Footer dividing pipe colour Welcome box • Welcome • Welcome • Welcome • Welcome

box box box box

title colour title bg colour border colour bg colour

Home box 2 • Home • Home • Home • Home

box box box box

2 2 2 2

title colour title bg colour border colour bg colour

Home box 3 • Home • Home • Home • Home

box box box box

3 3 3 3

title colour title bg colour border colour bg colour

Home box 4 • Home • Home • Home • Home

box box box box

4 4 4 4

title colour title bg colour border colour bg colour

Box 1 • • • •

(related links sidebar) Box 1 title colour Box 1 title bg colour Box 1 border colour Box 1 bg colour

Box 2 • • •

(related links sidebar) Box 2 title colour Box 2 title bg colour Box 2 border colour

Forms • • • • • • • • •

Form Form Form Form Form Form Form Form Form

1 bg colour 1 heading colour 2 bg colour 2 heading colour bg colour 3 3 heading colour 4 bg colour 4 heading colour label colour

Indexes • View by bg colour • View by border colour Headings ”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 16 of 31


AIMS-Lite Installation Guide • • • •

Heading Heading Heading Heading

1 2 3 4

v1.3, as at 3 March 2006

colour colour colour colour

This module deploys AIMS-lite templates, page furniture and builds the CSS stylesheets. Save document.

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 17 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Step 2: Managing individual sections Edit Section

Step 2: Click on ‘edit’ link next to the Section 1.

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 18 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Section edit form

Possible configurations: Variable Title Sort order Side bar include Section path Module type Order by Results/page Pagination group Sub-sections Related links sidebar heading Skip preview

Meaning Human-friendly name of the section. Order of section in menu and maintain list. Whether to include section name as sidebar links. Directory path where section index is saved to. (no funny characters or spaces!) The type of module of the section (limited choices). Field to order index listing by (limited choices). The number of results to list on the index. The number of items in a page group. Support modules (only used on Section/Topic model). The title displayed on related links sidebar for this section. Miss the boring bits. Skips the preview stage and goes straight to save.

NB: News and Section/Topics type modules will automatically have a Sections module associated with them which will allow for a section index to be created. �Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 19 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Site pages, help pages, noticeboard and features are compulsory sections. You should edit and change the status to published on these sections before rebuilding your ssi wrappers. Click ‘Next’ to preview and save the document.

Preview of the Section configuration. Click ‘Submit’ to save configuration.

Adding/editing sub-section/modules

To add a new module, click on the link ‘add new sub-section’. ”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 20 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Add/edit sub-section/modules form

Possible configurations: Variable Name/Title Sort order

Meaning Name of the sub-section Order of sub-section in sections.xml list and topic index The type of module of the section (limited choices) Field to order index listing by (limited choices) The number of results to list on the index The number of items in a page group

Module type Order by Results/page Pagination group

Save sub-section record.

�Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 21 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Click ‘Save’ to add sub-section to Section/Topic parent. NB: When editing an AIMSlite section, the displayed list of chosen attached modules in this popup window is not a representation of previously saved attached modules.

Step 3: Rebuild Sections

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 22 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Step 3: To rebuild all configured sections, click the link ‘rebuild ssi’s for all sections’. This will rebuild: Sections xml configuration file. Section indexes and select.jsp pages. Section ssi files. Maintain admin include files. Role item init sql. Fragments init sql. Sections init sql.

Step 4: To refresh you runtime xml configurations and update the sections, fragments and roleitems database tables, click on the link ‘refresh configurations’. This will rebuild: Refresh runtime xml configuration files. Sections, roleitems and fragments database tables. NB: If the database tables fail to update, check that ant is being called correctly. Check your siterc configurations, specifically: ant_exec, anthome and javahome. If this doesn’t work, launch a shell and execute ant from the command line. shell> (mysite)/init/aimslite/update_sections/ant shell> (mysite)/init/aimslite/update_roleitems/ant shell> (mysite)/init/aimslite/update_fragments/ant

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 23 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

7. Create the client’s details Create organisation Click on the ‘Manage organisations’ link to access the form for creating the client’s organisation details.

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 24 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Client organisation details

Click the ‘Add new organisation’ button.

Fill in the form and save the record. ”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 25 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Edit default permission groups As AIMSlite creates the various roles based on the section configurations, we need to define which roles are accessible by which group. There are 2 groups in AIMSlite: • ‘Superuser’ – which is the access-all-areas SCO user. • ‘Client’ – this group is for all clients and access is constrained.

Click on the ‘Manage permission groups’

Edit the Super user admin by clicking the ‘edit’ link.

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 26 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Click the ‘Select All’ button to give superuser access to all modules and actions. Save the changes. Edit the ‘Client’ user group. Don’t choose ‘Select All’ but rather selectively choose those access roles which are relevant to the ‘Client’ user. A ‘Client’ group shouldn’t have access to managing AIMSlite, Users, Organisations or Groups. Also limited access should be applied to Sections, Help files and Site Pages for the ‘Client’ group.

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 27 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Create the client’s user login details Click on the ‘Add new user’ link to access the form for creating the client’s login details.

Clients login details

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 28 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

Select the newly created organisation, fill the rest of the form in and save. You will need to re-edit this new record to attach a group to the user. Choose the ‘Client’ group for the clients login.

8. Branding Launch web browser. Login to /maintain/ Click on ‘Branding’ link. Upload client supplied images. Save record.

9. Test Don’t take anything for granted! Test client login. Test modules and sections. Test. Test. Test. Remember, AIMSlite is AIMS4 on a diet, so test!

”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 29 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

3 Adding extra modules to AIMSlite You can simply add modules to AIMSlite by placing any additional modules, workflows and admin GUI’s in the ‘custom’ directory. The custom directory is located at your site’s root. The directory structure of the additional files should be the same as they would appear under htdocs. When AIMSlite is deployed these files will be copied into the applicable space when needed during the process. Any new modules will need to be added to the modules list. This list is used during the configuration process. The lists are located at: htdocs/system/xmlvocab/modules.xml htdocs/system/xmlvocab/sub-modules.xml

4 Miscellaneous Added extras Various development tools come as part of an AIMS Lite install. These include: • JavaScript DOM utilities • Apache Ant scripts: o PSQL execute SQL command o Pg_dump o Build basic server configurations for JBOSS, Tomcat and Apache

DOM Utilities Having problems with containing your HTML divs or tables? Try the included JavaScript DOM utilities. They’re a helpful way of checking the structure of your X/HTML. You can turn on and off: • table borders • div borders • div id’s • show javascripts which are included via the ‘src’ attribute DOM utilities is included on every page. To turn on the various features, call these functions: <script type=”text/javascript”> showTables(); showScripts(); showDivBordersIds(); showDivBorders(); </script>

These open source scripts have been taken from Apple Developer Connection.

Additional Apache Ant scripts pg_dump via ant The pgDumpData target will dump a named table as a text file, in the form of an SQL insert statement - currently from PostgreSQL only - to a specified directory. shell> cd (mysite)/build shell> ant -f pgDumpData.xml ”Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 30 of 31


AIMS-Lite Installation Guide

v1.3, as at 3 March 2006

You will be prompted for a DB table name. Enter the name of the table you wish to dump. An SQL file will be written to (mysite)/init/aimslite/sql

PSQL insert The PSQL insertTableData target will execute the SQL statements in a named file. shell> cd (mysite)/build shell> ant -f insertTableData.xml

You will be prompted for a source SQL text file.

â&#x20AC;?Social Change Online, 2005 SCOMAIN:process:solution_delivery:aimslite:aimslite_install_guide_v1.2.doc, 3-Mar-06 11:40 AM

Page 31 of 31


Testing the software