Page tree

Versions Compared

Key

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

...

CAST Imaging up and running(tick)Your designated CAST Imaging instance must  MUST be up and running in order to accept data from AIP Console 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 user with the ADMIN role(tick)At least one CAST Imaging user must be configured with the CAST Imaging ADMIN role (see Admin Center - Role and access permission managementUsers 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

...

AIP Console ≥ 1.26

Note
When using AIP Console ≥ 1.26-funcrel an API Key is required to access CAST Imaging. This API Key is only supported in CAST Imaging ≥ 2.5.2-funcrel.

Image Added

Enter a CAST Imaging user name that has the ADMIN Imaging password
Imaging URL

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

Code Block
languagetext
http://my_imaging_instanceserver:8083/


Imaging usernameAPI KeyPaste in your CAST Imaging API Key. You can find out how to generate one in Admin Center - API key generation and usage. Note that the API Key should be generated for a user that has the CAST Imaging ADMIN role (see Admin Center - Role and access permission management).Users panel).

AIP Console ≤ 1.25

Expand

Image Added


Imaging URL

Enter the

...

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

Code Block
languagetext
http://my_imaging_server: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:

Code Block
languagetext
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:

Code Block
languagetext
proxy.config.token.values=D5ED6A406775FC71B8D2A978883E8ED4,D5ED6A406775FC71B8D2A978883E8ED4,D5ED6A406775FC71B8D2A978883E8ED4,D5ED6A406775FC71B8D2A978883E8ED4


Info
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:

Info

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

Image Modified

Info

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

Image Modified

Info

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

Click to enlarge

Image Modified


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:

...

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:

Image ModifiedImage Modified

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

...

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 ZIP file set of files containing the data exported from the Analysis schema for your Application and this ZIP file is these are stored in the following location on the relevant AIP Node (i.e. the AIP Node that is responsible for the analysis/snapshot process for your Application):

...

languagetext

CAST Imaging instance:

Code Block
languagetext
%PROGRAMDATA%\CAST\ImagingSystem\Neo4j_data\import

Domain and tenant synchronization

Note
Information valid for AIP Console ≥ 1.26-funcrel, which requires CAST Imaging ≥ 2.5.2-funcrel.

In AIP Console ≥ 1.26-funcrel it is possible to choose to synchronize your AIP Console domains with equivalent CAST Imaging tenants. In other words, if your Application belongs to a domain in AIP Console, you can optionally upload the Application to a tenant in CAST Imaging with the same name as the domain. This is achieved by enabling an option in the aip-node-app.properties file located on the AIP Node responsible for analyzing your Application:

Code Block
%PROGRAMDATA%\CAST\AipConsole\AipNode\aip-node-app.properties

Locate the following section and set the synchro.domains.imaging

...

This ZIP file can be retained and manually imported into CAST Imaging if required. Alongside the ZIP file, the config.json file used to perform the export/import process is also retained:

Image Removed.enabled option to true:

Code Block
# ==============
CAST Imaging configuration
--------------
set to true if you want that your Console domains becomes CAST Imaging tenant and that your application be imported into
a tenant in Cast Imaging corresponding to the domain in Aip Console
synchro.domains.imaging.enabled=false

Save the aip-node-app.properties file and then restart the AIP Node package in order for the configuration to be taken into account. All applications managed by the AIP Node in question will now be synchronized to equivalent tenants in CAST Imaging, if they belong to a domain in AIP Console. You should repeat this action on all AIP Nodes where you want the same to be true.

Additional notes about domain and tenant synchronization

  • When synchro.domains.imaging.enabled option is in the default false position, the Application will be uploaded to the default tenant in CAST Imaging, or the current tenant in which the Application is currently stored if it already exists in CAST Imaging, regardless of whether the application belongs to a domain in AIP Console or not.
  • When synchro.domains.imaging.enabled option is in the true position, the following will occur:
    • If the Application belongs to a domain in AIP Console and the Application is not yet present in CAST Imaging, the Application will be uploaded to a tenant in CAST Imaging with the same name. If the equivalent tenant does not already exist in CAST Imaging, the tenant will be created.
    • If the Application belongs to a domain in AIP Console and the Application is already present in CAST Imaging in a tenant with the same name, the Application will be uploaded to that same tenant and merged.
    • If the Application belongs to a domain in AIP Console and the Application is already present in a different tenant or the default tenant in CAST Imaging, the Application will be uploaded to a new tenant matching the domain name in AIP Console. In this case, the Application will exist twice (or more) in CAST Imaging. It is the end user's responsibility to manage domains and tenants.
    • If the Application does not belong to a domain in AIP Console, the Application will be uploaded to the default tenant in CAST Imaging (if it does not already exist in CAST Imaging), or the current tenant in which the Application is currently stored (if it already exists in CAST Imaging).
    • If a domain in console has a ? or / in its name, or if its name is less than 3 characters long, the equivalent tenant will not be created in CAST Imaging (since this naming syntax is not permitted in CAST Imaging) and the Application will be uploaded to the default tenant.