Versions Compared

Old Version 3

changes.mady.by.user Unknown User (ifi-heather.savino@ificlaims.com)

Saved on

compared with

New Version 4

changes.mady.by.user Unknown User (ifi-heather.savino@ificlaims.com)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Note

On-site installations that install of CDWS have a very limited set of services available, namely /text and, and if the optional SOLR index is installed, /search. All other service interfaces must be called remotely to https://cdws.ificlaims.com. Please contact support@ificlaims.com for further details.

...

Hardware Requirements

RequirementRecommended
CPU2-cores
System Memory4GB
System Storage100GB

Software

Software Requirements

RequirementRecommendedNotes
Apache httpdDistribution version
yum|dnf install httpd
Perl ModulesDistribution version
yum|dnf install \
  # overkill, but saves an incredible amount of time
  perl-open \
  perl-Catalyst* \
  perl-Module-Install \
  perl-DBD-Pg \
  perl-XML-LibXML \
  perl-XML-LibXSLT \
  perl-CPAN
CLAIMS Direct LibraryLatest VersionContact support@ificlaims.com for link to latest version
CLAIMS Direct CDWSLatest VersionContact support@ificlaims.com for link to latest version

...

It is recommended to install CLAIMS Direct software into /opt/fv using the INSTALL_BASE argument to Makefile.PL, e.g.,:

Code Block
perl Makefile.PL INSTALL_BASE=/opt/fv --alldeps

...

Assuming requirements have been installed, including Alexandria::Library, CDWS is installed again in typical perl Perl module fashion.

Code Block
wget http://alexandria.fairviewresearch.com/software/Alexandria-CDWS-x.x.tar.gz
tar zxvf Alexandria-CDWS-x.x.tar.gz
cd Alexandria-CDWS-x.x
perl Makefile.PL INSTALL_BASE=/opt/fv --alldeps
make
sudo make install

Configuration

...

The main configuration files for CDWS will reside in /opt/fv/lib/perl5/Alexandria/CDWS and are:

  • alexandria-cdws-apache.conf
    The virtual host definition. Here you can change the Port httpd listens on for the CDWS application application.
  • alexandria-cdws.conf
    The main application configuration file.

The main configuration file ( alexandria-cdws.conf)  is is broken into the following sections:

  • Global parametersParameters
  • Authentication Plugins
  • Database Models

...

Authentication Plugins

The Plugins plugins section contains the directives for authentication. As this uses database model definitions appearing later in the file, this directive should not be modified.

...

The following table lists the Database Models database models defined, along with their function. Italic rows are not available with on-site installations:

...

Database ModelVariablesFunctionNotes
Model::DBIx::ConnectorNonenoneMain PostgreSQL Interfaceinterface 
Model::CustomhostInterface into the reporting databaseThis interface enables CSV reporting. This reporting module is superseded by Model::Report defined below.
Model::WebhostDeprecated (was earlier web sessions interface) 
Model::UsershostInterface into the users database supporting the Authentication authentication plugin 
Model::Reporthost
solrurl
storage 		Interface into the users databaseThis interface supports v2.x reporting for both XML and CSV. To use this interface effectively, the optional SOLR component must be installed locally.
Model::SessionhostInterface into the users databaseThis interface supports the Sessions web services (experimental)
Model::DWH::Standard
Model::DWH::Premium
Model::DWH::Premium::Plus 		hostInterface into the main alexandria XML data warehouseThis interface supports a variety of web services, including /text
Model::Attachments Interface into the attachments databaseUnavailable with on-site installations
Model::Inventory Interface into the raw data warehouseUnavailable with on-site installations
Model::MSSQL Interface into the level I data warehouseUnavailable with on-site installations
Model::Solr::Standard
Model::Solr::Premium
Model::Solr::Premium::Plus 		base
server
collection
params 		Main interfaces into the SOLR indexAvailable only with optional SOLR installation
Model::Solr::Attachments Interface into attachments indexUnavailable with on-site installations
Model::Solr::PITR Interface into PITR reporting indexUnavailable with on-site installations
Model::Zabbix Interface into systems monitoringUnavailable with on-site installations

Apache httpd Integration

alexandria-cdws-apache.conf

...

Installation

To enable CDWS to run under httpd, the virtual host definition file alexandria-cdws-apache.conf must be either copied or linked into /etc/httpd/conf.d

Code Block
# link (recommended)
cd /etc/httpd/conf.d && ln -s /opt/fv/lib/perl5/Alexandria/CDWS/alexandria-cdws-apache.conf z01.conf
# or copy
sudo cp /opt/fv/lib/perl5/Alexandria/CDWS/alexandria-cdws-apache.conf /etc/httpd/conf.d/z01.conf

Apache httpd Directory

...

Permissions

Depending on distribution, you may also need to adjust the permissions to the root Directory in  in httpd.conf

Code Block
<Directory />
    AllowOverride none
    Require all granted
</Directory>

Enable, Start, and Stop httpd

Code Block
sudo systemctl enable httpd.service
sudo systemctl start httpd.service
# stop
# sudo systemctl stop httpd.service 

...