The Voyado Elevate Command is a command line tool that is used from the command line prompt like a regular executable
java –jar command.jar <arguments>).
help-command will display all available commands and a short description of them. If a command is provided as an argument, more detailed information about that specific command will be displayed.
java –jar command.jar help [<command>]
All available commands¶
define_cluster- Defines a cluster. Not available for Cloud.
defrag- Restores performance and reclaims wasted disk space and memory of a specific Elevate Server. Not available for Cloud.
export- Extract a set of data from a cluster, resulting in an XML document with the same format as is required for importing that type of data.
help- Displays all available commands and a short description of them.
import- Imports data to all Elevate Servers in a cluster.
log- Retrieves a log from a server in an Elevate cluster. Requires a name retrieved from the
log_names- Retrieves all available log names from an Elevate cluster.
notifications- Prints, at most, the last 1000 notifications of a notification type received by a cluster.
panel- Prints the content of a panel given a set of panel arguments, if provided.
querystats- Prints usage statistics of a specific Elevate Server. Not available for Cloud.
status- Print the general status of a cluster.
synchronize- Synchronizes the Elevate Servers so that they all contain the same data.
create_export_customer_data_job- Starts an export job of visitor data. Part of Voyado's solutions for enabling GDPR compliance.
create_remove_customer_data_job- Removes all available data related to a visitor. Part of Voyado's solutions for enabling GDPR compliance.
check_customer_data_job_status- Checks the current job status of an export or removal job. Part of Voyado's solutions for enabling GDPR compliance.
download_export_customer_data_job_result- Downloads a completed export job. Part of Voyado's solutions for enabling GDPR compliance.
querystats-command prints usage statistics of a specific Elevate Server. The statistics include entities such as average search processing time, most time consuming queries, maximum number of concurrent requests etc. The statistics can be limited to only involve a specific function.
java –jar command.jar querystats [-host <value>] <url> [<file>]
| ||The index of the Elevate Server in the cluster (default is |
The URL to one of the servers in the cluster must be provided. If the response is to be printed to a file, the path to the file must also be provided.
This section is for Elevate versions prior to 3.21.2. Defragmentation is handled automatically for 3.21.2 and newer versions.
If the data in a cluster is imported frequently over an extended period of time, it will start using more disk space/memory and the performance will degrade. To restore performance and reclaim wasted disk space and memory, run the
java –jar command.jar defrag <url>
The URL to one of the servers in the cluster that is to be defragmented must be provided. The frequency with which defragment commands should be issued is dependent on how often and how big imports are sent to the system, as well as the performance demands of the retailer, and the amount of memory and disk available to the installed Elevate Servers. As a rule of thumb, weekly defragment operations are strongly recommended.
synchronize-command synchronizes the Elevate Servers so that they all contain the same data. This may be necessary if a new Elevate Server is introduced into the system. The Elevate Server which has been updated the most will replicate its data to all other Elevate Servers. If there are several servers with the same number of updates one of them will be selected at random to distribute its data.
The Synchronize operations are performed online.
java –jar command.jar synchronize <url>
An ignore flag could be provided in order to ignore inconsistencies rather than resolving them. The command will then delete all import history from the system. Note that this is non reversible. This is an operation that should normally not be used, but it may be necessary in some rare cases like after restoring a backup. Unless it is absolutely certain that all Elevate Servers have the same data the clear import history must be followed by a full data reload of the Elevate Servers.
java –jar command.jar synchronize -ignore <url>
The URL to one of the servers in the cluster must be provided.
The command-line tool may exit with one of the following exit codes.
|0||Finished||Command finished successfully.|
|1||Missing Argument||A mandatory argument was missing.|
|2||Invalid Argument||A supplied argument had a forbidden value.|
|3||Cluster Not Available||The Elevate cluster did not respond. Commonly, the wrong address is used.|
|4||Unknown Command||The specified command does not exist.|
|5||Unknown Argument||An argument was supplied but no parameter or option to assign the value to.|
|6||Unparsable Response||The response from Elevate could not be parsed. This exit code is currently unused.|
|7||Internal Error||An internal error occurred. Check the details in the error message.|
|8||Invalid Controller Configuration||The controller configuration does not support the command. This exit code is currently unused.|
|9||Network Error||A network related error occurred.|
|10||Server Error||An error occurred on the server while processing the command.|
|11||Bad Request||The request made by the client was invalid. This may for example mean that the cluster had not been defined prior to an operation on a cluster, or that an import file contained errors.|
|12||Busy Cluster||The task could not be accepted because the cluster was busy with another task.|