This documentation is no longer maintained and may contain obsolete information. AIC Portal is not supported since 31 December 2020. You should instead refer to Application onboarding.


Basic concepts

CAST AIC Portal

The CAST AIC Portal is a web application that is deployed on a supported Application Server (for example Apache Tomcat) in the local environment. It is designed to be accessed via a browser by the Delivery Manager(s) - when accessed, the CAST AIC Portal will "push" the CAST Delivery Manager Tool as a "local" installation on to the workstation of the Delivery Manager.

As such, multiple Delivery Managers can run the CAST Delivery Manager Tool on their own local machines and package only the source code they need to. Source code packaged by Delivery Managers is delivered to one central location (the Source Code Delivery Folder) managed by the CAST AIC Portal, which can then be retrieved by the AI Administrator using the CAST Management Studio (which is configured to retrieve the delivered source code from the central storage location managed by the CAST AIC Portal).

Note that the CAST AIC Portal contains a basic built in documentation that explains the main aspects of the Delivery process and how it works:

CAST Delivery Manager Tool

The CAST Delivery Manager Tool is a standalone application that entirely manages the discovery, selection, extraction and delivery of source code ready for analysis in the CAST Management Studio. It can be used in different scenarios and is designed to be flexible to accommodate most options. It is "pushed" by the CAST AIC Portal and is installed on the local workstation. It can be relaunched whenever required.

The Delivery Manager(s) is the person within the application team who is responsible for providing source code for analysis. The source code can be of different types including:

Regardless of the type of source code, the Delivery Manager(s) can use the CAST Delivery Manager Tool to package and deliver it to the CAST AIC Portal and then into the AI Center for analysis. There may be more than one Delivery Manager, for example when multiple technologies or distributed development teams are involved. The CAST AIC Portal supports and facilitates this distributed delivery model.

How many of each do I need?

CAST AIP schemas and Applications

CAST recommends that each Application you need to onboard and analyze with CAST is configured to have sole use of a "triplet" of CAST AIP schemas as follows:

Application 1 uses:

If you need to analyze any additional Applications, CAST recommends that for each additional Application you install a new additional "triplet" of CAST AIP schemas:

Application 2 uses:

Onboarding multiple Applications in the same triplet of CAST AIP schemas (while possible) can cause inter-Applications links to be created and other potentially undesirable side-effects.

With regard to Measurement Services that are required for the Health Dashboard, you can choose to:

Please see Install CAST AIP schemas and Installing and configuring the Health Dashboard for more information.

Example setup

One example setup would be to:

CAST AIC Portal

CAST recommends using one CAST AIC Portal to manage source code for all Applications that you need to analyze with CAST. However, the CAST AIC Portal is CAST AIP version aware and can only manage Applications that are being administered with the same release of CAST AIP (in other words you cannot mix Applications that are being managed on CAST AIP 8.2.x with Applications that are being managed on CAST AIP 8.3.x - for example).

Please see Installing and configuring the CAST AIC Portal for more information.

Configuring domains and applications

As explained in CAST AIC Portal - Configuring user authentication, the configuration of Domains, Applications and the Delivery Manager role is achieved using the CAST AIC Portal GUI. Only a user that is a member of a group that has been assigned the Platform Administrator role (see also CAST AIC Portal - Configuring user authentication) can configure Domains, Applications and the Delivery Manager role, therefore you must first connect to the CAST AIC Portal with a user that has this role (for example the default "cast" user).

Configuring Domains


Note that:

  • domains are used to group Applications together and associate them to a group of users that will manage their delivery (Delivery Manager role).
  • Note that only a user with the Platform Administrator role can configure Domains.

Creating a new domain

Note that you can configure your Delivery Managers when creating the domain, however, this process is explained separately in Configure the Delivery Manager role.

Rename or delete an existing domain

Note that if you attempt to delete a domain that contains Applications, the following confirmation message will be displayed:

Clicking OK will remove the domain and all its attached Applications. Any instances of the CAST Delivery Manager Tool that refer to an Application that has been deleted will no longer function.

Registering a new domain using the command line

If you want to employ an automated solution to create the domain and assign users and groups to this domain as Delivery Managers, you can do so using a command line tool provided with CAST AIP. Please see Automating CAST AIC Portal Configuration tasks for more information.

Configuring Applications

Note that only a user with the Platform Administrator role can configure Applications.

Adding Applications to a domain

Note that the Application Name field cannot contain any of the following characters: \ / : * ? " < > |

Rename or delete an existing Application

Please note:

  • Deleting the Application will remove all trace of it, i.e. any Versions or Packages that have already been created/delivered will also be removed - this also applies to the CAST Management Studio - i.e. the Application will no longer be available to work on. Any existing instances of the CAST Delivery Manager Tool that refer to an Application that has been deleted will no longer function.
  • After renaming an Application, the Application name will also be updated in all associated tools - the CAST Management Studio and the CAST Delivery Manager Tool. However, to ensure the update is propagated correctly, you must do the following in the CAST Management Studio:
    • Use the File > Save All option (or save your modifications when exiting the CAST Management Studio) to ensure that the new Application name is saved in the Management Service schema
    • Run the Synchronize action manually in the CAST Management Studio (right click the CAST Dashboard Service and select Synchronize) or automatically as part of a another action (such as a snapshot generation) to ensure that the new Application name is saved in the Dashboard Service schema and is therefore displayed correctly in the CAST Application Engineering Dashboard (or the legacy CAST Engineering Dashboard):

    • Click the Upload Snapshots to Measurement Service option in the Application editor > Execute tab) to ensure that the new Application name is saved in the Measurement Service schema and is therefore displayed correctly in the Health Dashboard:

Moving the Application to a different domain

When moving the Application to another domain, all users belonging to groups assigned to the other domain will gain Delivery Manager rights on the Application you move.

Note about invalid Applications

Note that if an Application is deemed "invalid", it is displayed in the CAST AIC Portal in red:

The only option available is to delete the Application.

An Application is generally considered to be invalid if it has been registered in the CAST AIC Portal but does not exist in the Delivery folder.

Registering a new Application using the command line

If you want to employ an automated solution to create the Application, you can do so using a command line tool provided with CAST AIP. Please see Automating CAST AIC Portal Configuration tasks for more information.