Documentation

Funambol SyncML setup

Jukka Zitting — Mon, 03 Apr 2006 14:21:54 +0100

OpenPsa uses the Funambol SyncML server for synchronizing calendar and contact data with mobile devices.

The connector is still work in progress and doesn't work yet.

Download the stable Funambol server bundle (version 2.3, including Tomcat)
Install the server bundle by running the downloaded installer
Get OpenPsa connector file sync4j-openpsa-connector-0.1.s4j and copy it to server/modules
- note, the 0.1 version of the connector has hardcoded database settings of midgard for username, password and database name.
edit install.properties
- add sync4j-openpsa-connector-0.1 to the modules-to-install list
- configure the sync4j database (the OpenPSA connector supports only MySQL)
- For MySQL 4.1 (available for Debian stable at dotdeb.org)
  - Change the dbms line to mysql
  - Uncomment the mysql lines
  - Edit to fit, pay special attention to the path of the MySQL connector JAR
  - comment out the hypersonic jdbc lines near end of file, leave user and password which should be filled with the username and password to be used with the MySQL db of your choice
- Create the MySQL database and grant the user full privileges.
- edit the server-name property
stop the server that was started during installation
in BUNDLE_HOME/server (you must be there) run bin/install.sh tomcat
start server again (try restarting again if there are problems)
use the admin tool (you can use it to connect to remote server as well no need to be on local console) to verify the OpenPSA module is loaded.
configure your phone to use the syncml server default address is http://example.com:8080/sync4j/sync the server databases are "calendar" and "contacts"

Documentation

openpsa_admin — Mon, 03 Apr 2006 14:03:47 +0100

OpenPsa 1.x

Documentation for the current stable version.

Installation

Installation - Instructions on installing the OpenPSA package
Troubleshooting - How to resolve errors and problems

Configuration

Setup - Setting up and managing companies in OpenPsa
Support initialization - Setting up the Support helpdesk module
Sales data import - Importing external data into OpenPsa's CRM module
Project reports - Creating custom reports for project data
User management - Managing the organization structure and permissions

Usage

Login - Logging into OpenPsa
My Summary - Reporting hours, mileages and expenses
Projects - Managing projects, processes and tasks
Sales - Managing client contacts and sales projects

OpenPsa 2

Documentation for the upcoming next generation OpenPsa series.

OpenPsa 2 installation - Installing the new generation OpenPsa
OpenPsa 2 setup - Setting up a company into OpenPsa 2
Funambol SyncML setup - Getting OpenPsa synchronized with mobile devices

OpenPsa 2 installation

rambo — Wed, 25 Jan 2006 06:41:51 +0100

OpenPsa 2 is currently in preview state. It can be used for production setups, but some problems and errors may appear. Your mileage may wary. For critical setups, please install OpenPsa 1 instead.

Midgard installation

Install latest Midgard 1.7.3 or newer and set up a fresh database with datagard

Fix the broken repligard table:

alter table repligard add column author int(11) not null default 0;

MidCOM installation

Install latest CVS version of MidCOM

Import the SQL files from lib/midcom/config/mgdschema/sql/ into your MySQL:

# mysql midgard < midcom-head/lib/midcom/config/mgdschema/sql/midcom_dbobjects_full.sql

create file includes.xml to MIDGARD_PREFIX/share/midgard/schema

<?xml version="1.0" encoding="UTF-8"?>
<Schema xmlns="http://www.midgard-project.org/repligard/1.4">
<!--
    <include name="/full/path/to/schemafile" />
-->
</Schema>

Include the MidCOM components schemafiles, in MIDGARD_PREFIX/share/midgard/schema/includes.xml (inside ) add lines:

<include name="MIDGARD_PREFIX/share/midgard/midcom-head/lib/midcom/config/mgdschema/midcom_dbobjects.xml" />
<include name="MIDGARD_PREFIX/share/midgard/midcom-head/lib/net/nehmer/branchenbuch/config/mgdschema.xml" />
<include name="MIDGARD_PREFIX/share/midgard/midcom-head/lib/net/nehmer/jobmarket/config/mgdschema.xml" />
<include name="MIDGARD_PREFIX/share/midgard/midcom-head/lib/net/nehmer/mail/config/mgdschema.xml" />
<include name="MIDGARD_PREFIX/share/midgard/midcom-head/lib/net/nehmer/marketplace/config/mgdschema.xml" />

in your Apache virtualhost config for openpsa host add line:

MidgardSchema "MIDGARD_PREFIX/share/midgard/schema/includes.xml"

Install the MidCOM indexer

Switch your Virtual Host to use the correct MidCOM static directory

# ln -s  MIDGARD_PREFIX/share/midgard/midcom-head/static /var/lib/midgard/vhosts/YOUR_HOST_NAME/80/midcom-static

OpenPSA installation

Install the layout-openpsa.xml style file using datagard
Install the OpenPSA components
- best way to keep up to date is to make a CVS export of the OpenPSA source tree and symlink MIDCOM_ROOT/lib/org/openpsa to src/fs-midcom/openpsa directory of OpenPSA. For example:
```
# ln -s PATH_TO_OPENPSA_CHECKOUT/src/fs-midcom/openpsa/ MIDGARD_PREFIX/share/midgard/midcom-head/lib/org/openpsa
```

Import the SQL files (though not the _delete ones, they're for backtracking) from org.openpsa.core to your Midgard database. For example:

# mysql -f midgard < midcom-head/lib/org/openpsa/core/sql/org_openpsa_contacts.sql
# mysql -f midgard < midcom-head/lib/org/openpsa/core/sql/org_openpsa_calendar.sql
# mysql -f midgard < midcom-head/lib/org/openpsa/core/sql/org_openpsa_documents.sql
# mysql -f midgard < midcom-head/lib/org/openpsa/core/sql/org_openpsa_projects.sql
# mysql -f midgard < midcom-head/lib/org/openpsa/core/sql/org_openpsa_queries.sql
# mysql -f midgard < midcom-head/lib/org/openpsa/core/sql/org_openpsa_spammer.sql
# mysql -f midgard < midcom-head/lib/org/openpsa/core/sql/metadata_tmp.sql

Include OpenPSA schemafile, in MIDGARD_PREFIX/share/midgard/schema/includes.xml (again, inside ) add line:

<include name="MIDGARD_PREFIX/share/midgard/midcom-head/lib/org/openpsa/core/org_openpsa_mgschema.xml" />

After this you can proceed to OpenPsa 2 setup.

OpenPsa 2 setup

openpsa_admin — Tue, 27 Dec 2005 14:01:31 +0100

This document outlines how to set up required data structures for OpenPsa 2. You must have installed it first.

Note: OpenPsa 2 is currently in preview state. It can be used for production setups, but some problems and errors may appear. Your mileage may wary. For critical setups, please install OpenPsa 1 instead.

Create a new MidCOM site with the Midgard Site Wizard
- Select the OpenPSA v2 layout from the list
Using Spider Admin or similar administrative interface create root level group __org_openpsa in your sitegroup
Again in Spider create under group __org_openpsa group __contacts
Still in Spider create root level event __org_openpsa_calendar set owner as __org_openpsa
Set parameter midcom, require_valid_user, 1 to the root topic of the site
Set up subtopics for the OpenPSA components you're going to use
- You can also use regular MidCOM components side-by-side with OpenPSA
- The root topic should run the org.openpsa.mypage component

Support Message Tags

openpsa_admin — Thu, 22 Dec 2005 13:21:56 +0100

The following tags are substituted with the strings on the fly in Support messages where tagging is supported.

[GUID]: GUID of the ticket
[URL]: URL to the ticket
[TYPE]: Type label of the ticket
[OPENED]: Open (Create) time of the ticket
[STATUS]: Status of the ticket
[TARGET]: Name of the assignee
[TARGET]: Target label of the ticket
[DATETIME]: Current date and time
[PRIORITY]: Priority label of the ticket
[SEVERITY]: Severity label of the ticket

Email Tags

As above but only with email fields (SLA recipients for example)

[OPENER]: Email of the opener
[ASSIGNEE]: Email of the current assignee
[LASTPERSON]: Email of the last person to edit the ticket

Support assignation email template article

openpsa_admin — Thu, 22 Dec 2005 13:18:16 +0100

The fields used for Support assignation email template article are shown below to be used in Support initialization.

Article->name: AssignMailTemplate
Article->content: text, the template, supports tagging

Support Service Level Agreement articles

openpsa_admin — Thu, 22 Dec 2005 13:17:54 +0100

The fields used for Support Service Level Agreement article are shown below to be used in Support initialization.

Article->title: Title of the SLA, shown in the pull-down
Article->extra3: Ticket-type filtering, pipe (|) separated list of GUIDs to type articles, only visible when Ticket->type is among the listed.
Article->content: definitions, code to define the array $SLA_item, currently has the following keys. NOTE: Do not use PHP opening or closing tags.
- check_on_days: array, keys are days of the week, zero is sunday, six is saturday, values are TRUE or FALSE and determine if this SLA definition is active during those days.
- check_hours_start: int, determines the start of the timeframe (each day) during which this SLA definition is active.
- check_hours_end: int, determines the end of the timeframe (each day) during which this SLA definition is active.
- generic_timeout: int, how many seconds of general inactivity to allow before raising a notification.
- message_body: text, OPTIONAL, used to override the body of the default notification message, supports tagging (see below)
- message_subj: text, OPTIONAL, used to override the subject of the default notification message, supports tagging.
- recipients: array, OPTIONAL, keys are ignored, each value is an email address, supports email-tags (see below), default: array('','','')

Example

$SLA_item['check_on_days']=array(  
                            0 => FALSE, //Sunday  
                            1 => TRUE,  //monday  
                            2 => TRUE,  
                            3 => TRUE,  
                            4 => TRUE,  
                            5 => TRUE,  
                            6 => FALSE  //saturday  
                           );  
$SLA_item['check_hours_start']=8;  
$SLA_item['check_hours_end']=16;  
$SLA_item['generic_timeout']=7200; //2 hours  

$SLA_item['message_body']="foo\nbar \nyadayada...";  
$SLA_item['message_subj']="Notify for ";

Support Canned Answer articles

openpsa_admin — Thu, 22 Dec 2005 13:11:16 +0100

The fields used for Support Canned Answer article are shown below to be used in Support initialization.

Article->title: Title of the answer, shown in the pull-down.
Article->content: The answer text.
Article->extra1: Default note-type, sets the note-type to this (numeric) value when selected.
Article->extra3: Ticket-type filtering, pipe (|) separated list of GUIDs to type articles, only visible when Ticket->type is among the listed.

Support Access Control Lists

openpsa_admin — Thu, 22 Dec 2005 13:09:55 +0100

The parameters used for Support Access Control Lists are shown below to be used in Support initialization.

The ACL system checks person's Department, Group Memberships and Person object parameters to find the best (as in most access) value for each keyword in domain TechSupportACL. The parameters are of format Object->parameter('TechSupportACL', , );

create: Bool, can create new tickets. Will have multiple levels for simplified/full access.
modify_own: int, can edit "own" (user is creator or assignee) tickets. 1 means basic access,3 means full access (including closed tickets), 2 is not used at the moment.
modify_all: int, can edit other than "own" tickets. Same as above
view_details_own: Not used at the moment.
view_details_all: Not used at the moment.
view_list_own: Not used at the moment.
view_list_all: Bool, can view ticket listings.
view_preg: Int, can view this level of publicity.
view_reports: Bool, can view reports.

Support Publicity definition articles

openpsa_admin — Thu, 22 Dec 2005 13:06:00 +0100

The fields used for Support Publicity definition article are shown below to be used in Support initialization.

Article->title: string, label for the publicity value
Article->score: int, numerical value for the publicity, used for sortings
Article->extra3: int, minimum required ACL view_preq level to view tickets with this publicity value.

Support Target definition articles

openpsa_admin — Thu, 22 Dec 2005 13:04:43 +0100

The fields used for Support Target definition article are shown below to be used in Support initialization.

Article->title: string, label for the target, for example "OpenPSA"
Article->extra3: Ticket-type filtering, pipe (|) separated list of GUIDs to type articles, only visible when Ticket->type is among the listed.

Subtarget articles

Article->title: string, label for the target

Support Type definition articles

openpsa_admin — Thu, 22 Dec 2005 13:04:19 +0100

The fields used for Support Type definition article are shown below to be used in Support initialization.

Article->title: string, label for the type, for example "Change Request"
Article->extra1: string, override the From-field of notes sent as emails sent from this ticket to this value (to prevent exposing of personal email addresses of support persons and to allow single point of collection for the email-import)
Article->extra3: GUID, default SLA for tickets of this type, use GUID of SLA article

Sub-type articles

Article->title: string, label for the subtype

Support Configuration article

openpsa_admin — Thu, 22 Dec 2005 12:59:48 +0100

The fields used for Support configuration article are shown below to be used in Support initialization.

Article->name: Configuration
Article->content: configuration options, code to define certain keys of the array $techsupport, the following are commonly used. NOTE: Do not use PHP opening or closing tags.
- hidefields: array, keys are field names, set value to TRUE to hide the field from users, currently the following fields are hideable
  - priority: Hides to Priority field/column in editor and listings
  - severity: Hides to Severity field/column in editor and listings
  - fix_to: Hides to Fix To field/column in editor and listings
  - crmcompany: Hides the CRM Company mapping (feature is not yet implemented at all in the new ticket editor)
  - idstring: Hides the ID column in ticket listings (to save space)
  - noteType: Hides the note-type selector
  - targetOther: Hides the Other option from target selector (to force use of predefined targets only)
  - opened: Hides the opened time from lists
  - lastchanged: Hides the last action time from lists
  - street: hides street address from ticket editor
  - city: hides city from ticket editor
  - phone: hides phone from ticket editor
  - customer_id: hides customer id from ticket editor
  - customer_id2: hides the second customer id from ticket editor
  - email: Hides contact email address everywhere
  - email-cc: Hides CC email everywhere
  - listEmail: Hides contact email address from lists
  - feeling: hides feeling icons/selectors everywhere
  - listFeeling: hides feeling iconcs from lists
- webuser_name: Username of the user used for email import or website integration and breaking locks that have not been properly unlocked, thus needs Admin privileges.
- webuser_cname: Display name for the user above.
- webuser_pwd: Password for the user above.
- lock_timeout: Locks are valid for this many seconds, used to break locks that are not properly removed (due to whatever reason).
- confirmCustomerEmailSend: Displays a confirmation dialog before allows checking of the box "Send as email to contact".
- autoQuoteTicket: Automatically quotes ticket description when focus is brought to the note description field.
- timeformat: Format of datetimes in PHPs date() format, separate keys for tickets and notes: $techsupport[TT][timeformat] and $techsupport[TN][timeformat].
- logoutUrl: URL for logout procedure, used when integrating the support module to intranet for example.
- user_group_guid: GUID for group object to use as the users group, by default __Nemein.Net User. NOTE: Must have rights to the __TechSupport -topic.
- supervisor_group_guid: GUID for the group that acts as supervisors, DEPRECATED in favour of the ACL.
- searchSameWindow: bool, if this is set then when clicking on a row in search results it will be opened in the same window, to get back click search on the top menu and you will be taken back and the ticket is unlocked (the default behaviour of opening new windows leaves the ticket locked when window is closed)
- assignDontChangeStatus: bool, if this is set then the assign() method will not change the ticket status to "Assigned" unless it is "Unassigned" or "Closed".
- globalFromOverride: string, global value for overriding the sender address, to make sure the personal emails of support personnel are never revealed by accident (if type is undefined for example)
- assignFromOverride: bool, whether to override the sender address in assignation emails or not (auto-replies may not keep the ticket reference thus causing extra klutter to ticket list
- assignFromOverrideAddress: string, use always this address to override sender address when assigning, implies assignFromOverride.
- listTypeFilterMode: set to 'list' to do ticket type filtering in ticket list on UI level in stead of core, this has the advantage the the TTnotifyOpen can check across all types, however it also is a significant performance hit.
- reOpenStatus: set ticket status to this value when automatically reopening (when email import adds a not to closed ticket for example, defaults to 1 (Assigned).
- doNotAddHTMLBodies: set to true to prevent the email import from attaching HTML bodies of incoming messages to ticket/note
- TTnoteOrder: how notes are sorted in ticket editor 'opened' for FIFO 'reverse opened' for LIFO
- TTnoteListMode: set to 'thread' to automatically hide all but the latest note body in ticket editor, the +/- link hides/shows note bodies regardless of this setting.
- TTnotifyOfOpen: Show the amount of open tickets assigned to user or groups user is member of in the list view (if not all of them are shown on the list currently)
- pwdMgr: array, used for the password manager service (for email systems where password expiry is forced), key is username or __DEFAULT__, value is another array with the following keys:
  - mailto: string, where to sent notifications about expiry to
  - validity: int, time a password is valid, in seconds, set to 360024DAYS to get a good value
  - warning: int, time (again in seconds) to expiry after which standard notification emails will be sent every time the check is run (generally once a day)
  - panic: int, time (seconds) to expiry after which more urgent warning emails about imminent expiry are sent
  - lang: string, language code for emails
  - len: int, lenght of generated passwords

Example

$techsupport['pwdMgr']['__DEFAULT__']'mailto'="example@example.com";  
$techsupport['pwdMgr']['__DEFAULT__']'validity'=3600*24*42; //Password is valid 42 days  
$techsupport['pwdMgr']['__DEFAULT__']'warning'=3600*24*12; //start notifications 12 days b4 expiry  
$techsupport['pwdMgr']['__DEFAULT__']'panic'=3600*24*2; //start panic 2 days b4 expiry  
$techsupport['pwdMgr']['__DEFAULT__']'lang'='fi'; //Mails are in Finnish  
$techsupport['pwdMgr']['__DEFAULT__']'len'=8; //New passwords are 8 chars long

$techsupportlock_timeout=300; //5 minutes  
$techsupport[TT][timeformat]="d M Y G:i";  
$techsupport[TN][timeformat]="d M y G:i";  

$techsupportconfirmCustomerEmailSend=1;  
$techsupportautoQuoteTicket=1;  

$techsupport[hidefields][crmcompany]=1; //Field not implemented in editor yet  
$techsupport[hidefields][idstring]=1; //Save some space in the list

Support initialization

openpsa_admin — Thu, 22 Dec 2005 12:50:52 +0100

The Support module lacks initialization code in the OpenPSA Manager, you can initialize the module with the following procedure. Everything in Midgard should be done as Sitegroup Administrator.

Required operations

These are required for a working installation.

Create topic __TechSupport, this is where the tickets go, owner should be __Nemein.Net User
Create topic __TechSupport_Config, under this topic are all the configurations. Owner should be sitegroup-administrators.
Under __TechSupport_Config create article Configuration, content of this article is evaluated to set the configuration parameters
Under __TechSupport_Config create topic Type, this contains the ticket type definitions as articles, think through what types you wish to use, never delete any types after you have started using the module (or there will be inconsistencies)
Under __TechSupport_Config/Type create your type definitions as articles if you wish to use subtypes, create them as reply articles
Under __TechSupport_Config create topic Target, this contains the ticket target, again, think what targets (usually products) you wish to use, never delete any targets after you have started using the module (inconsistencies again)
Under __TechSupport_Config/Target create your target definitions as articles, version numbers should not be part of the target, use subtargets (reply-articles) instead
Under __TechSupport_Config create topic Priority, this is where priority labels go
Under __TechSupport_Config/Priority create priority labels (eg. Low, High) as articles, article title is used, use score to set the numeric value of each label (make sure not to have equal scores), the numeric values are used to order the priorities from lowest to highest
Under __TechSupport_Config create topic Severity, this is where severity labels go
Under __TechSupport_Config/Severity create severity labels (eg. Minor, Severe) as articles, these work exactly like priority labels
Under __TechSupport_Config create topic Publicity, here are your publicity labels
Under __TechSupport_Config/Publicity create publicity labels as articles, use score to set ordering (remember to make sure not to have equal score values)
Set up ACL (Access Control List) parameters for Groups/Departments/Persons per the ACL definition
Use cron (or similar service) and lynx(or similar text-only browser) to poll http://www.example.net/prefix/techsupport_ui/checks.html once a day, example command:

lynx --dump http://devel.openpsa.org/testing/techsupport_ui/checks.html

Optional operations

The following operations are optional, they're used to set up extra features.

Canned Answers

Under __TechSupport_Config create topic Canned Answers (notice the single space), this is used to hold your canned answers, you can edit and delete these at will.
Under __TechSupport_Config/Canned Answers create your canned answers as articles

SLA (Service Level Agreements)

Under __TechSupport_Config create topic SLA, this is where the SLA definitions go
Under __TechSupport_Config/SLA create SLAs as articles
Set the polling interval for http://www.example.net/prefix/techsupport_ui/checks.html to half of your shortest timeout

E-Mail import

Install fetchmail to the system
Edit supportmda.pl, change to URL to correspond to your OpenPsa host (remember the prefix if you use one), you need to create a separate copy for each different URL (for example when there are multiple sitegroups)
Configure .fetchmailrc for the mailbox(es) you wish to import
Use cron (or similar service) to periodically import the mails, remember to set fetchmail to use supportmda.pl as the local MDA, example command:
```
fetchmail -s -m ./supportmda.pl -u example -a mail.example.com
```
you need separate commands for each mailbox (or copy of supportmda.pl).

to run multiple fetchmails make a shell script to run each of the instances sequentially, fetchmail refuses to run if another instance is running, causing all kinds of trouble if you have multiple fetchmails in cron .

Check that the Type articles have extra3 set to make sure customer replies get to correct mailbox.

Assignation email template override

Under __TechSupport_Config create article AssignMailTemplate, the content of the article is the template for the assignation email

Configuration cache

Create root-level snippetdir OpenPSA_Cache if it doesn't exist yet, owner should be __Nemein.Net User
Under OpenPSA_Cache create snippet Support-Config

Creating custom reports

openpsa_admin — Mon, 24 Oct 2005 12:52:02 +0100

OpenPsa Projects uses a Midgard Style -based report engine.

All styles in the system with their names prefixed by __NNPREP_ will be displayed in the report selector.

Customizing the invoice template

Log into Spider Admin as system administrator (this must be done in Spider as Aegir doesn't allow editing of child styles that cross sitegroup boundaries)
Go to Styles and select the __NNPREP_Invoice (SG0) style
Click New Substyle
Name your style __NNPREP_Example Invoice (or something similar)
Create some elements to the child style to customize the basic invoice layout:
- <(logo)> containing HTML <img /> tag to the company's logo
- <(page_footer)> containing company's contact information in a HTML table
- <(css)> containing appropriate font settings
- See the -dist elements for examples

Setup

openpsa_admin — Mon, 24 Oct 2005 12:39:14 +0100

This section covers how to set up a new installation of OpenPSA and initialize it. Discussion with organization's top management should be done before starting the set up and initialization.

Initialization

The OpenPSA must be initialized before it can be taken into use. The OpenPSA comes with an initialization manager, called OpenPSA Manager. The OpenPSA Manager generates the basic structures for the system.

Creating a New Company

To access the OpenPSA manager direct your browser to http://localhost/openpsa_manager/ and use the system administrator account to log in (defaults to admin / password).
Fill the form fields in "Create a new Sitegroup" dialog and click "Create".

Initialization and Management of a Sitegroup

Select the company from the list on the left.
If you have generated a registration key, insert it into the reserved text area and click "Save".
Note: You can generate registration key at http://www.openpsa.org/testimonials/register/
Change the hostname in OpenPSA Core to suit your needs.
Note: The prefix field must be in format /prefix, i.e."/openpsa".
Initialize all required modules. _
Note: The OpenPSA modules can be initialized individually and only required modules should be initialized. If a module is uninitialized the statuses are shown with red background color while initialized and properly working module statuses are on green background._

Normally the initialization is required only once. However, if some modules are taken into use later on, or you decide to register your OpenPSA, they should be initialized with the OpenPSA Manager. It can also be used to track down possible module problems. Administrators can examine module statuses and thus pinpoint initialization related problems.

Setting up

During the setup, administrator creates company's department structure, creates users and defines access rights.

Creating departments

Go to "Personnel" module.
Select the root level department (defaults to Departments).
Click "Add Sub-Department"
Fill in the name for the department, i.e. "HR".
Select Manager and Approver from the pull-down menus.
Note: If you have not created users yet, there will be only the administrator account available.
Click "Create".
Repeat until done.

Note: A department is always created beneath the active department. If you create a department into wrong place, delete it and create a new one.

Creating User Accounts

Go to "Personnel" module.
Select a department from the list on the left.
Click "Add employee" button.
Fill in the fields and click "Save".
Repeat until done.

Note: By selecting a top level project the users access rights can be limited to a specific project. This is useful when granting access for external resources.

Installation

openpsa_admin — Sat, 22 Oct 2005 11:38:53 +0100

Dependencies

OpenPSA requires a working installation of the Midgard Framework.

There are two ways to install Midgard:

Install from distribution packages on platforms like Fedora, SuSE or Debian GNU/Linux
Download and install the source version

Installing OpenPSA

Once you have your Midgard system up and running, you are ready to install OpenPSA. OpenPSA is distributed as a Repligard package. The package needs to be installed to the root sitegroup (SG0) of a Midgard server.

Installing for Midgard 1.6.x or newer

Follow the Midgard package installation instructions.

Installing for Midgard 1.5.x

On most systems, this should be accomplished by running

# tar jxvf openpsa-1.9.0.tar.bz2  
# cd openpsa-1.9.0  
# repligard -a -i openpsa.xml.gz

If the above command fails, please consult Repligard usage documentation and check your Repligard configuration files.

Post-installation

After OpenPSA has been installed to your system it needs to be initialized using the OpenPSA Manager tool at
http://localhost/openpsa_manager/

If you are not accessing the server from console, you can move the OpenPSA Manager to another host by renaming the host in the Midgard database and modifying your midgard-data.conf accordingly. On Midgard 1.6.x or newer you can do this using the datagard tool.

Setting up OpenPSA

See the Setup section.

Troubleshooting

See the Troubleshooting section.

Sales

openpsa_admin — Thu, 14 Jul 2005 17:26:21 +0100

Sales includes a variety of applications such as "Companies", "Reports", "Sales Funnel", "Campaigns", "Import" and a search engine. The solution is integrated with Calendar- and Documents-module.

Search

The search engine is located in the left window.
From the pull-down menu you can choose a category to search companies: clients, partners, vendors, etc.
Note: You can define your own categories.
Below is a selection where you can choose to search companies, people or campaigns.
A word or a part of a word is enough to make a search.
Note: If you want to list all entries in the selected category type ** as the search
Click "Search" to make the search
Note: From the window you can also create a new company or a campaign.

Companies

Click "Create new company" to create a new company.Note: Company name is a mandatory field and it's an official name like Nemein Oy
Index name is for sorting the companies for the search engine. For example Nemein.Note: You can also add abbreviations that you want to be found in the search
Business area can be filled when choosing companies for campaigns.
Categories can be set for each client individually.
Note: Categories can be used as a search criteria.
Sales projects related to the company can be created by clicking "New opportunity" button. You can assign more than one sales project to each company.
Note: If there are more than 2 sales projects they can be found in a pull-down menu.

Summary

A sales project is typically created when a customer is activated.
Note: The information of a sales project is passed to the Calendar, Documents...
To create a sales project
- Name your sales project with a descriptive name
- Select a product from the list or multiple products by pressing CRTL
- You can write a short description in the "Notes"
- "Lead from" is an informative field: exhibition, campaign, agent...
- The status of a project controls the reports
- The percentage indicates the state of the project
- Select all the completed activities from "Status details"

Contacts

Click "Edit contacts" to add a contact
There are three fields you can choose a name from "From my company", "From our partner", From client", and by clicking "Save" the contact is saved in your contacts list.
Note: There can be more than one contact per a sales project
By clicking a link in the "Name" column you can edit the information of the chosen contact.
Note: For more information check "Personnel" in the "Sales" section of the manual.
By clicking a link in the "Company" column you can edit the information of the chosen company.
Note: For more information check "Companies->Create new company" in the "Sales section of the manual.

Activities

Activities are a central part of sales projects.
To create a new activity click "New activity"
- Name the activity with a descriptive title
- Fill in the date
- Assign a priority
- Select the type of the contact from the pull-down menu
- Add a description of the activity. For example: comments, questions, next steps,...
- Assign a person for the activity
  Note: The activity can be delegated to a colleague.
- Completed activities are removed from the list (check box)

Documents

You can save documents related to a sales project. For example: agreements, memos, presentations.
Click "New document" , fill in the fields and select an appropriate folder for the file.
Note: Folders are helpful when getting a file from the OpenPSA database.
Click "save" to save the file
Note: The file in OpenPSA database doesn't update automatically if you update the original file.

Personnel

Click "New person" to add a contact
Contacts are always attached to the current post
In the notes you can add some additional information about a person. For example: area of responsibility, hobbies...
Home address voluntary by default, however sometimes mail is wanted to the home address.
Note: If a person has a home address, it will be in the campaign instead of a work address.
Desicion maker is for describing a role of a person in the sales project. For example: economical buyer, enemy, technical buyer, supporter.
Note: Doesn't have an affect on the search.
A person can be assigned to a campaign from the bottom of the window. Select the appropriate campaign from the pull-down menu and press "Add".
Note: If you are creating a new person, save the basic information first.
Campaign history of a person can be viewed at the bottom of the window

Reports

Here you can build a filter to create a report for your needs.
Click "Create" to create the report.
Note: You can also download MS Excel (.csv) version of the report
The list of sales projects is in chronological order and by clicking a sales project you can get more information about it (Summary).
Sales stage indicates the the activity of a project. The amount of activities affects the propability (percent).
For more accurate processing you can select the "Report.csv" from the bottom of the window and open it in MS Excel.
Note: If the information doesn't fit in the columns by default you'll have to select column A...

Sales Funnel

Sales projects are all shown in the same screen sorted by percentage. A high percentage indicates that the project is almost done. If a project has a small percentage it means that the project is in early stage.
Note: Optimal graph looks like a funnel
The percentage on each level indicates the share of each sales project in the sales (euro)
Pcs is the amount of projects
From the top of the window you can select a time limit for creating a funnel for your needs.

Campaigns

To create a campaign click "Create new campaign" from the left window
- Fill in the name and the description
- Click "Save" to save the campaign
- From the top menu select: Sales->Campaigns
- Make a massive search for people you might want to add to your campaign
- From the list you can select the persons you want to be in your campaign
- Select a campaign and click "Add" to add the selected persons to the campaign.
  Note: Persons can be also added one by one from the contact registry.

Usage

openpsa_admin — Thu, 14 Jul 2005 17:24:08 +0100

This manual is designed for the end users of the OpenPSA application suite. By end users we mean any people who use OpenPSA, that includes also OpenPSA administrators. However, there is Setup section containing administrator-specific information.

Usage documentation areas:

Login - Logging into OpenPSA
My Summary - Hour reporting
Personnel - User management
Projects - Project management
Sales - Contact and sales project management

Projects

openpsa_admin — Thu, 14 Jul 2005 17:23:07 +0100

This is a tool for monitoring all of your projects and the progress of those projects. The central features are Schedule, Resources, Processes, Price list and Hours reporting.

New project

Click "Create a new project" to open a project editor.
Note: You should be a project manager.

Project details

Fill in the basic information "Title" , "Code" and "Description".
Note: The "Title" is shown in the reports.
The type of pricing can be described in the top level of the project by filling in these fields.
- No price
  Note: A reclamation, research and development,...
- Fixed price for task
  Note: The system calculates an average hourly price.
- Task's hourly price
- Resources hourly price
- Task's daily price
  Note: 0-4h = ½ days, 4-8h = 1day, 8-12h = 1½ days
Planned hours is an estimated amount of hours to complete a project.
Note: Planed vs. reported hours are shown in the hours reporting.

Schedule

Schedule affects the projects in the front page
Note: Only the projects that are active this week will be shown in the "week view".
You can define a start date and an end date to a project.
Note: The dates are selected from a pop up calendar which closes when you click outside of the calender
Must/can - start/end are voluntary fields
Note: Affects the Gantt alerts

Resources

Resources are bound to a projects from the organization.
Choose a project manager and resources. The project manager should also be in the resources.
Note: You can choose more than one resource by pressing CTRL.
Resources inherit to the sub projects
Note: You can remove resources from the sub projects.

Client

If you want to attach a client to a project, the system will fetch the needed information from the contact register.
You can search for client companies by clicking "Click here to choose a client"

Documents

Documents that need to be shared with resources can be attached to a project.
Note: Drawings, memos, presentations,...
To attach a document please create (Save) a Process/Project/Task first and select it again from the list.
Click "Attach a document" to attach a document to the project.
Shared documents can be opened from "My summary".
Note: Documents can also be found in the "Documents" component. The folder structure should be build so that the documents are sorted in a logical order (Sales, projects, R and D).

Summary

An easy way to monitor your projects, it shows a variety of useful information.
- code
- Timeframe
- Customer
- Manager
- Hrs
- Cost
- Price
- Avg price
The list can be sorted by "start date" or by "creation date".

Resources

Resources for different projects
- Projects are shown under a resource
- Resources can be opened and closed by clicking +/-
- Time scale can be used

Documentation

Funambol SyncML setup

Documentation

OpenPsa 1.x

Installation

Configuration

Usage

OpenPsa 2

OpenPsa 2 installation

Midgard installation

MidCOM installation

OpenPSA installation

OpenPsa 2 setup

Support Message Tags

Email Tags

Support assignation email template article

Support Service Level Agreement articles

Example

Support Canned Answer articles

Support Access Control Lists

Support Publicity definition articles

Support Target definition articles

Subtarget articles

Support Type definition articles

Sub-type articles

Support Configuration article

Example

Support initialization

Required operations

Optional operations

Canned Answers

SLA (Service Level Agreements)

E-Mail import

Assignation email template override

Configuration cache

Creating custom reports

Customizing the invoice template

Setup

Initialization

Creating a New Company

Initialization and Management of a Sitegroup

Setting up

Creating departments

Creating User Accounts

Setting up OpenPSA Support

Importing data into Sales

Creating custom reports

Installation

Dependencies

Installing OpenPSA

Installing for Midgard 1.6.x or newer

Installing for Midgard 1.5.x

Post-installation

Setting up OpenPSA

Troubleshooting

Sales

Search

Companies

Summary

Contacts

Activities

Documents

Personnel

Reports

Sales Funnel

Campaigns

Usage

Projects

New project

Project details

Schedule

Resources

Client

Documents

Summary

Resources