Config.xml.php Explained

From OpenIndivo Documentation Wiki

The PHP User Interface is configured (mostly) with a single file, config.xml.php, found in the config/ subdirectory. It's a simple XML file -- the .php extension prevents it from being read through your website. Below is an explanation of each field, grouped by section.

Contents 1 Basic Fields 2 Paths 3 URLs 4 Registration 5 Invitation 6 Branding 7 Database

Basic Fields

debug

Occasionally, we include debugging output in the interface. Whenever possible, we try to show this output only when the debug value is TRUE. Thus, it's useful to leave this value as TRUE while developing, and to set it to FALSE in production systems. For more tips on making your deployment production-worthy, refer to Deploying a Production-Level UI Site.

Expected value: TRUE or FALSE

enableAccessRequest

Added in Indivo 3.2. Enables the access request feature in the sharing section.

Expected value: TRUE or FALSE

codingSystemServer

Added in Indivo 3.2. Allows the use of a coding system web service (e.g. one deployed locally from the /model/codes/webapp source code) other than the one hosted at indivo.org.

Expected value: http://indivo.org/codingsystems or location of another Indivo coding system web service.

Paths

siteroot

Absolute pathname to the website's root directory, with no trailing slash.

Example: /var/www/html

api

Absolute pathname to where you installed the Indivo PHP API's PingAPI.class.php file. This is the UI's only connection to the PHP API, on which the UI relies for all communication with the Indivo Server, all logging, and PHP/Java session handling.

Example: /usr/local/indivo-client-php-3.1/IndivoAPI.class.php

ttf

Absolute pathname to your ttf subdirectory, with no trailing slash. The user interface renders most of its header and menu text as images using a TrueType font. For some reason, PHP can't handle a relative path to the font file.

Example: /var/www/html/resources/ttf

URLs

site

The base URL to your user interface website, with no trailing slash.

Example: http://localhost

agentregistry

URL to a Subscription Agent Registry file which lists the subscription agents configured to interoperate with your particular Indivo server. If you have no subscription agents, you may leave this field blank.

Registration

iddomain

The domain to which all usernames will be limited. This is enforced on the login screen, when creating new users as an administrator, during invited self-enrollment, and in the sharing section.

Example: indivohealth.org

registrarid

Username of your registrar user. During self-enrollment, a pre-existing third-party user with "create record" permissions must perform the create action. For security's sake, we recommend creating a user of role "registrar" whose only server-enforced permission is to create records. (You must update the createPolicy.xml file in your Indivo Server deployment for this to work.) If you don't allow self-enrollment, or don't yet have a registrar user, you may leave this field blank.

registrarpassword

Password of your registrar user.

Invitation

When users wish to share their health data with others who don't yet have IndivoHealth accounts, users may invite them to join. These fields are used in building the invitation e-mail.

fromAddress

Return address to be used in server-generated invitation e-mails.

Example: no-reply@indivohealth.org

fromName

Name of organization/entity sending the invitation on behalf of the user.

Example: IndivoHealth at Children's Hospital Boston

subject

Subject line of invitation e-mail.

Example: Invitation to join IndivoHealth

Branding

Added in Indivo 3.2. When Indivo is integrated into another web site (e.g. a hospital portal) it may be branded with a third-party name and logo.

enabled

Enables branding features.

Expected Value: TRUE or FALSE

brandName

In places where the word "Indivo" would normally be used, this brand name will appear instead, e.g. "My General Hospital Record" rather than "My Indivo Record," and "General Hospital ID" instead of "Indivo ID."

Example: General Hospital

logoUrl

URL to a logo which will appear in the upper left of the Indivo viewer. Images should generally be no larger than 130px wide and 80px high, but this is left to the implementor's discretion. A "Powered by Indivo" logo will appear on the right side of the viewer's title bar.

Example: http://hostname.tld/logo.png

logoUrl

URL to a page the user should be sent upon logging out, if the standard Indivo log in page isn't appropriate.

Example: http://hostname.tld/home.html

Database

dsn

MySQL Data Source Name of your Indivo UI support database.

Example: mysql://username:password@database.server.org/indivoui

identity

Unique string description of your UI deployment. If you choose to use a single support database for multiple deployments of the UI, you can distinguish log files from each by supplying distinct identities.

Example: 'production', 'demo', 'development', etc.