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.
|CAST Imaging up and running||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|
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||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||You must ensure that the license applied in CAST Imaging is valid.|
|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.|
Enter the URL to your CAST Imaging instance, including the port number if appropriate, for example:
|API Key||Paste 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 - Users panel).|
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:
When the settings are saved:
The Publish to CAST Imaging option will be enabled in the run analysis/snapshot wizard:
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:
When you have entered settings you can edit them but you cannot remove them.
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:
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.
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.
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:
|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:
Locate the following section and set the
synchro.domains.imaging.enabled option to true:
# ============== 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
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.
synchro.domains.imaging.enabledoption 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.
synchro.domains.imaging.enabledoption is in the true position, the following will occur: