Page tree
Skip to end of metadata
Go to start of metadata

Summary: documentation for the Application Details panel in the Console Administration Center.

Accessing the Application Details panel

Login with a user account that already has the Admin role and switch to the Admin Center:

Now move to the Applications panel:

Click the Options button (three dots) for the Application you are interested in and select View Details:

Choose the details you require:

License Key

This section is only available when the following is true:

This panel enables you to update/replace a Named Application license key - for example if the license is expiring and you have a new replacement license key. To do so, enter the replacement license key in the License Key field and then click Update. Note that the replacement license key MUST contain the SAME application name as the previous license.

Backups

This section:

  • lists all backups that have been performed of the current Application
  • provides an option to run a new backup
  • offers additional options to manage existing backups

Click to perform a new backup. You will be prompted to choose the items you would like to backup (all are ticked by default):

Name

Choose the name for the backup. By default the name will use the following syntax: APPNAME_YYYY-MM-DD.

Backup application schemas

Tick to backup the Application's associated schemas (they will be backed up in .cssbackup format). Note that ticking ONLY this option will mean that the backup cannot be restored in Console (the delivery folder is also required).

Backup delivery folder

Tick to backup the Application's Delivery folder (this will be backed up in uncompressed format). Note that:

  • selecting this option will also backup any options set at version level, for example exclusion patterns, source path, objective choices (these are included from Console v. ≥ 1.22) in XML format. 
  • ticking ONLY this option will mean that the backup cannot be restored in Console (the application schemas are also required).

Click Backup to start the backup process. This can take some time if the Application is large (i.e. large amounts of source code, snapshots etc.). When a backup is run, the backup is stored on the Node hosting the current Application. The following location is used by default (this is set to use the "backup" folder defined for the Node:

≥ 2.x: \\SHARE\aip-node-data\common-data\backup\<application_name>\<appname>_YYYY-MM-DD.zip

1.x: %PROGRAMDATA%\AipConsole\AipNode\backup\<application_name>\<appname>_YYYY-MM-DD.zip

See also Backing up an Application.

When a backup is actioned the following will occur:

  • the Application's associated schemas will be backed up in .cssbackup format
  • the Application's Delivery folder will be backed up in uncompressed format
  • Options set at version level within the Application, for example exclusion patterns, source path, objective choices (these are included from Console ≥ 1.22) in XML format
  • Snapshot Indicator records (these are included from Console ≥ 2.4)
DateDate and time the backup was taken.
Type

There are three possible types:

  • DELIVERY: The backup contains only the delivery folder. This backup cannot be restored in Console (the application schemas are required).
  • SCHEMA: The backup contains only the application schemas.  This backup cannot be restored in Console (the delivery folder is required).
  • ALL: The backup contains both the delivery folder and the application schemas. This backup can be restored in Console.
SizeTotal size of the backup in MB.

Click to restore the selected backup. See Restoring an Application for more information.

Click to download the selected backup as a ZIP file.

Click to delete the selected backup.

Database Schemas

This section lists the schemas associated with the current Application. These will be named as follows:

  • Management schema (<appname>_mngt)
  • Analysis schema (<appname>_local)
  • Dashboard schema (<appname>_central)

The CAST Storage Service/PostgreSQL instance on which the schemas are stored will also be displayed in the top bar:

You may occasionally see schema names starting with uuid_ listed in the Name column. This can occur in the following situations:

  • When characters such as _ (underscore) and (full stop/period) are used in the corresponding Application name, these characters are NOT authorized for use in schema names.
  • If schemas already exist on the target CAST Storage Service/PostgreSQL instance with the same name.

CAST Support (Sherlock)

This  section:

  • lists all Sherlock exports that have been performed of the current Application
  • provides an option run a new Sherlock export
  • offers additional options to manage existing exports

Click to perform a new Sherlock export if you are requested to by CAST Support. This can take some time if the Application is large (i.e. large amounts of source code, snapshots etc.). The following location is used to store the export on the Node hosting the current Application:

≥ 2.x: \\SHARE\aip-node-data\common-data\sherlock\<application_name>\<export_name>.zip

1.x: %PROGRAMDATA%\AipConsole\AipNode\data\sherlock\<application_name>\<export_name>.zip

See Creating a CAST Support Tool export for CAST Support.

Click to download the selected export as a ZIP file.

Click to delete the selected export.

Node

Behaviour in Console ≥ 2.4

Enterprise mode

In ≥ 2.4 Console will automatically function as follows:

  • Applications are not tied to a specific Node
  • Node instances are considered to be stateless
  • Console will automatically operate in load-balancing mode where Nodes are chosen from the pool of Node instances to perform the next job (analysis/snapshot etc.) in this order:
    • the Node running the most recent release of AIP Core will be chosen first, above all others
    • if all nodes are running the same release of AIP Core, then the least used Node instance is selected

Therefore, by default, this section will display Any as follows, indicating that any Node can be used to process the application, provided that the release of AIP Core running on the Node is equal to the release of AIP Core used for your Application for previous actions:

However, it is sometimes necessary to ensure that a specific node is always used for a specific Application - for example, the Node may be configured with specific hardware (RAM, CPU etc.) that the Application requires. If this is the case then you can choose the node you require from the drop down list:

Note that Console will ONLY offer Nodes running the same release of AIP Core used for your Application for previous actions: Nodes running older releases of AIP Core will not be offered for selection.

You will then be warned that the selection is irreversible:

The selected node is then displayed and the option cannot be changed:

If you are using the modern onboarding workflow introduced in 2.3, and you choose a specific node in the Pre-analysis findings panel:

...then this option will be disabled and the node dedicated to the application will be displayed for information only:

Standalone mode

The panel is not displayed because only one node can be configured in standalone mode.

Behaviour in Console 2.0 - 2.3

This section is not available because:

  • Applications are not tied to a specific Node
  • Node instances are considered to be stateless
  • Console will automatically operate in load-balancing mode where Nodes are chosen from the pool of Node instances to perform the next job (analysis/snapshot etc.) in this order:
    • the Node running the most recent release of AIP Core will be chosen first, above all others
    • if all nodes are running the same release of AIP Core, then the least used Node instance is selected

Behaviour in Console 1.x

This section lists the Node which hosts the Application - for information only:

Debug options

Show SQLWhen activated, this option will render SQL queries used by Console in all log files. Please do not activate this options unless you are requested to do so by CAST Support as part of a troubleshooting exercise.
Activate AMT Memory ProfilingPlease do not activate this option unless you are requested to do so by CAST Support as part of a troubleshooting exercise.
  • No labels