
PowerTools Documentation: Index | DSP Interface
1 Elements in dsp.xml
dsp.xml is an XML document describing any global configuration parameters and the parameters that are required per DSP instance. dsp is the top level element in dsp.xml followed by dspDescription. dspDescription is the container element for all the elements as listed below.
1.1 shortname
Short name of DSP. eg. gallery, mediawiki
1.2 longname
Long name (few words). eg. "Gallery Photo Album Management System"
1.3 version
DSP Version.
1.4 url
URL pointing to the DSP home page.
1.5 type
DSP type. eg. Content Management System, Groupware, weblog
1.6 shortDescription
One line description about DSP.
1.7 dapiversion
DAPI Version to which the DSP conforms, currently 1.0 .
Change the dapiversion if user intervention is needed during the upgrade, or if the upgrade should be performed at the user's convenience (e.g. it will cause downtime).
1.8 dapirelease
The DSP release. This should be bumped for every release of DSP for given DSP version
Change the dapirelease if the upgrade does not require user intervention.
1.9 commonOptions
commonOptions specified in dsp.xml are responsible in rendering of options presented to SA in DSP install, upgrades or reconfigure.
1.9.1 name Attribute
commonOptions may have one of following values for attribute name.
- inschema
- The inschema attribute declares whether the value for this option should be stored in the database for a given DSPI.
- hidden
- The hidden attribute declares whether this option should appear in the form for configuring a DSPI. This may be used to set certain values for options that we expect to be sent back to the browser unchanged .
1.9.1.1 url_net_required
- Context: install reconfigure
- Hidden: No
- Specifying this option in dsp.xml instructs the browser to display a set of DSP URLs that the Site Administrator can choose from. The DSP URL could be
- domain/subdomain
- home directory of any site user.
1.9.1.2 url_net
- Context: install reconfigure
- This is same as url_net_required but gives the Site Administrator additional choice to enter a path which is exposed via the Web server(/var/www).
1.9.1.3 url_path
- Context: install reconfigure
- Provides the Site Administrator with choices to select the DSP installation path.
1.9.1.4 url_path_required
- Context: install reconfigure
- Same as url_path but does not support /var/www/ paths.
1.9.1.5 url_loc
- Context: install reconfigure
- Hidden: Yes Inschema: Yes
- Complete the HTTP URL to the DSP publishing point.
1.9.1.6 install_loc
- Context: install reconfigure
- Hidden: Yes Inschema: Yes
- The file system path to the DSP Install directory.
1.9.1.7 domain_to_path
- Context: install
- Hidden: Yes
- The array that holds the mapping of the DSP HTTP URL to the DSP file system path.
1.9.1.8 dbname
- Context: install
- Inschema: Yes
- This option lets SA specify the MySQL database name required for the DSP.
1.9.1.9 dbpass
- Context: install
- This option lets SA specify the MySQL password required to access MySQL. dbpass requires dbname.
1.9.1.10 username
- Context: install reconfigure
- This would enable SA to select the Site user who will own the DSP file.
1.9.1.11 syncfs
- Context: reconfigure
- This enables SA to recover missing tool files during the reconfiguration. SA can view this option("recover missing tool files") if he clicks on the "Reconfigure Installation" button of an already deployed DSP instance.
1.9.1.12 overwritefiles
- Context: reconfigure
- Enables the control panel to display the "Overwrite existing files" checkbox during reconfiguration as an option to "recover missing tool files(syncfs)". This requires syncfs.
1.9.1.13 archive_name
- Context: install
- Hidden: Yes
- This option assumes the name of the DSP archive as 'file' attribute. This needs to be specified by the script package maintainer.
- For example,
<commonOption name="archive_name" file="gallery-1.4.1-pl1.tar.gz"/>
1.9.1.14 archive_type
- Context: install
- Hidden: Yes Inschema: Yes
- The type of the DSP archive. This need to be specified by the script package maintainer.
- For example,
<commonOption name="archive_type" type="tar.gz"/>
1.9.1.15 license
- Context: install
- This directive enables the DSP License Agreement to be presented to SA at the time of DSP installation.
- eg.
<commonOption name="license"> license text goes here .... </commonOption>
1.9.1.16 accept_lic
- Context: install
- Renders following options as radio buttons to allow SA to accept/deny license agreement.
- Yes, I accept the terms and conditions of this license.
- No.
1.9.1.17 instance_admin
- Context: install
- Enables SA to enter the admin username for DSP administration. This is the DSP user that logs onto the DSP admin interface. Instance admin is not a site user. Tools like gallery, phpBB and most of CMSs require this.
1.9.1.18 instance_admin_name
- Context: install
- Full name of tool administrator.
1.9.1.19 instance_pass1
- Context: install
- Password of tool administrator.
1.9.1.20 instance_pass2
- Context: install
- Confirm password of tool administrator.
1.9.1.21 instance_admin_email
- Context: install
- Email address of tool administrator. If required for DSP installation.
1.9.1.22 applypatches
- Applies the patches specified in include.mk.
1.9.1.23 do_backup
- Context: upgrade
- If included, the upgrade process will first back up the data before proceeding with the upgrade.
1.9.1.24 backup_loc
- Context: upgrade
- This option lets SA specify an absolute path to the location where the backup files should be saved. The path should end with a filename prefix, which will be used to generate the names of the backup files. For example, if you enter /tmp/backup in this field, then the backup process may create files like /tmp/backup_files.tgz and /tmp/backup_db.tgz. Note that these files must be removed manually.
1.9.1.25 backup_files
- Context: upgrade
- Renders the textbox for SA to specify the directories in the tool's installation directory to be backed up.
1.9.1.26 backup_db
- Context: upgrade
- Allows back up of the tool's (MySQL) database.
1.9.1.27 backup_dbpass
- Context: upgrade
- Password to connect to the tool's MySQL database.