jscript, jtool script

jscript lets you execute RedwoodScript commands from the command line. This tool uses a connection file, and operation is synchronous. The script is executed the moment it receives an execute command.

Commands are always read from standard input. If standard input is a terminal and the silent option has not been set, a prompt will be shown. If standard input is a (redirected) file, pipe, or stream, no prompt is shown. If you use the -s option, the only output will be that sent by the server. This consists of user-created output via jcsOut and jcsErr, as well as errors thrown by the interpreter (which go to stderr).

Note: For installation instructions, see jtool.

Syntax

jscript  [-h|-?|-help] [-l <loglevel>] [-f <logfile>] -j|-job-context|<connfile>
         [-i|-interactive] [-s|-silent] [-m|-message-server]
         [-t|-timeout <seconds>] [-protect]

TLS Arguments

The arguments require the -protect argument.

Proxy Setting Environment Variables

The following environment variables are used to retrieve proxy server connection details.

• HTTP_PROXY: The URL of the proxy server. For example: https://proxy.example.com:3128.
• PROXY_USER: The user for the proxy server. This value is ignored if HTTP_PROXY is not set.
• PROXY_PASSWORD: The password for the proxy user. This value is ignored if HTTP_PROXY is not set.
• NO_PROXY: Enforces a direct connection.

Setting the Return Code

The jcsShell.setReturnCode(int) method is used to set the return code of the script. Throw an exception if you want to terminate processing. The last effective call to jcsShell.setReturnCode() will set the return code.

Buit-in Commands

The following built-in commands are available in jscript.

• query: Performs an SQL query against the data model.
  • Supports formats xml, csv, and html.
  • Bind parameters are specified using the following syntax: bind <position> <dataType> <value>.
• submit: Submits a Process Definition.
  • Supply parameters with the following syntax: parameter <parameter_name> <value>.
  • Optionally, set a timeout and status or final for any final state. Once either is reached, jscript stops waiting. This command accepts the following syntaxes: wait <milliseconds_to_wait> final or wait <milliseconds_to_wait> status <status>.

Query Example

jscript> query
set format csv
bind 1 BigDecimal 5
bind 2 String '%Test%'
select count(*) from Job where JobId > ? and Description like ?

Submit Example

jscript> submit System_Sleep
parameter MilliSeconds 10000
wait 60000 final

Submit Process Example

The following example shows how to submit a process from a UNIX shell. The Redwood Server is named pr1.example.com, its port is 50000, and the context is /redwood. Note, that when you enter your password for the connection file, no text is displayed as you type.

$ jsecret -c ../../net/instance/default/example.conn https://pr1.example.com:50000/redwood
Username:jdoe
Password:

$ jscript ../../net/instance/default/example.conn <<EOF
{
  JobDefinition jDefinition = jcsSession.getJobDefinitionByName("System_Info");
  Job process = jDefinition.prepare();
  jcsSession.persist();
}
/
EOF

jscript can also read commands from a file.

$ cat script.rws
{
  JobDefinition jDefinition = jcsSession.getJobDefinitionByName("System_Info");
  Job process = jDefinition.prepare();
  jcsSession.persist();
}
/
$ jscript ../../net/instance/default/example.conn < script.rws

If you run the same command but use the terminal to supply input, you will see prompts.

$ jscript ../../net/instance/default/example.conn
Connected to example
jscript> {
      2>   JobDefinition jDefinition = jcsSession.getJobDefinitionByName("System_Info");
      3>   Job process = jDefinition.prepare();
      4>   jcsSession.persist();
      5> }
      6> /
Result: OK
$