Set Up Server

This feature is available only in Enterprise Edition.

If the server is running, it is best to manage server properties and storage using Enterprise Manager as described in All Properties and Storage. However, if the server is not running, you can set up the server in script by using the :setup or equivalent :su command.

Run the command using the Administration Console. (See Connect to a Repository for information on how to access the Console.)

To connect to a non-running server, you will need to launch the Administration Console with appropriate flags. See Connect to a Repository.

Set a Property

The set-property action sets a specified server property.

Parameters

directory: Path to inetsoft directory
property: Name of the property to set
value: Value of the property

Examples

:setup set-property '/var/lib/inetsoft' 'license.key' 'S000-000-ERX-00000-00000' (1)
:setup set-property '/var/lib/inetsoft' 'security.enabled' 'false' (2)

1	Set license key.
2	Turn off security. This may be useful if you cannot log into Enterprise Manager for any reason.

This can also be used in script form:

inetsoft {
  setup('/var/lib/inetsoft') {
    properties {
      put 'license.key', 'S000-000-ERX-00000000-00000000'
    }
  }
}

Get a Property

The get-property action gets a specified server property.

Parameters

directory: Path to inetsoft directory
property: Name of the property to get

Example

:setup get-property '/var/lib/inetsoft' 'license.key'

This can also be used in script form:

inetsoft {
  setup('/var/lib/inetsoft') {
    properties {
      get(license.key)
    }
  }
}

Upload Files to Storage

The upload-file action allows you to move files into server storage. (See Manage Content for information about importing to the repository.)

Parameters

directory: Path to inetsoft directory
file: Path to local file
targetPath: Desired location of file in server storage. This is the path displayed on the Storage page in Enterprise Manager. (See Storage for more information.)

Example

:setup upload-file '/var/lib/inetsoft' '/arbitrary/container/path/uploadFile.txt' 'path_in_dataspace/text.txt'

This can also be accomplished in a DSL script using the write method. The write method parameters are the target storage path and the file to upload.

inetsoft {
  setup('/path_to_inetsoft') {
  storage {
    write('data_space/text.txt', new File('/arbitrary/container/path/uploadFile.txt'))
  }
}

Download Files from Storage

The download-file action allows you to move files out of server storage. (See Manage Content for information about exporting from the repository.)

Parameters

directory: Path to inetsoft directory
sourcePath: Path to file in server storage. This is the path displayed on the Storage page in Enterprise Manager. (See Storage for more information.)
files: Path to local file to be written

Example

:setup download-file '/var/lib/inetsoft' 'path_in_dataspace/text.txt' '/arbitrary/container/path/downloadedFile.txt'

This can also be accomplished in a DSL script using the read method. The read method parameters are the server storage path and a closure with an InputStream as the parameter.

inetsoft {
  setup('/var/lib/inetsoft') {
  storage {
    read('path_in_dataspace/text.txt') { inp ->
      // opens a new file output stream and copies the input stream to it
      new File('/arbitrary/container/path/downloadedFile.txt').withCloseable { it << inp }
    }
  }
}

Backup Assets from Server

The backup action backs up all server storage into a Zip file from a non-running server. This is a full system backup and includes all assets, settings, users, and security configurations.

The server should not be running during the backup operation.

Parameters

directory: Path to inetsoft directory
path: The path to the local Zip file to contain the backed up files.

Example

Backup server storage into backup.zip in /arbitrary/container/path/ on the local machine/container.

:setup backup '/var/lib/inetsoft' '/arbitrary/container/path/backup.zip'

Restore Assets to Server

The restore action restores backed-up server storage from a Zip file. To back up assets to Zip file, see Backup Assets from Server or Manage Content.

The server should not be running during the restore operation.
To avoid data conflicts, restore should only be performed when there are no existing KV or Blob stores. (See Change the Storage Method for more information.)

Parameter

directory: Path to inetsoft directory
path: The path to the local Zip file that contains the backed-up files.

Example

Restore server storage from backup.zip.

:setup restore '/var/lib/inetsoft' '/arbitrary/container/path/backup.zip'

List Drivers

The list-drivers action returns a list of drivers contained in the specified JAR file, which should be uploaded as described in Upload Files to Storage.

Parameter

jarFiles: A JAR file in the bin directory containing drivers.

Example

import inetsoft.shell.dsl.SetupDelegate
:setup list-drivers '/arbitrary/container/path/ojdbc6-11.2.0.4.jar'

Package Drivers as a Plugin

The create-driver-plugin packages database drivers into a plugin Zip file with the specified name.

Parameter

pluginID: A unique ID, typically be a namespaced value, such as com.mycompany.jdbc.dbtype.
pluginName: A desired name for the plugin. The plugin will be listed under this name in Enterprise Manager.
pluginVersion: The plugin version, which should conform to semantic versioning standards.
drivers: The class name of the driver to package.
jarFile: The JAR file containing the driver, which should be located in the bin directory of the installation.
zipFile: The Zip file in which the plugin should be saved.

Example

:setup create-driver-plugin 'com.mycompany.jdbc.dbtype' 'myDB' '1.1.1' 'oracle.jdbc.OracleDriver' '/arbitrary/container/path/ojdbc6-11.2.0.4.jar' '/arbitrary/container/path/ojdbc6-11.2.0.4.jar.zip'