# About This Document This manual (help system) describes how to use this manual and the limitations related to the descriptions in this manual. Please be sure to read it carefully. # Document usage This section describes how to use this document (CGI Studio Documentation). #### Structure of this document This document consists of the following four levels.

Shelves	This is a large classification. It corresponds to the role of bookshelves in a library.
Books	This is a middle classification within the large category. It corresponds to the role of books arranged in the bookshelf, which is a large classification.
Chapters	This is a small classification that bundles the Pages placed in the Books, a middle classification.
Pages	This is an actual document is described. Pages are classfied according to its usage by Chapters/Books/Shelves.

When this manual is launched, a list of Shelves is displayed, and from Shelves, you can navigate to Books and Chapters/Pages as child hierarchies to browse the desired document. #### User Interface

1	CGI Studio Documentation	CGI Studio Documentation button. Clicking this button will take you to the Shelves screen. At the right of this logo, the version of CGI Studio currently in use is displayed.
2	Search field	You can search the entire document for keywords. See [Keyword Search](#bkmrk-keyword-search) for more information.
3	Select button	You can select the content view style from Shelves or Books.
4	API document button	By clicking this button, a new window will open to display API documents. Note that this button will not be displayed if the API documentation is not available (a blank page will be displayed when you click the link to the API documentation item in the documentation).
5	Back/Forward	Click this button to go backward or forward in the displayed content. When not in use (when no page movement has occurred), this button is greyed out.) See [Document navigation](#bkmrk-document-navigation) for more information.
6	Contents search	Performs a keyword search on the text currently displayed on the offline document screen. Search results are highlighted in yellow. See [Contents search](#bkmrk-contents-search-%28cgi) for more information.
7	Bookmark registration button	When any content (Shelves/Books/Chapters/Pages) is displayed, click this button to add a displayed content to the Bookmark. When Bookmark is registered, the button turns blue.
8	Recent Views	Shelves, Books, and Chapters/Pages that you have viewed in the past will be listed. See [Recent Views](#bkmrk-recent-views) for details.
9	Content display area	Contents are displayed. When you navigate to a page, you will see the document.
10	Sort	Items displayed in the contents display area can be sorted by any criteria. The sorting conditions can be selected from "Name", "Created Date", and "Updated Date". You can also switch the sort order from descending to ascending by clicking the up/down arrows on the right side of the pull-down menu.
11	Actions	Switches the display style in the contents display area to List or Grid view. This section is displayed only when display Shelves or Books.
12	Bookmark	Items registered using the Bookmark registration button will be displayed.
13	Scroll up button	It will appear automatically when you scroll down the displayed content. Scroll up to the top of the page by clicking this button.

#### Document navigation Except in particular cases, Sleves is usually displayed. Navigate by clicking on the title of Books and Chapters/Pages to be viewed, in that order. ##### Scroll up button/Home Key operation When viewing a document, press Scroll up button displayed in the lower right corner of the screen, or the Home key to go to the beginning of the currently displayed page. This will make it easier to access [Breadcrumb](#bkmrk-breadcrumb), [Back/Forward buttons](#bkmrk-back%2Ffoward) and the [S](#bkmrk-keyword-search)[earch field](#bkmrk-keyword-search).

##### Bookmark By clicking on the Bookmark registration button, you can register the currently displayed content in the Bookmark field. If the currently displayed content is not yet registered as a bookmark, its color is gray. When the content is registered (by clicking on the Bookmark registration button), the color changes to blue.

##### Breadcrumb When you move through the hierarchy, the path to the current display location is shown at the top of the content display area. To go back in the hierarchy, click on this path.

##### Recent Views When you return to Shelves, your browsing history will be displayed on the left side of the screen, showing the books/chapters/pages you have moved to. By clicking anywhere in there, you can move to the target location. You can delete the entire browsing history by clicking the \[ CLEAR \] button at the bottom of Recent Views.

##### Page Navigation/Book Navigation On Pages view, Page Navigation/Book Navigation is displayed on the left side of the screen.

- - - - - Page Navigation displays a list of headings on the currently displayed page. By clicking on any heading, the article will move to the corresponding location. - Book Navigation displays a list of other Chapters/Pages in the book that contains the currently displayed page. Clicking on any Chapters/Pages title also switches the display to the corresponding location. By moving the mouse cursor over the page body or Page Navigation/Book Navigation, the display can be scrolled up and down respectively. ##### Back/Foward By clicking the "Back/Forward" button in the upper right corner of the screen, you can go back or forward through the content displayed on the screen based on your viewing history. If there is no page transition history, this button will be greyed out.

#### Keyword Search You can search for keywords by entering any string of text in the search field at the top of the document and pressing the Enter key. Up to 10 search results will be displayed. If there are more than 10 results, click the page number button at the bottom of the search results screen to display them. In addition, on the left-hand side of the search results page, there is \[ Content Type \] and \[ Exact Matches \] section, and by using these functions, you can narrow down and display the search results.

##### Content Type Keyword searches are performed for all categories (Page/Chapter/Book/Shelf). Therefore, you can narrow down your search to only those results that belong to the target category by re-selecting the category from the \[ Content Type \] field displayed on the left side of the search results screen and clicking \[ UPDATE SEARCH \]. (Orange-colored box in the above image) ##### Exact Matches To perform a regular expression search, enter keywords here and click \[ UPDATE SEARCH \]. Only the pages that match the keywords you enter will be displayed in the search results. To use this function, click the \[ Add \] button to display the search field and enter keywords. You can delete the target search field by clicking the \[ X \] button to the right of the search field. On the other hand, in the Search field, performing a regular expression search by enclosing the search keywords you enter in double quotation marks.

#### Contents search Search for keywords in the displayed contents. As you enter keywords, the keywords you entered will be highlighted in yellow (all text in the screen will be searched for). - Pressing the Enter key moves the input keywords (keywords that are currently displayed are highlighted in orange). - Press Shift+Enter to move the input keywords in reverse order. - Press Ctrl+F to move to the content search field.

#### Feedback At the bottom of each page is a feedback function. You can send us your comments directly about the content of the pages, such as the one below. - The description was very clear. - The description was not clear enough for me to understand the details of the feature or how to use it. You can submit your feedback by following the steps below. 1. At the bottom of the page, click the "Yes" or "No" button to the right of "Was this page helpful? 2. The "Tell us more" area (shown in the yellow area below) will appear. 3. In the text entry area, enter your opinion on whether or not you found the information useful. 4. Click the "Submit Feedback" button at the bottom of the text entry area. - Your feedback will be sent to Candera. 5. The currently displayed feedback input area will disappear. - If successful, the message "Thank you for your feedback" will be displayed. - Otherwise, "Sorry, connection to the server timed out." will appear if it cannot connect to the server.

#### Callouts In this document, statements that require special attention are indicated by the following two types.

Use for an information that should be conveyed incidentally in operations and configurations.

Use for an information that should be required an attention in operations and its configurations.

# Note on the contents All information in this document is subject to change or deletion without notice. The information contained herein is current as of the date of Release. Please note that the information may differ from the latest products and conditions. # Docs Agent The Docs Agent is an AI-powered chatbot designed to accelerate your search within the CGI Studio documentation. The conversational assistant can: - Summarize long documentation pages - Connect concepts across different pages - Point you to specific tutorials #### How to Access Click the **Docs Agent** icon at the bottom right of the screen (red box in the figure) to open the chat window (orange box).

#### How to use Clicking the **Docs Agent** icon described above opens a chat window on the documentation page. Here, we explain the UI of the initial screen shown immediately after launch and the screen where an answer is displayed after you submit a question.

1	Help button	A Help menu is available in the top bar of the Docs Agent window. From there, you can open the following information: - Help: Displays overview information about Docs Agent. - Privacy Policy: Launches a web browser and displays the [privacy policy](#bkmrk-privacy) information. - Third-Party: Displays third-party information (such as licenses).
2	Minimize button	Clicking this button closes the Docs Agent window.
3	Maximize / Restore button	Clicking this button maximizes the Docs Agent window. Click it again to restore the window to its original size.
4	Suggested prompts	Before you enter a custom prompt, suggested prompts are displayed. Clicking a suggested prompt inserts its content so you can ask a question immediately.
5	Chat input field	Enter your question in the chat input field and press ENTER to receive a response from Docs Agent.
6	Relevant Documents	Links to the documentation pages that Docs Agent referenced when generating the answer are shown. The numbers at the end of the answer indicate the corresponding source links as reference numbers. Clicking a number opens the associated source link and displays the referenced documentation page.
7	Action button	Action buttons are displayed below the response from Docs Agent. - Give feedback on last response: Send your feedback on the document content. - Copy to clipboard: Copies the response to the clipboard. - Clear history: Clears the chat history. - Retry last response: Re-runs the most recent question.

While the agent is optimized for accuracy, AI responses can occasionally be incorrect or misleading. Before proceeding with any implementation, always use the **source links** (see figure) to review the original article.

#### Troubleshooting If the Docs Agent icon is not visible, please check your internet connection or firewall settings. Occasionally, temporary service interruptions may also prevent the agent from loading. #### Privacy For privacy-related information, open **Privacy Policy** from the **Help** menu at the top of Docs Agent. When you launch Docs Agent for the first time, you will be asked to agree to the privacy policy. Unless you agree, no user data will be sent for external processing.