Difference between revisions of "CaUtils"

From CollectiveAccess Documentation
Jump to: navigation, search
(caUtils)
Line 1: Line 1:
 
==caUtils==
 
==caUtils==
  
 +
Configuration
 
{| {{PrettyTable}}
 
{| {{PrettyTable}}
 
|-
 
|-
Line 6: Line 7:
 
|-
 
|-
 
||export-profile||Export current system configuration as an XML installation profile.
 
||export-profile||Export current system configuration as an XML installation profile.
 +
|}
 +
 +
Cron
 +
{| {{PrettyTable}}
 +
|-
 +
||'''Command'''||'''Description'''
 
|-
 
|-
 
||process-task-queue||Process queued tasks.
 
||process-task-queue||Process queued tasks.
 +
|}
 +
 +
Import/Export
 +
{| {{PrettyTable}}
 +
|-
 +
||'''Command'''||'''Description'''
 
|-
 
|-
 
||export-data||Export data to a MARC or XML file.
 
||export-data||Export data to a MARC or XML file.
Line 20: Line 33:
 
|-
 
|-
 
||sync-data||Synchronize data between two CollectiveAccess systems.
 
||sync-data||Synchronize data between two CollectiveAccess systems.
 +
|}
 +
 +
Maintenance
 +
{| {{PrettyTable}}
 +
|-
 +
||'''Command'''||'''Description'''
 
|-
 
|-
 
||fix-permissions ||Fix folder permissions. MUST BE RUN WHILE LOGGED IN WITH ADMINSTRATIVE/ROOT PERMISSIONS.
 
||fix-permissions ||Fix folder permissions. MUST BE RUN WHILE LOGGED IN WITH ADMINSTRATIVE/ROOT PERMISSIONS.
Line 28: Line 47:
 
|-
 
|-
 
||update-database-schema||Update database schema to the current version.
 
||update-database-schema||Update database schema to the current version.
 +
|}
 +
 +
Media
 +
{| {{PrettyTable}}
 +
|-
 +
||'''Command'''||'''Description'''
 
|-
 
|-
 
||regenerate-annotation-previews||Regenerates annotation preview media for some or all object representation annotations.
 
||regenerate-annotation-previews||Regenerates annotation preview media for some or all object representation annotations.
Line 34: Line 59:
 
|-
 
|-
 
||reprocess-media ||Re-process existing media using current media processing configuration.
 
||reprocess-media ||Re-process existing media using current media processing configuration.
|-
+
|}
  
==Search==
+
Search
 
{| {{PrettyTable}}
 
{| {{PrettyTable}}
 
|-
 
|-
Line 47: Line 72:
 
||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.
 
|}
 
|}
 
Configuration
 
 
Cron
 
 
Import/Export
 
                 
 
Maintenance
 
 
Media
 
 
Search
 

Revision as of 21:11, 3 March 2014

caUtils

Configuration

Command Description
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.

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.
generate-solr-configuration Configures Solr 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.
Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools