Introduction

The process of exporting and importing data into a CAST Imaging instance has previously been a manual process that must be actioned following the completion of either a snapshot or an analysis. This panel provides the settings required to fully automate this data export and import as part of the standard onboarding and rescan processes, so that when these processes are complete, all data is ready to use in CAST Imaging without having to perform any additional manual actions. 

Prerequisites

CAST Imaging up and running(tick)Your designated CAST Imaging instance MUST be up and running when you attempt this since AIP Console will attempt to connect using the defined settings when the Save button is clicked. Only one CAST Imaging instance can be configured in AIP Console to accept data.
CAST Imaging / ETL releases(tick)

This feature requires the following minimum releases of CAST Imaging or the standalone ETL Tool used with an older release of CAST Imaging:

CAST Imaging≥ 2.2.0
CAST Imaging ETL≥ 2.1.3


CAST Imaging user with the ADMIN role(tick)At least one CAST Imaging user must be configured with the CAST Imaging ADMIN role (see Admin Center - Users panel) - this user should be specified in the AIP Console settings panel as explained below.
CAST Imaging license must be valid(tick)You must ensure that the license applied in CAST Imaging is valid.

Settings

Imaging URL

Enter the URL to your CAST Imaging instance, including the port number if appropriate, for example:

http://my_imaging_instance:8083/


Imaging usernameEnter a CAST Imaging user name/password that has the CAST Imaging ADMIN role (see Admin Center - Users panel).
Imaging password
Imaging ETL PortEnter the port number of the Imaging ETL service running on your CAST Imaging instance.. By default the Imaging ETL service (which is responsible for the export/impact of data into CAST Imaging) runs on port 9001 (enter this number unless you have customized your internal services). If the instance is remote to the AIP Console host server as recommended, then you may need to configure the firewall on the CAST Imaging instance instance to accept incoming TCP connections on port 9001.
Imaging ETL Token

Enter the ETL token. The token can be found in the following file:

Microsoft Windows traditional installer:
%APPDATA%\CAST\ImagingSystem\login\application.properties

Docker Installer extension (located in the folder created when unzipping the extension):
login/application.properties

For example, the token that should be used is D5ED6A406775FC71B8D2A978883E8ED4 in the example configuration below:

proxy.config.token.values=D5ED6A406775FC71B8D2A978883E8ED4,D5ED6A406775FC71B8D2A978883E8ED4,D5ED6A406775FC71B8D2A978883E8ED4,D5ED6A406775FC71B8D2A978883E8ED4


Note that in the vast majority of circumstances, the token provided by default in the AIP Console wizard will match what is required.


Saving the settings

Use the Save button to save the settings you have entered - AIP Console will check that the settings are correct at this point. If AIP Console can successfully access the CAST Imaging instance using the settings you have entered, a "success" message will be shown, otherwise a "failure" message will be shown in which you will need to check the settings you have entered:

Failure messages are recorded in the AIP Console front-end log file located in %PROGRAMDATA%\CAST\AipConsole\logs. For example the following suggests that the Imaging ETL Token is incorrect:

ERROR com.castsoftware.webi.common.services.ImagingClient - 403 Forbidden: [{"error":"forbidden"}

When the settings are saved:

The Publish to CAST Imaging option will be enabled in the Add version wizard (for onboarding new applications and rescanning existing applications):

Click to enlarge

When the options in Imaging Settings described above do not exist or are incorrect, the option is unticked and disabled:


The Publish to CAST Imaging option will be enabled in the run analysis/snapshot wizard:

Click to enlarge

When the options in Imaging Settings described above do not exist or are incorrect, the option is unticked and disabled:

Click to enlarge


When the Publish to CAST Imaging option is selected when adding a new version, a new corresponding step will be visible in the analysis/snapshot process:

The CAST Imaging icon will be visible in the AIP Console - Application Management screen for both new Applications and rescan of existing Applications:

Editing existing settings

When you have entered settings you can edit them but you cannot remove them.

Ensuring AIP Console uploads data during the next analysis/snapshot

To ensure that your data is uploaded to your CAST Imaging instance, tick the Publish to CAST Imaging option when adding a new version, or running a new snapshot/analysis:

What happens when the Application data already exists in CAST Imaging?

When the current application already exists in your designated CAST Imaging instance, whether from a manual export/import, or from a previous automated upload from AIP Console, when you choose data to be uploaded again in a new snapshot/analysis (known as a refresh) the application data will be merged with existing data already imported into CAST Imaging - so new objects may be visible and existing objects may be removed or updated.

What happens if you delete an Application or a snapshot?

If you delete an Application or a snapshot using AIP Console, no corresponding data will be removed from your designated CAST Imaging instance. If you need remove the data from CAST Imaging, please see Admin Center - Application management panel.

Where is the exported data stored?

When the Publish to CAST Imaging option is ticked, the data export/import process will be performed during the analysis/snapshot as explained previously. This process generates a set of files containing the data exported from the Analysis schema for your Application and these are stored in the following location on the CAST Imaging instance:

%PROGRAMDATA%\CAST\ImagingSystem\Neo4j_data\import