RENAME

FROM

This keyword specifies the name and path of the file whose name is to be changed.

It is recommended to use the forward slash as the path separator and to avoid the use of the DOS drive designator.

The format of the path should be as follows:

For Windows you can specify:

• Absolute path.
  For example:
  /orders/order.json
  C:/orders/order.json
  C:\orders\order.json
  
  or
• Relative path.
  For example, orders/order.json (note, no '/' at the start), in which case the document order.json must be a file located in the orders directory under the JSM Instance directory on your server.

For the IBM i you can specify:

• Absolute path.
  For example:
  /orders/order.json
  
  or
• Relative path.
  For example, orders/order.json (note, no '/' at the start), in which case the document order.json must be a file located in the orders directory under the JSM Instance directory on your server.

This keyword is mandatory.

TO

This keyword specifies the name and the path to which the file is to be changed to. The path must be the same as that specified in the FROM keyword.

It is recommended to use the forward slash as the path separator and to avoid the use of the DOS drive designator.

The format of the path should be as follows:

For Windows you can specify:

Absolute path.
For example:
/orders/order2.json
C:/orders/order2.json
C:\orders\order2.json

or

Relative path.
For example, orders/order2.json (note, no '/' at the start), in which case the document order2.json will be placed in the orders directory under the JSM Instance directory on your server.

For the IBM i you can specify:

Absolute path.
For example:
/orders/order2.json

or

Relative path.
For example, orders/order2.json (note, no '/' at the start), in which case the document order2.json will be placed in the orders directory under the JSM Instance directory on your server.

This keyword is mandatory.

REPLACE

This keyword is used to specify whether you want to overwrite any existing file of the same name as specified in the TO keyword.

There are two possible values:

*YES - specifying this value will overwrite any existing file of the same name in the specified directory..

*NO - if this value is set then an exception will occur if a file of the same name already exists in the directory. If you capture this exception you can report it back to the user.

The default value is *NO.

This keyword is optional.