ARCAD Discover Training Guide PDF

Training Guide ARCAD Discover Course Overview About Arcad Discover Prerequisites & installation Web interface Administration Repository Architecture Code Common parameters About ARCAD Discover Visualizing IBM i applications in their graphical form ARCAD Discover of...

Training Guide ARCAD Discover Course Overview About Arcad Discover Prerequisites & installation Web interface Administration Repository Architecture Code Common parameters About ARCAD Discover Visualizing IBM i applications in their graphical form ARCAD Discover offers a unique way to get an overview of the objects and their cross-references, as well as to visualize all the programs in a graphical form. A graphical display is an efficient way to understand what constitutes an IBM i environment and the relationships between the different components. Using ARCAD Discover, you can view : Objects in input/output diagrams (cross-references), A personalized macroscopic view with the objects of your choice, and System programs. ARCAD Discover in Arcad for DevOps journey Prerequisites & Installation Prerequisites & Installation The ARCAD Discover Web Interface requires to have its ARCAD Discover Server installed. The ARCAD Discover Server installer is available for any platform (IBM i, Linux or Windows). Arcad Server must be installed to synchronise existing Arcad application. For this course, ARCAD Discover is installed on an IBM i Development Partition. Prerequisites & Installation Web Interface Run the application Once the installation is completed, open a web browser and access to ARCAD Discover via the following URL: :/discover. Replace by the DNS name of the machine where your ARCAD Discover server is installed, if you do not work locally. When you log in for the first time, you are requested to change the default password of your application. Run the application Administration Administration To open the Administration view containing all the configuration parameters, click the settings Administration icon Administration The Administration view has five panels, also accessible by the menu on the left : Administration – Server Settings AI Model API settings – Configuration for code diagram Sets the API token used to connect to OpenAI Sets the version of OpenAI GPT model to use. Sets the URL for the API endpoint used to interact with the LLM. Sets a specific question to ask ChatGPT. Disable/enable AI Nota : Large Language Model (LLM) configuration information is a type of artificial intelligence model designed to understand, generate and manipulate human language at an advanced level. Several models can be used. See https://platform.openai.com/docs/models Administration – Server Settings AI Model API settings – Configuration for AI Assistant Sets the API token used to connect to OpenAI Sets the version of OpenAI GPT model to use. Sets the URL for the API endpoint used to interact with the LLM. Temperature of the responses of LLM Disable/enable AI "LLM temperature" refers to a parameter that controls the variability and creativity of responses generated by Large Language Models (LLMs): Low temperature (e.g., 0.2): the model produces more conservative and coherent responses by choosing the most probable words, making the output more predictable and accurate. High temperature (e.g., 0.8 or higher): the model becomes more creative and diverse in its responses, choosing from a broader range of words. This can introduce more originality and variation but also increases the risk of less precise or coherent responses. Administration – Server Settings Licence key : license key information to be provided in future versions of the ARCAD Discover web application Administration – Server Settings Functional settings : Synchronisation settings, Arcad repository version terminals to be synchronized Administration – Server Settings Healthcheck : URL of Arcad server HealthCheck and Grafana (needs to be configured before) Administration – User Managment Manage Active/Inactive Users and their rights : Administration – User Managment Set up profiles of users : Administration – IBM I DATA SYNC. When you run ARCAD Discover for the first time, you must configure the product to connect it to an IBM i environment to later use it. Create a new ARCAD connection by clicking button to open the ARCAD Connector Settings wizard and fill the required information. Administration – IBM I DATA SYNC. After, you can load all the applications contained in the IBM I server set in the ARCAD connection and synchronize your data step by step. Some options are applied to all applications : Administration – IBM I DATA SYNC. The first step is to load the list of the application, by clicking on You can load the data Xrefs, programs DBLinks and functional tree, application by application. To do so, many buttons on every application are available on each line: Load XRefs Load DBLinks Load Refresh All Reset Status Functional trees Administration – IBM I DATA SYNC. Some informations about the load of each applications are displayed : Administration – UI Settings This settings section configures the shapes and colors of each blocks contained in a diagram by type and type of object. You can change the appearance of each element by modifying its background and text color, opacity and shape. A default configuration is provided when the installation is complete, that you can customize by editing the existing elements or adding new ones. Administration – UI Settings  Administration – Functionnal Trees In ARCAD Discover, Functional Trees are used to break down complex functions, processes, or systems into more manageable components. They structured hierarchically, starting with a main function that is then divided into various sub-functions or tasks, identifying all the dependencies and relationships. They also enhance team communication by providing a common reference point and facilitate project monitoring and control. The Functional Trees include several interface components for creation and edition, and then to populate them. The Functional Tree toolbar allows adding or deleting trees, while the Areas toolbar is used to add nodes to a selected Functional Tree. Administration – Functionnal Trees Repository Repository Repository - Overview The Repository menu in ARCAD Discover lets you explore and visualize all your components within their repositories, using high- level diagrams. This functionality is designed to enhance the understanding of the relationships and hierarchies among various components, allowing more effective management and analysis of application structures. Repository – Overview Repository – Overview From the Repositories menu, select an Application from the ones available in the drop-down list. This list is automatically populated with loaded applications. The list of components contained in this application are displayed. You can check one, several or all the components in the list, then select the type of diagram you want to have them displayed in: Component, IO, Flow, Code or Database. Result The components selected from the detailed list of your repository are displayed into a diagram. Repository – Component filters You can easily filter components into the query filter toolbar above the table, for example, you can search the component “SAMMNU” like this: Query values are case sensitives Repository – Component filters It is also possible to create and save component filters. Click on the add button close to the filter title and create a new one : Repository – Component filters Click on your new filter to display the list of the components Repository – Component Diagrams The Component Diagram view centralizes detail information on a specific component. This view displays a component as a static diagram, with the number of relation it has with other components by their source type. The information displayed and the way they are displayed depend on the type of component selected. Before you start displaying the diagrams of components, you have to configure your ARCAD Discover Web Application. Repository – Component Diagrams ARCAD Discover can manage seven categories of component diagrams : Physical file Logical file Device file Service program Module Program Calling menus Repository – Component Diagrams For example, let’s display the component diagram of “ART200”, check the line of the component and click on the button : Repository – Component Diagrams The component diagram of “ART200” is displayed like this : Repository – Component Diagrams You can expand each categories with the button Repository – Input/Output Diagrams The Input/Output diagrams are intended to graphically represent interactions, either : between a program and the files it uses, or between a file and the programs that use it. Before you start displaying the diagrams of components, you have to configure your ARCAD Discover Web Application. Repository – Input/Output Diagrams The diagram page allows you to visualize one or several components on your system, with their cross-references. To display a diagram, you have to select a source application and one component in the list of available ones for each application. Then click on the I/O diagram button on the top left :  Repository – Input/Output Diagrams ART200 *PGM I/O Diagram ARTICLE *FILE I/O Diagram Architecture Architecture Architecture – Flow Diagrams Architecture – Flow Diagrams Flow Diagrams are a representation of the interactions between different types of components. They can include use and calling links. Before you start displaying the diagrams of components, you have to configure your ARCAD Discover Web Application. Architecture – Flow Diagrams Click on your filter and select a component Architecture – Flow Diagrams Then choose which components you want to display in the next two lists of Used or called and callers or callees (scroll down to view the second list) Architecture – Flow Diagrams Architecture – Screen Diagrams Displays, in an IBM i (5250) screen format, an object identified by the DSPF or PRTF type value. Accessible only by a right click on.dspf component type. Architecture – Screen Diagrams Each format is displayed on the list and identified by its name, description and the line number(s) where it is positioned. Check one or several elements from the list to have it displayed in the 5250 screen. Architecture – AI Assistant Architecture – AI Assistant The ARCAD Discover AI Assistant is an advanced tool integrated directly into the Web Interface. This tool is specifically designed to simplify the process of exploring and understanding complex architectures. It allows you to interact with your ARCAD repository, using natural language queries. The AI Assistant interprets your queries and generates visual diagrams or tables of specific software components from your repository, providing a unique and efficient way to manage these components and making the process more accessible and intuitive. Architecture – AI Assistant Architecture – AI Assistant This AI Assistant has Natural Language Processing (NLP) capabilities, enabling it to understand and process queries in natural language, which means that it is not necessary for you to learn specific commands or syntax, turning this AI Assistant into a more intuitive and user-friendly tool. Architecture – AI Assistant The AI Assistant provided by ARCAD Discover can give you two types of responses : A visual representation of a component in a diagram, with the possibility to have access to its dependencies and relationships, or A table format to display a list of components. Architecture – AI Assistant For example, list 5 components with no dependencies : This query returns a list of 5 random components that have no dependency and displays them into a table detailing Object Type, Library and Source File. Architecture – AI Assistant Another example, find all components that are directly connected to SAMMNU. This query returns a list of components linked to the menu “SAMMNU” Architecture – AI Assistant If you choose the first component and generate a flow diagram : Architecture – AI Assistant You can directly generate diagrams, for example, search « Path ARTICLE1 **/*FILE » Returns a diagram, with ARTICLE1 as a starting point, as well as its dependencies, if they exist. Architecture – Database Diagrams Architecture – Database Diagrams Before working with database relationships in ARCAD Discover, you need to run commands to be able to calculate the database relationships of your application. From the IBM I, run the following ARCAD commands: The AUPDPFKEY command is used to generate primary keys that will be used to calculate the database relationships based on the Arcad fields repository. The AUPDFLDDBR command is used to generate database links at the field level. You have to check “Yes” for “use field name” parameters to create relationships with the Arcad fields repository. Architecture – Database Diagrams Updating primary keys is used to generate primary keys that will be used to calculate the database relationships. The primary keys are calculated : For SQL tables : Primary key search Search in alphabetical order for the first index with the keyword ‘UNIQUE’. If not found : Alphabetical search of the first index For PF : Search in alphabetical order for the first logical file with the keyword ‘UNIQUE’. If not found : Search alphabetically for the first logical file Calculate Arcad database relationships consist to find/guess the primary keys found by the previous step in the files of a repository. Architecture – Database Diagrams Select a filter and choose a file, for example “ARTICLE”, and click ok : Architecture – Database Diagrams Discover generates a relational database diagram of the file “ARTICLE” : Architecture – Macroscopic views  Architecture – Macroscopic views Macroscopic View diagrams provide a high-level analysis of your application’s architecture, showcasing its components and their dependencies. These views are essential to understand the overall structure and interactions of components within your system. ARCAD Discover enables you to visualize Macroscopic Views, using Functional Trees, as they are closely linked to them. Before you can see your application in a Macroscopic View, you need to create Functional Trees, which categorize your application’s components into specific groups and nodes. Each category within a Functional Tree displays the number of components it includes, and these components are attached to their categories through other diagrams.  Architecture – Macroscopic views In this example, the functional tree “ERP” is created in Discover like this :  Architecture – Macroscopic views You can also retrieve existing functional trees from Arcad metadata, example here with “JMG04” : Note : you can manage components only in “Local” functional trees created by Discover.  Architecture – Macroscopic views To add some components in my “local” functional trees, you can ask to the IA assistant to give me a list of the components directly linked to the file “ARTICLE” and choose the button “Add components to functional tree node” :  Architecture – Macroscopic views After setting up the Functional Trees and attaching components to their respective categories, you can have them displayed in the Macroscopic Views and explore each component’s dependencies. This facilitates a thorough understanding of how different parts of your application interact with one another. Select the application and the functional tree Architecture – Macroscopic views  Architecture – Macroscopic views Once the Macroscopic View is displayed, you can reorder and rearrange it according to your needs: Move a Node into another, by drag and drop. To move multiple nodes, press CTRL and click the Nodes to move. Click OK to confirm the move. Resize the Node blocks to have all of them displayed and fill the diagram page. If there are multiple groups at the intersection, the system selects the furthest child node in the diagram.  Architecture – Macroscopic views ARCAD Discover offers some essential vizual tools to give you all the information you need : Child-nodes are always displayed within their original node. Double-click on a Node or a component to have all its relationships displayed, which are shown as dotted red lines. On each link between Node to Node or component to Node, the number of links incoming or outgoing for a relation are displayed. The thickness of the link illustrates the number of links, the more there are links between nodes, the thicker the lines get. The edges, color and thickness of the Nodes change according to the component selected. Code diagrams Code diagrams The Source Code Analyser diagrams provide RPG, RPGLE and other IBMi programs in a diagram form. Before you start displaying the diagrams of components, you have to configure your ARCAD Discover Web Application.  Code diagrams Example of the code diagrams of “ART200.rpgle” :  Code diagrams In the Code diagram view, the elements displayed are called blocks. A block is either: the main procedure, a sub-procedure, or a subroutine. If one of the blocks is a subroutine, you can expand or collapse the subroutine in the current diagram using a simple double-click on the text called Routine. You can also open the subroutines individualy on new window. To do so, click on the subroutine block, then click the Open Subroutine button. The subroutine is then displayed, and you can go back to the Code diagram page by clicking the Collapse Sub-routine button. Code diagrams Some block types serve specific functions and are displayed distinctly to differentiate them from the others. Common Parameters Common parameters - Filters Component Filters enables you to create and save a custom entry point for a user before displaying the component repository. Once after selecting an application, you can display all the components of the application by click on the filter icon Common parameters - Filters It is also possible to create and save component filters. Click on the add button close to the filter title and create a new one : Common parameters – Working list Working Lists enables you to select multiple components and add them to a working list for better organization and management. To create a new one, just click on the “add” button, type a list name and save. Common parameters – Working list In many diagrams, you have the possibility to add components in your working list by a right click on it : Common parameters – Diagrams You can rename and save Diagrams , click on the pen close to the title : Enter a name and clic on de disk to save : Add, remove or display the list of the diagrams by the following buttons on the right side : Common parameters – Diagrams The ARCAD Discover diagram application provides an interactive template, editable and customizable to change the display of the selected diagram. Refer to the table below for detailed parameters of each options. Questions?  Thanks for your attention Follow ARCAD on: Vers les vidéos de la chaine youtube Maâtura social media, tweet, twitter, social icon linkedin icon facebook, social media, social icon