Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 35

Table of Contents

Panel
titleRelated Pages

For step-by-step instructions, see the Client Tools Installation Instructions.

Hardware Requirements

test

CPU2-cores4-cores
System Memory8GB16GB
Storage Capacity500GB (100GB SSD for fast temporary processing space)1TB
RequirementRecommended
Non-Solr and Solr Installation Type 2
Solr Installation Type 3

 Software Requirements

Operating SystemRHEL 7, Fedora 25-27, CentOS 7/Rocky 8, Amazon Linux AMIIf you are using Fedora, you must use version 27 or below. Installing Fedora v28 and above will install a version of PostgreSQL that is incompatible with CLAIMS Direct2We do not support Ubuntu or any operating system not explicitly listed.
IFI CLAIMS Repository
RHEL/CentOS 7
# Amazon Linux 2
sudo yum -y install \
https https://repo.ificlaims.com/ifi-claims-direct/centosamzn2/7/x86_64/ifi-claims-direct-beta-01.0.2-1.el7.centosamzn2.x86_64.rpmAmazon Linux

sudo amazon-linux-extras install epel -y

# RHEL / CentOS 7
sudo yum -y install \
 https://repo.ificlaims.com/ifi-claims-direct/centos/amazon7/x86_64/ifi-claims-direct-beta-01.0.2-1.amzn1el7.x86_64.rpm Fedora
yum

# RHEL / Rocky 8
sudo dnf -y install \
  https://repo.ificlaims.com/ifi-claims-direct/fedorarocky/278/x86_64/ifi-claims-direct-beta-01.0.2-1.fc27el8.x86_64.rpm

sudo dnf -y install epel-release
sudo dnf config-manager --set-enabled powertools
sudo dnf clean all


Requirement
Minimum Version
Notes

CLAIMS Direct Software Installation

Using the

Claims

CLAIMS Direct Repository

IFI CLAIMS provides yum software repositories to make installation simple. Currently, CentOS 7 and Fedora 25 are covered but we are always expanding the distributions covered.

First, install the necessary repository configuration files:

# CentOS 7 needs an additional repository yum -y install epel-release # To install the epel repository in RHEL yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-$(rpm -E '%{rhel}').noarch.rpm
Code Block
languagetext
bash
# See full URLs above
sudo yum -y install 
  https://repo.ificlaims.com/ifi-alexandria/<distribution>/ifi-claims-direct...

Next, update the system:

Code Block
languagetextbash
sudo yum -y update libxml2   # this update should pull libxml2 from our repository

Finally, install the Alexandria::Client::Tools:

Code Block
languagebash
sudo yum -y install perl-Alexandria-Client-Tools   # will pull inLibrary
sudo yum -y install perl-Alexandria-Library 

Manual Module Installation (Not Recommended)

CLAIMS Direct software is a collection of Perl modules that interact with both the alexandria database and SOLR index to facilitate database updates from the primary server. Although not a requirement, it is highly recommended that a working cpan repository be enabled for automatic dependency resolution.

Code Block
languagetext
Enter the cpan configuration utility:
 
cpan
 
Would you like to configure as much as possible automatically? [yes] yes <==
 
What approach do you want?  (Choose 'local::lib', 'sudo' or 'manual')
 [local::lib] sudo <==
 
Would you like me to automatically choose some CPAN mirror
sites for you? (This means connecting to the Internet) [yes] yes <==
 
cpan[1]> exit

Download the Client Library and Tools Packages

Please contact support@ificlaims.com for the newest available versions.

Installing the Client Library

Code Block
languagetext
tar zxvf Alexandria-Library-x.x.tar.gz
cd Alexandria-Library-x.x
perl Makefile.PL --alldeps
make
# NOTE: if, during the course of dependency resolution, you are prompted to accept an install, please accept (yes|y)
make test
# last line of output should be
#    Result: PASS
make install

Custom Configuration

The CLAIMS Direct software requires a main configuration file named "alexandria.xml" and "alexandria-log.conf". Default files are available under /usr/local/share/perl5/Alexandria/resources/. These should be positioned globally so all tools have access.

Code Block
cp /usr/local/share/perl5/Alexandria/resources/*.* /etc

It is unnecessary to edit /etc/alexandria.xml, but feel free to customize logging (/etc/alexandria-log.conf). See http://search.cpan.org/~mschilli/Log-Log4perl-1.42/lib/Log/Log4perl.pm#Configuration_files

Installing Client Tools

Code Block
languagetext
tar zxvf Alexandria-Client-Tools-x.x.tar.gz
cd Alexandria-Client-Tools-x.x
perl Makefile.PL --alldeps
make
# NOTE: if, during the course of dependency resolution, you are prompted to accept an install, please accept (yes|y)
make test
# last line of output should be
#    Result: PASS
make install-Client-Tools

Client Tools Configuration

Necessary Information for Configuration

In order to make installation as seamless as possible, have the following information available for initial configuration:

  • CLAIMS Direct user name and password as provided by IFI CLAIMS client services
  • The IP address or host name of the server housing the CLAIMS Direct PostgreSQL data warehouse
  • (Optional) The IP address or host name of the server housing the CLAIMS Direct Solr index
  • Root access to machine that will house these Client Tools

Main Configuration

The configuration file /etc/alexandria.xml is used by all utilities and services and contains the PostgreSQL data warehouse and Solr index configuration entries. For stand-alone installations, default values are sufficient but for Type-2 or Type-3 installations, the following modifications are required:

KeyDescription

/databases/database/
  @name
  @dbname
  @host
  @port
  @user
  @password

These entries configure the database name (dbname), location (host), port and credentials (userpassword) used by the utilities and services to communicate with the CLAIMS Direct PostgreSQL data warehouse. In a typical Type-2 or Type-3 installation, only @host needs to be modified. If you have set up a different PostgreSQL authentication user (with optional password), the user and password attributes need to reflect the credentials used to communicate with PostgreSQL.

The name attribute is the identifier and is the default argument in all tools requiring a --pgdbname parameter. This will not need modification.

/index/
  @name
  @base

This is the location of the CLAIMS Direct Solr index. It is the full URL to the installation, including the context. Typically, you will only need to modify the IP address. Port and path defaults need no modifications.

Similar to above, the name attribute is the identifier and is the default argument in all tools requiring a --solrdbname parameter. Again, this will not need modification.

Client Update and Indexing Service Configuration

Client Updates

The configuration file /etc/alexandria/apgupd.conf controls the parameters used to maintain the CLAIMS Direct PostgreSQL data warehouse. These parameters are used by the apgupd service.

Configuration Parameterapgupd ArgumentDefault ValueDescription
CD_PGDBNAME--pgdbname alexandriaThis controls which database configuration the update service uses. This entry corresponds to the default /database/@name attribute value in /etc/alexandria.xml. 
CD_USER--user testThe user name provided to you by client services. The default will fail.
CD_PASSWORD--password testThe password provided to you by client services. The default will fail.
CD_INTERVAL--interval 5The interval, in seconds, between probes for new updates.
CD_TMP--tmp /tmpThe default processing directory for intermediate files downloaded by the apgupd service.
CD_OTHER_OPTIONS
''

Add lesser-used arguments here. See /etc/alexandria/apgupd.conf for examples.

--api

To maintain the supplemental tables required for on-site family and citation functionality, add --api, e.g., CD_OTHER_OPTIONS='--api'

Client Indexing

The configuration file /etc/alexandria/aidxd.conf controls parameters used to maintain the optional CLAIMS Direct Solr Index. These parameters are used by the aidxd service.

Configuration Parameteraidxd ArgumentDefault ValueDescription
CD_PGDBNAME--pgdbname alexandriaThis controls which database configuration the indexing service uses as data source for the CLAIMS Direct Solr index. This entry corresponds to the default /database/@name attribute value in /etc/alexandria.xml. 
CD_SOLRDBNAME--solrdbname alexandriaThis controls which index configuration is used by the indexing service. This entry corresponds to the default /index/@name attribute value in /etc/alexandria.xml. 
CD_CORE--core alexandriaThe Solr collection.
CD_TMP--tmp /tmpThe default processing directory for intermediate indexing files extracted from the CLAIMS Direct data warehouse.

Client Tools Services

Both the CLAIMS Direct PostgreSQL update and optional Solr indexing services are typical system services.

Enable (configure to start on server start or reboot)

If necessary, adjust the code to reflect the version you are using.

Code Block
languagebash
#### PostgreSQL data warehouse service
systemctl enable apgupd.service

#### Optional SOLR indexing service
systemctl enable aidxd.service

Start Service Manually

If necessary, adjust the code to reflect the version you are using.

Code Block
languagebash
#### PostgreSQL data warehouse service
systemctl start apgupd.service

#### Optional SOLR indexing service
systemctl start aidxd.service

Stop Service Manually

If necessary, adjust the code to reflect the version you are using.

Code Block
languagebash
#### PostgreSQL data warehouse service
systemctl stop apgupd.service

#### Optional SOLR indexing service
systemctl stop aidxd.service