A user with the ADMIN or SUPER ADMIN role is required.
The Applications panel enables you to manage the Applications in CAST Imaging:
Click to enlarge
This drop down list is only displayed if you have configured multiple tenants - see Admin Center - Multi tenant panel. The drop down list enables you to filter the applications based on the selected tenant - selecting a different tenant will refresh the list and display the applications belonging to the chosen tenant.
Link/Unlink annotations (previously Link/Unlink Docs): This option is disabled by default. Enabling it will ensure that any object Annotations (see User Guide - Using the Annotate feature) that have been added to specific objects will be made available in the right hand panel when using the Aggregated by > Modules at Level 1:
For example, an object annotation has been added to the object "StockPart":
When using Aggregated by > Modules at Level 1, it is not possible to see that an object annotation has been added to an object belonging to one of the modules:
However, after enabling the option by moving the slider:
the object annotation is now visible:
Job Queue Management: use this option to view the status and/or cancel any current app import/app to app dependencies scan/app delete job:
Using the queue mechanism, it is possible to trigger multiple imports, generate links for app to app dependencies one after the other and remove applications at the same time. There is limit of 25 jobs at a time for the job queue.
|Upload: use this option to bulk upload object Documents and/or Tags via a .CSV file. See Admin Center - Bulk importing documents or tags via .CSV file.|
Search: use the search icon to search for an Application in the list of imported Applications.
|Datasource management: use the icon to update (add and edit) the Datasource from the admin page. See Admin Center - Configuring data source|
Delete: will remove a selected Application (or Applications is multiple Applications have been selected) from CAST Imaging.
Edit: allows you to edit the alias for a selected Application (or Applications is multiple Applications have been selected). See Admin Center - Managing application aliases.
The tickboxes allow you to select an Application either to delete it from CAST Imaging, or to manage its alias (see Admin Center - Managing application aliases). You can:
Name of the imported Application. Rolling the mouse over the Application will show a link, which will take you direct to the Application for further review:
Available in CAST Imaging ≥ 2.13.
Displays the name of the version as defined in CAST Console when the application was analyzed. Note that this column will not display the version name unless:
|ETL Version||Indicates the version number of the ETL mechanism used to import the Application into CAST Imaging. This mechanism is embedded in CAST Imaging or can be downloaded as a separate standalone tool - see CAST Imaging ETL.|
|Import Duration||Duration of the import process.|
|Last Updated On||Most recent time the Application was updated (i.e. the time it was last imported).|
|Schema Name||Name of the schema in which the Application was originally stored and exported from.|
This column indicates which CAST Storage Service/PostgreSQL instance is being used to fetch the source code for an object in a given application. If you have not configured the Source Code viewer (see Configure the source code viewer), then this column will not be visible. See Admin Center - Managing application aliases for more information.
Available in CAST Imaging ≥ 2.12.
This option allows you to download the logs related to the process of importing the application data into CAST Imaging (i.e. via CAST Console, the CAST Imaging UI or ETL tools - see Export and import the Application data). Note that if you have upgraded to CAST Imaging ≥ 2.12 or if the import logs are missing, a popup message will be displayed explaining that the application will need re-importing in order to access the logs:
If you do not see a list of Applications, click panel 2 to display the Application list:
Add Application (import new / refresh existing)
To add a new Application, or add an Application that already exists (known as a refresh), you must already have actioned an export of the application into a ZIP file created using the exporter.exe tool - see Export the CSV data. When the ZIP is ready, you can add it using panel 2:
- a refresh (adding a ZIP for an Application that already exists in CAST Imaging) will cause data in the new ZIP to be merged with existing data already imported into CAST Imaging - so new objects may be visible and existing objects may be removed or updated.
- once an Application has been updated (i.e. refreshed), it is not possible to revert back to the data uploaded during the previous "import".
- you can run an export and import all in one go - see Automation tool export and import process
Import new Application data
Upload the ZIP file containing the Application data (see Export the CSV data for information about generating this ZIP). You can either:
- drag and drop the ZIP file into the square in the middle of the screen
- or you can use the Import button to browse for the ZIP you require
If the ZIP file is accepted (a check will be done to ensure the ZIP contains the correct data files), the Applications contained in the ZIP (a ZIP can contain more than one Application) will be imported:
On completion, a summary is shown, with an option to view the import logs:
If you would like to view the imported Application, click CAST Imaging in the top left corner of the screen then select the Application in the following screen:
Import multiple application data simultaneously
Available in ≥ 2.16.
By default, CAST Imaging is configured to handle the upload of one application at a time, any additional applications that are uploaded while an upload action is ongoing are queued. This behaviour can be modified to allow CAST Imaging to accept multiple application uploads simultaneously.
This configuration is handled by the WORKER_POOL_SIZE parameter located in the following files depending on your environment:
Microsoft Windows traditional installer: %APPDATA%\CAST\ImagingSystem\imagingservice\imagingetl.bat Docker Installer extension (located in the deployed extension location): etl/app.config
To change the behaviour, edit the appropriate file with a text editor and find the WORKER_POOL_SIZE parameter: it will be predefined with a value of 1, indicating one upload at a time:
"PORT": "9001", "WORKER_POOL_SIZE": 1, "NEO4J_BOLT_ENDPOINT": "127.0.0.1:7687",
-PORT=9001 ^ -WORKER_POOL_SIZE=1 ^ -NEO4J_BOLT_ENDPOINT=127.0.0.1:7687 ^
Change WORKER_POOL_SIZE to the required value: for example, setting the value to 3 will allow the upload of 3 applications simultaneously. Any additional applications that are uploaded while the existing job is ongoing will be queued until a slot becomes free. E.g.: if you import 5 applications then the first three selected applications are simultaneously imported and the other two will be queued. When the import (job) of an application in simultaneous mode is completed, then the fourth application (which is in queue) will automatically move to simultaneous mode and start uploading.
Save the file and restart the CAST Imaging "etl" Windows Service or Docker container to ensure that the changes are taken into account.
In the below example, the value is set to "3" which lets you import "3" applications simultaneously.
The process of importing the apps runs simultaneously (without waiting in queue). This is represented with a loading animation icon in 'Import Logs' column.
If the 'WORKER_POOL_SIZE'=3 and if you import 5 applications then the first three selected applications are simultaneously imported and the other two will be in queue (waiting). When the import (job) of an application in simultaneous mode is completed, then the fourth application (which is in queue) automatically moves to the simultaneous mode.
If multiple applications are imported following message is displayed 'Importing Applications'.
Refresh existing Application data
You can refresh data for Applications that have already been imported - a refresh will cause data in the new ZIP to be merged with existing data already imported into CAST Imaging - so new objects may be visible and existing objects may be removed or updated. Upload the ZIP in exactly the same way as for importing new Application data.
Remove Application data
Removing an Application will cause all associated data to be purged from CAST Imaging. This action cannot be reversed. Select the Applications you wish to remove by placing a tick in the check box, then click Remove to start the removal process:
You will be prompted to confirm that you do want to remove the Application (with the application name/s) - this action cannot be reversed:
The removal process will then proceed, following message is displayed "Removing applications" with an option to view the removal logs:
On completion, following confirmation message "Applications removed successfully" is displayed.