About issuing commands directly to the Endeca JCD

The general URL syntax for commands sent manually to the Endeca JCD is as follows:

http://[host]:[port]/[op]?[param]=[val]&[param]=[val]...

Note: If you are using HTTPS mode, use https instead of http in the URL.

Alternatively, you can access some of the parameters through the Endeca JCD home page.

Valid [op] values are listed below, along with associated [param] keys. Note that some of the operations require a job name. Job names are defined in the Control Interpreter’s control script.

Note: Due to the length of the URLs some of the examples in this section break onto additional lines, but you would type them on a single line in your Web browser’s Address bar.

`active`

Description	Gets a brief status for a job. Returns the status for all running jobs if no job parameter is specified. Note: `Active` returns status for running jobs only, in contrast to status, which returns status for all jobs, running or not.
Parameter Keys	`job`: Name of the job for which status should be returned (optional). `format`:(Optional) HTML.
Accessible from JCD Home Page	Yes. Go to the JCD home page and click “Display running jobs”.
Example	`http://JCDServerNameorIP:JCDPort Number/active?job=wine_dgidx`

`delete`

Description	Deletes the job definition for a stopped job. After the definition is deleted, the job can no longer be restarted.
Parameter Keys	`job`: Name of the job to delete. `format`:(Optional) HTML.
Accessible from JCD Home Page	No.
Example	`http://JCDServerNameorIP:JCDPort Number/delete?job=wine_dgraph`

`dir`

Description	Lists the contents of a directory path.
Parameter Keys	`path`: Path of the directory to list. `format`:(Optional) HTML.
Accessible from JCD Home Page	Yes. Go to the JCD home page and click “Browse the file system”.
Example	On Windows: `http://JCDServerNameorIP:JCDPort Number/get?path=c:\endeca\platformservices\6.1.0\reference\sample_wine_ data\logs\` On UNIX: `http://JCDServerNameorIP:JCDPort Number/get?path=c:\endeca\platformservices\6.1.0\reference\sample_wine_ data\logs\`

`exit`

Description	Shuts down all jobs and terminates the JCD.
Parameter Keys	None.
Accessible from JCD Home Page	No.
Example	`http://JCDServerNameorIP:JCDPort Number/exit`

`get`

Description	Retrieves the complete contents of a file.
Parameter Keys	`path`: Path of the file to return. `offset`: (Optional) Specifies a start location different than the beginning of the file. If not specified, defaults to `0`. `numbytes`: (Optional) Specifies the number of bytes you want to retrieve, starting at `offset`. Defaults to the entire file size.
Accessible from JCD Home Page	Yes. Go to the JCD home page and click “Browse the file system".
Example	On Windows: `http://JCDServerNameorIP:JCDPort Number/get?path=c:\endeca\platformservices\6.1.0\reference\sample_wine_ data\logs\wine_forge.out` On UNIX: `http://JCDServerNameorIP:JCDPort Number/get?path=/usr/local/endeca/ current/reference/sample_wine_data/ logs/wine_forge.out`

`halt`

Description	Terminates the JCD, leaving active jobs running. Note: On UNIX, If the Endeca JCD is running under init, then init will immediately restart the JCD after a halt command.
Parameter Keys	None.
Accessible from JCD Home Page	No.
Example	`http://JCDServerNameorIP:JCDPort Number/halt`

`help`

Description	Displays the help page.
Parameter Keys	None.
Accessible from JCD Home Page	Yes. Go to the JCD home page and click “Help”.
Example	`http://JCDServerNameorIP:JCDPort Number/help`

`printenv`

Description	Prints the environment variables that the Endeca JCD is using.
Parameter Keys	None.
Accessible from JCD Home Page	Yes. Go to the JCD home page and click “Display environment variables”.
Example	`http://JCDServerNameorIP:JCDPort Number/printenv`

`roll`

Description	Roll (close and re-open) the Endeca JCD log file. If you roll the log to a new file, you will also have to update your `jcd.conf` file to point to the new log location. If you don’t update the `jcd.conf`, the Endeca JCD goes back to using the old log location when it is restarted.
Parameter Keys	`path`:(Optional) New log file path (default = existing log path). `format`:(Optional) HTML. Note: If you use the existing log path, your current log file will not be overwritten.
Accessible from JCD Home Page	No.
Example	On Windows: `http://JCDServerNameorIP:JCDPort Number/roll?path=c:\endeca\platformservices\workspace\logs\jcdlog.txt` On UNIX: `On UNIX: http://JCDServerNameorIP:JCDPort Number/roll?path=/usr/local/endeca/logs/jcdlog.txt`

`start`

Description	Starts a stopped job and returns the success or failure of the operation.
Parameter Keys	`job`: Name of the job to start. `format`:(Optional) HTML.
Accessible from JCD Home Page	Yes. Go to the JCD home page and click “Display all defined jobs”. Find the job you want to start and click “Run again”.
Example	`http://JCDServerNameorIP:JCDPort Number/start?job=wine_dgraph`

`status`

Description	Gets the status for a job. Returns the status for all jobs if no job parameter is specified. Note: `Status` returns status for all jobs, running or not, in contrast to `active`, which returns status for running jobs only.
Parameter Keys	`job`:(Optional) Name of the job for which status should be returned. `format`:(Optional) HTML.
Accessible from JCD Home Page	Yes. Go to the JCD home page and click “Display all defined jobs”.
Example	`http://JCDServerNameorIP:JCDPort Number/status?job=wine_dgraph`

`stop`

Description	Stops a running job.
Parameter Keys	`job`: Name of the job to stop. `format`:(Optional) HTML.
Accessible from JCD Home Page	Yes. Go to the JCD home page and click either “Display all running jobs” or “Display all defined jobs”. In the Status line of the job in question, click Stop.
Example	`http://JCDServerNameorIP:JCDPort Number/stop?job=wine_dgraph`

`tail`

Description	Returns the tail (that is, the last 1 KB) of a file.
Parameter Keys	`path`: Path of the file to `tail`.
Accessible from JCD Home Page	No.
Example	On Windows: `http://JCDServerNameorIP:JCDPort Number/tail?path=c:\endeca\platformservices\6.1.0\reference\sample_wine_data\ logs\wine_forge.err` On UNIX: `http://JCDServerNameorIP:JCDPort Number/tail?path=/usr/local/endeca/ current/reference/sample_wine_data/ logs/wine_forge.err`