CAST Imaging - User Guide on Documentation - V2

User Guide - Saving and accessing saved views

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

Info

Summary: Saved views are stored in memory and can be recalled at a later date for further investigation. This pages explains how to work with them.

Saving a view

To save a view, use the Save a view option in the User Guide - GUI - Investigate panel:

Info

It is possible to save a view from all scopes, including the User Guide - Application to Application dependencies scope.

User Guide - Reports

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

Info

Summary: information about the Report generation option available in CAST Imaging ≥ 2.7.0.

Introduction

The Report generation option provides the means to export a variety of raw data to CSV, XLSX, and JSON - available reports are listed below:

Info

Note that the reports may take a long time to generate if the current application is very large.

Data Sources

Relation between Objects And Data sources

For all links between objects and data sources (i.e. tables/views) available in the Application, the following information is provided:

User Guide - Creating a custom aggregation mode

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

Info

Available in CAST Imaging ≥ 2.3.x.

Introduction

When using CAST Imaging you can choose how your application is displayed using one of the default “aggregation modes” available out of the box (depending on the scope you choose) - these default modes are explained in User Guide - GUI - Investigate panel.

However, you may find that these default modes do not meet your requirements for displaying your application data. If so, you can create your own custom aggregation mode and display your objects as you have designed. For example, you can choose to display on specific object types and/or group specific object types together:

User Guide - Export view options

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

Introduction

Items in the current view can be exported in the following formats:

Format Description Notes

CSV

Export list of objects/relationships in CSV format

The following information is exported:

Source FullName, Source Name, Source Type, Tags, Documents, Caller, Callee, Linked Objects, Cyclomatic Complexity, Raw SQL Complexity, Essential Complexity, Number of code lines, Number of heading comment lines, Number of inner comment lines, Object File Name, Link Direction, Access Link Type, Target, Target FullName, Target Name, Target Type, Module, Service, Subset

User Guide - OpenAI Integration

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

Info

Available in ≥ 2.16

Introduction

Note

IMPORTANT: This feature is available only if your CAST Imaging administrator has entered an OpenAI / Azure OpenAI API key for your organization in the License management panel in the Admin Center. Your administrator must ensure that sending snippets of source code to OpenAI / Azure OpenAI is allowed by your organization. By entering an OpenAI / Azure OpenAI API key, the administrator enables CAST Imaging user to be able to send snippets of source code to OpenAI / Azure OpenAI, via the CAST Imaging interface. CAST Imaging does not provide any specific governance of such use.

User Guide - Tutorial

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

Note

Available in ≥ 2.2.0-beta1.

The Tutorial feature is an interactive guide to help you understand the various features available in CAST Imaging. It provides an application walkthrough using three major steps to explain application architecture, drill down capabilities and annotations. Each step has a set of actions defined for you to work through. Certain actions also have a help button to identify the elements. Following all the steps and actions will provide a better understanding of the core CAST Imaging capabilities. The steps in the tutorial require that the dedicated “demo” Application is available in your CAST Imaging instance.

User Guide - Logging

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

Info

Summary: CAST Imaging is a collection of various components that function together. Each one of these components has its own logging mechanism and storage locations are listed below:

≥ 1.11.0

Microsoft Windows: %PROGRAMFILES%\CAST\ImagingSystem\logs
Docker Installer: logs

Log rotation

Starting CAST Imaging 2.9.0, the following logs are rotated and compressed:

imaging-etl.log
imaging-service.log

The rotation is actioned as follows:

Max Size: 10 megabytes - after which a new log file is created
Max Backups: 30 - number of previous rotated logs that are retained
Max Age: 28 days - the duration previous rotated logs that are retained

≤ 1.10.0

Component

Description

Log location

ETL

User Guide - FAQ

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

Why can’t I see a transaction in CAST Imaging?

If a transaction does not have an end-point, then this is classed as an empty transaction and this type of transaction is never shown in CAST Imaging. In this instance you should investigate using Application - Transactions in CAST Console, or the legacy TCC - CAST Transaction Configuration Center to try to understand why there are no end-points.