Administer and Manage on CAST Imaging Documentation

Manage Users

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging administrator
Role required	Admin or Super Admin
Prerequisites	CAST Imaging installed and running

Open the Users panel

In the Admin Center, click Users.

[TODO: Screenshot of the Users panel]

Create a user

Click Add user.
Enter the username, email, and password.
Assign a role. See Manage roles and permissions.
Click Save.

Edit a user

Click a username to open the user record. Edit the fields you want to change and click Save.

Manage Roles and Permissions

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging administrator
Role required	Admin or Super Admin
Prerequisites	Users created

Open the Roles panel

In the Admin Center, click Roles.

Default roles

Four roles are provided by default. They cannot be deleted or modified.

Role	Access level
Viewer	Read all application data; read saved views and annotations
Editor	Viewer + create tags, annotations, custom links, saved views
Admin	Editor + manage users and application settings for the tenant
Super Admin	Full access to all tenants and all settings

Create a custom role

Click Add role.
Enter a name.
Select the applications the role can access (one, many, or all).
Set resource permissions (READ, CREATE, UPDATE, DELETE) for each feature.
Click Save.

[TODO: Screenshot of the role editor]

Manage Tenants

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging Super Admin
Role required	Super Admin
Prerequisites	CAST Imaging installed and running

Open the Multi-Tenant panel

In the Admin Center, click Tenants.

Create a tenant

Click Add tenant.
Enter a name for the tenant.
Click Save.

[TODO: Screenshot]

The new tenant is empty. Add applications and users to it.

Move an application to a tenant

[TODO: Steps to move an application from one tenant to another]

Manage Applications in the Admin Center

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging administrator
Role required	Admin or Super Admin
Prerequisites	Applications imported via the ETL process

Open the Applications panel

In the Admin Center, click Applications.

Configure application aliases

An alias is an alternative name for an application. Use aliases when the application name in the analysis results differs from the name used by the team.

[TODO: Steps to add and manage aliases]

Manage Licenses

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging administrator
Role required	Super Admin
Prerequisites	CAST Imaging installed; license key received from CAST

Enter a license key

In the Admin Center, click License.
Paste the license key into the field.
Click Update.

[TODO: Screenshot of the License panel]

Check license consumption

The License panel shows:

License type and expiry date
Number of applications allowed and currently active
Features enabled by the license (for example, AI, multi-tenant)

Licence-gated features

Some features require a specific license type:

Rebuild the Search Index

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging administrator
Role required	Admin or Super Admin
Prerequisites	CAST Imaging running

When to rebuild the index

Rebuild the search index if:

Objects that exist in the graph do not appear in search results.
Search results contain objects that were removed in a re-import.
After a major upgrade, search results are incomplete.

Rebuild the index

In the Admin Center, click Search.
Click Rebuild index.
Wait for the rebuild to complete. This may take several minutes for large applications.

[TODO: Screenshot of the Search panel]

Configure the Audit Trail

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging administrator
Role required	Super Admin
Prerequisites	CAST Imaging installed

Enable the audit trail

[TODO: Steps to enable the audit trail in the configuration file or Admin Center]

What is logged

When enabled, the audit trail logs:

User login and logout events
Application access events
Changes to users, roles, and tenant settings
Admin Center configuration changes

[TODO: Full list of logged events]

Manage Neo4j

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging administrator
Role required	Local server admin; Super Admin for the Admin Center actions
Prerequisites	CAST Imaging installed and running

Export graph data

Export the Neo4j data to move it to another server or to create a backup.

[TODO: Steps to export Neo4j data — using the Admin Center or the neo4j-admin dump command]

Import graph data

Import a Neo4j data export into an existing or new instance.

Manage the PostgreSQL Database

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging administrator, DBA
Role required	PostgreSQL superuser; Super Admin for Admin Center actions
Prerequisites	CAST Imaging installed

Back up the database

[TODO: Steps using pg_dump or CAST Storage Service backup tool; recommended backup schedule]

Restore the database

[TODO: Steps using pg_restore; how to verify a successful restore]

Change the PostgreSQL password

[TODO: Steps to change the database password and update the CAST Imaging configuration to use the new password]

Configure CAST Extend

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging administrator
Role required	Admin or Super Admin in AIP Console
Prerequisites	AIP Console installed

Online mode (internet access)

In online mode, AIP Console downloads extensions directly from the CAST Extend cloud service when they are needed.

[TODO: How to verify that online mode is active; how to check for extension updates in AIP Console]

Offline mode (no internet access)

In offline mode, you use a local CAST Extend server. See Install an offline extension server.

Monitor and Tune Performance

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging administrator
Role required	Super Admin; local server admin
Prerequisites	CAST Imaging installed

Diagnose slow graph loading

If the canvas takes a long time to load, or shows a “Failed to get graph data” error:

Check Neo4j memory settings. See Manage Neo4j.
Check the CAST Imaging logs for timeout or memory errors. See Enable logging [TODO: update link].
If the error persists, see Graph fails to load.

Adjust Neo4j buffer size

Increase the Neo4j page cache for applications with large graphs.

Customize Session and Port Settings

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging administrator
Role required	Local server admin
Prerequisites	CAST Imaging installed

Change the session timeout

The default session timeout is [TODO: default value] minutes. Users are logged out after this period of inactivity.

[TODO: Configuration file location and parameter; steps to apply the change]

Change the front-end web server port

By default, CAST Imaging listens on port 8083 (HTTP). To use a different port:

Configure Dashboards

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging administrator
Role required	Admin or Super Admin
Prerequisites	CAST Imaging installed; dashboard data source configured

Enable dashboard tiles

[TODO: Steps to enable dashboard tiles in the Admin Center — what data source is needed, configuration steps]

Customize the displayed metrics

[TODO: Which metrics can be shown; how to select them; where the configuration lives]

Disable dashboard tiles

[TODO: Steps to hide dashboard tiles from the viewer for specific tenants or all users]

Automate Deployment and Import

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	DevOps engineer, CAST Imaging administrator
Role required	Admin or Super Admin; API key required
Prerequisites	CAST Imaging installed; API key generated (see Manage users)

Imaging CLI

The Imaging CLI is a command-line tool for automating common tasks.

[TODO: Download location; authentication with API key; available commands]

Common commands:

Command	Purpose
`imaging import`	Trigger an application import
`imaging report`	Generate a report
`imaging snapshot`	Promote a snapshot

[TODO: Full command reference and examples]

Back Up and Restore

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	CAST Imaging administrator
Role required	Local server admin
Prerequisites	CAST Imaging installed and running

What to back up

Component	What to back up
Neo4j	Neo4j data directory (graph database)
PostgreSQL	All CAST databases (analysis results, AIP Console data)
Configuration	CAST Imaging configuration files
Saved views and annotations	Stored in Neo4j and PostgreSQL — covered by the above

Backup frequency

Component	Recommended frequency
Neo4j	Daily
PostgreSQL	Daily
Configuration	After every configuration change

Back up Neo4j (Windows)

[TODO: Steps using neo4j-admin dump or the backup tool; stopping the service if required]

Uninstall CAST Imaging

Mon, 01 Jan 0001 00:00:00 +0000

Before you start


Who this is for	IT administrator
Role required	Local administrator
Prerequisites	Back up all data before uninstalling. See Back up and restore.

Data loss warning

Uninstalling CAST Imaging removes all configuration files. Neo4j and PostgreSQL data may also be removed depending on the steps below. Back up everything before proceeding.

Windows installation

Remove components in this order:

CAST Imaging
AIP Console
AIP Node and AIP Core
CAST Storage Service (PostgreSQL)

[TODO: For each component — Control Panel / Programs, or specific uninstaller location; registry keys and data directories to clean up]