Hardware Requirements
CPU | 2-cores | 4-cores |
System Memory | 8GB | 16GB |
Storage Capacity | 500GB (100GB SSD for fast temporary processing space) | 1TB |
Requirement | Non-Solr and Solr Installation Type 2 | Solr Installation Type 3 |
---|
Software Requirements
Operating System | RHEL/Rocky 8, Amazon Linux 2 | We do not support Ubuntu or any operating system not explicitly listed. |
IFI CLAIMS Repository | # Amazon Linux 2 | |
Requirement | Minimum Version | Notes |
---|
CLAIMS Direct Software Installation
Using the CLAIMS Direct Repository
IFI CLAIMS provides yum software repositories to make installation simple.
First, install the necessary repository configuration files:
# See full URLs above sudo yum -y install https://repo.ificlaims.com/ifi-alexandria/<distribution>/ifi-claims-direct...
Next, update the system:
sudo yum update libxml2 # this update should pull libxml2 from our repository
Finally, install the Alexandria::Client::Tools:
sudo yum -y install perl-Alexandria-Library sudo yum -y install perl-Alexandria-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:
Key | Description |
---|---|
/databases/database/ | These entries configure the database name ( The name attribute is the identifier and is the default argument in all tools requiring a |
/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 |
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 Parameter | apgupd Argument | Default Value | Description |
---|---|---|---|
CD_PGDBNAME | --pgdbname | alexandria | This 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 | test | The user name provided to you by client services. The default will fail. |
CD_PASSWORD | --password | test | The password provided to you by client services. The default will fail. |
CD_INTERVAL | --interval | 5 | The interval, in seconds, between probes for new updates. |
CD_TMP | --tmp | /tmp | The default processing directory for intermediate files downloaded by the apgupd service. |
CD_OTHER_OPTIONS | '' | Add lesser-used arguments here. See | |
--api | To maintain the supplemental tables required for on-site family and citation functionality, add |
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 Parameter | aidxd Argument | Default Value | Description |
---|---|---|---|
CD_PGDBNAME | --pgdbname | alexandria | This 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 | alexandria | This 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 | alexandria | The Solr collection. |
CD_TMP | --tmp | /tmp | The 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.
#### 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.
#### 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.
#### PostgreSQL data warehouse service systemctl stop apgupd.service #### Optional SOLR indexing service systemctl stop aidxd.service