CAST Imaging
Page tree

Versions Compared

Old Version 3

changes.mady.by.user James Hurrell

Saved on

compared with

New Version Current

changes.mady.by.user James Hurrell

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterRequired?Description

-h / --help

(error)Displays the help message.
--version(error)

Show program's version number and exit.

--host(error)Enter the network host name of the server on which the CAST Storage Service/PostgreSQL is located. Default = localhost.
--user(error)Enter the CAST Storage Service user login. Default = operator.
--password(error)Enter the CAST Storage Service password corresponding to the user entered in --user. Default = CastAIP.
--port(error)

Enter the port number for the target CAST Storage Service/PostgreSQL. Default = 2282 (CAST Storage Service 3):

CSS22280
CSS32282


--schema(error)

CAST recommends using --mngt instead of --schema. Please use one or the other. --schema will eventually be phased out in favour of --mngt.

Enter the name of the Analysis schema schema containing the Application you would like to work with in CAST Imaging.

Info

You can view the name of the Analysis Service schema as follows:


--database

Available in ≥ 2.1.0-funcrel.

(error)

This option allows you to specify a specific CAST Storage Service/PostgreSQL database name other than the default "postgres". In the vast majority of situations, this option is not required. It is only necessary if the CAST AIP schemas as stored on the CAST Storage Service/PostgreSQL instance in a database other than the default "postgres". For example:

Code Block
--database customdb


--mngt

Available in ≥ 2.0.0-beta6.

(error)

CAST recommends using --mngt instead of --schema. Please use one or the other.

Enter the name of the Management schema (i.e. the combined installation) containing the Analysis schema in which the Application you would like to work with in CAST Imaging is stored.

Info

You can view the name of the Management schema as follows:


--outputdir(tick)Enter the location where the resulting output ZIP will be stored. This folder must exist.
--log(tick)Enter the location for the output log file. This file must exist.
--debug(error)

Print debug messages (default: false).

--debuginfo

(error)

Control check files: yes|no (default:NO).

--cfg(error)

Regeneration of config files: yes|no (default:NO).

--aiptable

(error)

Force the extraction of AIP tables: yes|no (default:NO).

--limitedscope

Available in ≥ 2.1.0-funcrel.

(error)This option will perform a truncated export of application data (i.e. not all the application data is exported) in order to improve the time needed to show results in CAST Imaging. This option is therefore aimed at POC, demos etc. where results need to be produced quickly. It should not be used in production environments.

--applicationname

Available in ≥ 2.1.0-funcrel.

(error)

This option allows you to specify the name of the Application for display purposes in CAST Imaging. For example:

  • you may have an Application called "TopSecretApplicationName" in your CAST AIP schemas and you would rather have this Application displayed with a more friendly/appropriate/anonymized name such as "ApplicationX".
  • you may want to import the same Application multiple times into CAST Imaging, if so, use this option to name the Application appropriately, e.g. "MyExportV1", "MyExportV2", "MyExportV3" etc.

If so, use the following syntax:

Code Block
exporter.exe --mngt <name of schema containing the application to export> --applicationname <name of application as displayed in CAST Imaging> --outputdir c:\temp\my_output_path --log c:\temp\log\log.txt

--applicationname will accept the following characters only:

  • A-Z
  • a-z
  • 0-9_

...

Info
  • If you have run multiple export actions to export data for multiple Applications, you will now have multiple ZIP files.
  • You can include multiple Application data in one ZIP file for the data import action. In other words, if you have run multiple export actions to export data for multiple Applications, you will now have multiple ZIP files - if necessary, the content of the multiple ZIP files (not the ZIP files themselves) can be included in one single ZIP for the data import action. If you do this, there are no constraints on the name of the ZIP file.

Tips

[WinError 10054] An existing connection was forcibly closed by the remote host

If you are attempting to export from a PostgreSQL instance installed on Microsoft Windows (i.e. CAST Storage Service) and your application is very large, you may find that the export process fails with the error which is caused by a timeout:

Code Block
[WinError 10054] An existing connection was forcibly closed by the remote host

By default, on PostgreSQL instances installed on Microsoft Windows, the PostgreSQL instance timeout is set to 2hrs, therefore any export process that takes longer than 2hrs will fail. If you encounter this error, it is possible to modify the timeout setting using the postgresql.conf file located here:

Code Block
%PROGRAMFILES%\CAST\CastStorageService<version>\db_data\

Edit this file with a text editor and find the tcp_keepalives_idle entry:

Code Block
# - TCP settings -
# see "man tcp" for details

#tcp_keepalives_idle = 0		# TCP_KEEPIDLE, in seconds;
					# 0 selects the system default

By default, this entry is commented out and will be ignored - this means that the default value of 0 applies - i.e. the Microsoft Windows system default of 2hrs. To set a longer timeout interval, uncomment the entry and set required interval in seconds (above 2hrs). For example to set a timeout of 6hrs:

Code Block
# - TCP settings -
# see "man tcp" for details

tcp_keepalives_idle = 21600		# TCP_KEEPIDLE, in seconds;
					# 0 selects the system default

Save the file and then restart the CAST Storage Service instance to apply the change.

Info

Note that tcp_keepalives_idle is ignored when the PostgreSQL instance is installed on Linux.

Next steps?

Please see Import the CSV data for more information about the next step.