Difference between revisions of "CaUtils"
From CollectiveAccess Documentation
(→Configuration) |
|||
(6 intermediate revisions by 3 users not shown) | |||
Line 8: | Line 8: | ||
||'''Command'''||'''Description''' | ||'''Command'''||'''Description''' | ||
|- | |- | ||
− | ||update-installation-profile||Updates configuration from "mini" or partial XML configuration profile. | + | ||[[Update_installation_profile|update-installation-profile]]||Updates configuration from "mini" or partial XML configuration profile. |
|- | |- | ||
||export-profile||Export current system configuration as an XML installation profile. | ||export-profile||Export current system configuration as an XML installation profile. | ||
Line 51: | Line 51: | ||
|- | |- | ||
||update-database-schema||Update database schema to the current version. | ||update-database-schema||Update database schema to the current version. | ||
+ | |- | ||
+ | ||reload-object-current-locations||Reload cached workflow-based [[Location_tracking|location tracking]] values for each object in the database. | ||
+ | |- | ||
+ | ||check-relationship-type-roots||Check for and repair missing relationship type root records. | ||
+ | |||
|} | |} | ||
Line 71: | Line 76: | ||
|- | |- | ||
||generate-elasticSearch-configuration||Configures ElasticSearch installation for use with CollectiveAccess. | ||generate-elasticSearch-configuration||Configures ElasticSearch installation for use with CollectiveAccess. | ||
− | |||
− | |||
|- | |- | ||
||rebuild-search-index||Rebuilds search indices. Use this if you suspect the indices are out of sync with the database. | ||rebuild-search-index||Rebuilds search indices. Use this if you suspect the indices are out of sync with the database. | ||
|} | |} | ||
+ | |||
+ | === General use === | ||
+ | |||
+ | To see all utilities ask for help after cd-ing into support: | ||
+ | |||
+ | <code>cd /path_to_Providence/support</code><br> | ||
+ | <code>bin/caUtils help</code> | ||
+ | |||
+ | <!--T:80--> | ||
+ | For example, to get further details about the ''load-import-mapping'' utility: | ||
+ | |||
+ | <!--T:81--> | ||
+ | <code>bin/caUtils help load-import-mapping</code> | ||
+ | |||
[[Category:Data_Import]] | [[Category:Data_Import]] | ||
[[Category:Developer]] | [[Category:Developer]] |
Latest revision as of 17:36, 19 April 2022
The caUtils commands can be accessed from /support.
bin/caUtils command
Configuration
Command | Description |
update-installation-profile | Updates configuration from "mini" or partial XML configuration profile. |
export-profile | Export current system configuration as an XML installation profile. |
Cron
Command | Description |
process-task-queue | Process queued tasks. |
Import/Export
Command | Description |
export-data | Export data to a MARC or XML file. |
import-data | Import data from an Excel XLSX, tab or comma delimited text or XML file. |
load-AAT | Load Getty Art & Architecture Thesaurus (AAT) into CollectiveAccess. |
load-export-mapping | Load export mapping from Excel XLSX format file. |
load-import-mapping | Load import mapping from Excel XLSX format file. |
sync-data | Synchronize data between two CollectiveAccess systems. |
Maintenance
Command | Description |
fix-permissions | Fix folder permissions. MUST BE RUN WHILE LOGGED IN WITH ADMINSTRATIVE/ROOT PERMISSIONS. |
rebuild-sort-values | Rebuilds values use to sort by title, name and identifier. |
remove-unused-media | Detects and, optionally, removes media present in the media directories but not referenced in the database. |
update-database-schema | Update database schema to the current version. |
reload-object-current-locations | Reload cached workflow-based location tracking values for each object in the database. |
check-relationship-type-roots | Check for and repair missing relationship type root records. |
Media
Command | Description |
regenerate-annotation-previews | Regenerates annotation preview media for some or all object representation annotations. |
reindex-pdfs | Reindex PDF media for in-viewer content search. |
reprocess-media | Re-process existing media using current media processing configuration. |
Search
Command | Description |
generate-elasticSearch-configuration | Configures ElasticSearch installation for use with CollectiveAccess. |
rebuild-search-index | Rebuilds search indices. Use this if you suspect the indices are out of sync with the database. |
General use
To see all utilities ask for help after cd-ing into support:
cd /path_to_Providence/support
bin/caUtils help
For example, to get further details about the load-import-mapping utility:
bin/caUtils help load-import-mapping