> For the complete documentation index, see [llms.txt](https://docs.editran.onesait.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.editran.onesait.com/documentacion-editran/ibm-editran-v5.3-cics-en/operacion/onesait-editran-administrator/generic-profile-modification.md). # Generic profile modification This option allows you to make generic online changes to sessions. For use, it is recommended to first make a backup copy of the profile file. Initially, the following screen is shown: ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:32:17 GENERIC SESSION MODIFICATION | ----------------------------------------------------------------------------- | ********************************************************************** | | * THIS OPTION GENERICALLY MODIFIES EDITRAN PROFILES * | | * LOCAL CODE : SPECIFIC OR SPACES (ALL) * | | * REMOTE CODE: SPECIFIC OR SPACES (ALL) * | | * APPLICATION: SPECIFIC, SPACES (ALL) OR TEXT: XX* *XX X*X * | | * THE FIRST RECORD FOUND IS TAKEN AS THE IMAGE. * | | ********************************************************************** | | | | C ---> CHANGES THE VALUE OF PARAMETERS | | | | M ---> UNCONDITIONAL PARAMETER MODIFICATION | | | | OPTION.....................: C | | PRESENTATION SESSION | | LOCAL CODE.......: 0 0009994 0 (LOCAL CODE OR SPACES) | | REMOTE CODE......: (REMOTE CODE OR SPACES) | | APPLICATION.........: (APPL., SPACES OR TEXT) | | | | | ----------------------------------------------------------------------------- ``` In this option, data from a specific group of sessions is entered for which we intend to make the change or modification; for example, if in the presentation session string we select: ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:32:17 GENERIC SESSION MODIFICATION | ----------------------------------------------------------------------------- | ********************************************************************** | | * THIS OPTION GENERICALLY MODIFIES EDITRAN PROFILES * | | * LOCAL CODE : SPECIFIC OR SPACES (ALL) * | | * REMOTE CODE: SPECIFIC OR SPACES (ALL) * | | * APPLICATION: SPECIFIC, SPACES (ALL) OR TEXT: XX* *XX X*X * | | * THE FIRST RECORD FOUND IS TAKEN AS THE IMAGE. * | | ********************************************************************** | | | | C ---> CHANGES THE VALUE OF PARAMETERS | | | | M ---> UNCONDITIONAL PARAMETER MODIFICATION | | | | OPTION.....................: C | | PRESENTATION SESSION | | LOCAL CODE.......: *4 0 (LOCAL CODE OR SPACES) | | REMOTE CODE......: (REMOTE CODE OR SPACES) | | APPLICATION.........: tel* (APPL., SPACES OR TEXT) | | | | | ----------------------------------------------------------------------------- ``` We will be indicating that the selection is made for all sessions that meet the criterion: ``` // | LOCAL CODE..: * ******4 0 REMOTE CODE.: * ******* * APPLICATION.: TEL*** |, ``` In short, the selection is made for all sessions whose local code ends in 40, with any remote code and with applications that begin with TEL It is necessary for at least 1 session in the profile file to meet the previous criteria. In turn, we can choose 2 options: * C- Change to. A set of value parameters to check is shown to us, by default taken from the first session that met the selection criteria (we can change that default proposal), and the same values are shown as the change value (output) (we can also change them). The changes we select will affect the sessions that meet all the previous criteria. * M- Unconditional modification. A parameter value to modify is shown to us (input), by default taken from the first session that met the selection criteria (we can change that default proposal and enter the value we want to modify unconditionally). The procedure to be followed is as follows: * The parameter(s) to change/modify are selected by entering the change/modification value(s). * Once the changes to select have been finished, press ENTER, and n screens appear showing the sessions that meet the selection criterion, with a comment indicating whether the change will be made or not. These screens are informative of what is going to be done. * At any time while viewing the previous sessions, pressing PF2 will perform the mass change. In short, the process can also be used as a query, since if we do not end up pressing PF2, the data will not be updated and we will be able to see sessions that meet a certain criterion. For example, if we select the TRACE parameter and indicate that value S should be changed to N, in the list of sessions we will be able to distinguish those that have value S from those that have value N, all without needing to update them (PF2). If entered through CHANGE, the following screens will be shown (you can mark as many parameters to change as you wish, and to continue on the subsequent screens, PF8 must be marked): ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:33:29 PARAMETER CHANGE | ----------------------------------------------------------------------------- | SINGLE PARAMETER. SELECT THE PARAMETER(S) AND ENTER NEW VALUES. | | S PARAMETER VALUE TO CHECK CHANGE VALUE | | - ----------------------------- ------------------- ------------------- | | N REMOTE VERSION (N.N)......... 5.2 5.2 | | N BUFFER FILE VOLUME OR POOL.. V V | | N TRANSMISSION VOLUME........... DES801 DES801 | | N RECEPTION VOLUME......... DES801 DES801 | | N BUFFER RECORD COUNT...... 00001000 00001000 | | N DELETE RECV. FILE IF THEY EXIST. S S | | N RECV. FILE CATALOGING TYPE. U U | | N RECEPTION VOLSER.......... | | N VOLSER UNIT............... | | N DOWNLOAD FILE FORMAT (F/V/E) V V | | N SINGLE RECEPTION FILE (S/N) N N | | N WORK UNIT NAME....... SYSDA SYSDA | | N DOWNLOAD FILE LREC........... | | | | | | EXIT, MODIFY, ADVANCE | ----------------------------------------------------------------------------- ``` ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:33:39 PARAMETER CHANGE | ----------------------------------------------------------------------------- | SINGLE PARAMETER. SELECT THE PARAMETER(S) AND ENTER NEW VALUES. | | S PARAMETER VALUE TO CHECK CHANGE VALUE | | - ----------------------------- ------------------- ------------------- | | N SAVE SYSTEM LOG (S/N).. S S | | N WORK VOLUME OR POOL (V/P). V V | | N VOLUME NAME........... DES801 DES801 | | N ADJUST FILE SPACE (S/N)... N N | | N PREVIOUS PROCESS TO EMISSION G...... ZTBGP1CD ZTBGP1CD | | N PREVIOUS PROCESS TO RECEPTION G.... ZTBGP2CD ZTBGP2CD | | N POST PROCESS TO EMISSION G... ZTBGP3GD ZTBGP3GD | | N POST PROCESS TO RECEPTION G. ZTBGP4GD ZTBGP4GD | | N STATE CHANGE PROCESS G.. ZTBGP6CD ZTBGP6CD | | N LOAD TYPE (N/A/Q)........ N N | | N DIVISION CRITERION (V/S/N). N N | | | | | | | | | | EXIT, MODIFY, ADVANCE, BACK | ----------------------------------------------------------------------------- ``` ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:33:51 PARAMETER CHANGE | ----------------------------------------------------------------------------- | SINGLE PARAMETER. SELECT THE PARAMETER(S) AND ENTER NEW VALUES. | | S PARAMETER VALUE TO CHECK CHANGE VALUE | | - ----------------------------- ------------------- ------------------- | | N CRYPTOGRAPHY (S/N)........... N N | | N CRYPTOGRAPHIC VERSION (N.N).. | | N DATA ENCRYPTION ALGORITHM... | | N AUTHENTICATION ALGORITHM...... | | N LOCAL SUBSYSTEM............. | | N REMOTE SUBSYSTEM............ | | | | VALUE TO CHECK | | N L.CODE: | | N R.CODE: | | CHANGE VALUE | | L.CODE: | | R.CODE: | | | | | | EXIT, MODIFY, ADVANCE, BACK | ----------------------------------------------------------------------------- ``` ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:34:01 PARAMETER CHANGE | ----------------------------------------------------------------------------- | SINGLE PARAMETER. SELECT THE PARAMETER(S) AND ENTER NEW VALUES. | | S PARAMETER VALUE TO CHECK CHANGE VALUE | | - ----------------------------- ------------------- ------------------- | | N TRANSFER ON RECEPTION (A/E/N) E E | | N CLEAR BUFFER AFTER SEND.(S/N). S S | | N CLEAR BUFFER AFTER RECV.(S/N). S S | | N REQUEST DOWNLOAD ACK(S/N) N N | | N WAIT TIME (MINUTES)... | | N LZW ADJUSTMENT PERCENTAGE (0-99). | | N PREV. USER PROGRAM TO EMISSION... | | N PREV. USER PROGRAM TO RECEPTION. | | N USER PROGRAM AFTER EMISSION | | | | | | | | | | | | | | EXIT, MODIFY, ADVANCE, BACK | ----------------------------------------------------------------------------- ``` ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:34:12 PARAMETER CHANGE | ----------------------------------------------------------------------------- | SINGLE PARAMETER. SELECT THE PARAMETER(S) AND ENTER NEW VALUES. | | S PARAMETER VALUE TO CHECK CHANGE VALUE | | - ----------------------------- ------------------- ------------------- | | N USER PROGRAM AFTER RECEPTION.. | | N EXCEPTION USER PROGRAM..... | | N USER EXIT PROGRAM... | | N TRANSMISSION CONVERSION TABLE..... | | N RECEPTION CONVERSION TABLE... | | | | VALUE TO CHECK | | N MAC PARAM: | | N RECV. APPL. FILE DSN: | | N INSTALLATION PREFIX..: KI.EIDC | | CHANGE VALUE | | MAC PARAM: | | RECV. APPL. FILE DSN: | | INSTALLATION PREFIX..: KI.EIDC | | | | EXIT, MODIFY, ADVANCE, BACK | ----------------------------------------------------------------------------- ``` ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:34:23 PARAMETER CHANGE | ----------------------------------------------------------------------------- | SINGLE PARAMETER. SELECT THE PARAMETER(S) AND ENTER NEW VALUES. | | S PARAMETER VALUE TO CHECK CHANGE VALUE | | - ----------------------------- ------------------- ------------------- | | N ALLOWED CONNECTION TYPE (I/Y/*) I I | | | | | | | | | | | | MULTIPLE PARAM. SELECT(S/N), ENTER VALUE AND INDICATE IF IT AFFECTS ANY POSITION | | LOCAL PROXY LINES -1- -2- -3- -4- -5- -6- -GEN.SEL- | | SELECTIONS N N N N N N N | | VALUE TO CHECK 001 000 000 000 000 000 N | | CHANGE VALUE 001 000 000 000 000 000 N | | N - DO YOU WANT TO MAKE CHANGES WITHOUT TAKING POSITIONS INTO ACCOUNT (S/N) | | | | | | | | EXIT, MODIFY, ADVANCE, BACK | ----------------------------------------------------------------------------- ``` The following screen only appears if something has been typed in the REMOTE CODE field ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:34:40 PARAMETER CHANGE | ----------------------------------------------------------------------------- | | | | | | | | | MULTIPLE PARAM. SELECT(S/N), ENTER VALUE AND INDICATE IF IT AFFECTS ANY POSITION | | REMOTE TCP/IP LINES -1- -2- -3- -4- -5- -6- -GEN.SEL- | | SELECTIONS N N N N N N N | | VALUE TO CHECK 001 000 000 000 000 000 N | | CHANGE VALUE 001 000 000 000 000 000 N | | N - DO YOU WANT TO MAKE CHANGES WITHOUT TAKING POSITIONS INTO ACCOUNT (S/N) | | | | | | | | | | | | | | | | | | EXIT, MODIFY, ADVANCE, BACK | ----------------------------------------------------------------------------- ``` ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:34:53 PARAMETER CHANGE | ----------------------------------------------------------------------------- | MULTIPLE PARAM. SELECT(S/N), ENTER VALUE AND INDICATE IF IT AFFECTS ANY POSITION | | VALUE TO CHECK | | S JCL CARDS | | - ---------------------------------------------------------------------- | | N //KIIMSGC JOB (SNCE,KIT,,99),99949998TELEGC,CLASS=A, <=CARD 01 | | N // MSGLEVEL=1,MSGCLASS=H <=CARD 02 | | N //* <=CARD 03 | | N //* <=CARD 04 | | N //* <=CARD 05 | | CHANGE VALUE | | //KIIMSGC JOB (SNCE,KIT,,99),99949998TELEGC,CLASS=A, <=CARD 01 | | // MSGLEVEL=1,MSGCLASS=H <=CARD 02 | | //* <=CARD 03 | | //* <=CARD 04 | | //* <=CARD 05 | | N - DO YOU WANT TO MAKE CHANGES WITHOUT TAKING POSITIONS INTO ACCOUNT (S/N) | | | | | | EXIT, MODIFY, ADVANCE, BACK | ----------------------------------------------------------------------------- ``` ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:35:04 PARAMETER CHANGE | ----------------------------------------------------------------------------- | SINGLE PARAMETER. SELECT THE PARAMETER(S) AND ENTER NEW VALUES. | | S PARAMETER VALUE TO CHECK CHANGE VALUE | | - ----------------------------- ------------------- ------------------- | | N VALID.CALL INDICATOR (L/R/X/N) N N | | N CALLING END (L/R/X)..... X X | | N TRAFFIC (E/R/X).............. X X | | N ROTATE ADDRESSES (L/R/X/N).. X X | | N AUTOMATIC CALL (S/N)..... S S | | N AUTOMATIC DISCONNECTION (S/N). S S | | N SYNCHRONIZATION (NNN)............ 020 020 | | N TRANSMISSION LENGTH (0252-4050). 4050 4050 | | | | | | | | | | | | | | | | EXIT, MODIFY, ADVANCE, BACK | ----------------------------------------------------------------------------- ``` ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:35:17 PARAMETER CHANGE | ----------------------------------------------------------------------------- | SINGLE PARAMETER. SELECT THE PARAMETER(S) AND ENTER NEW VALUES. | | S PARAMETER VALUE TO CHECK CHANGE VALUE | | - ----------------------------- ------------------- ------------------- | | N START TIME (HHMMSS)......... 000000 000000 | | N END TIME (HHMMSS)............ 000000 000000 | | N HOURLY WINDOW RETRY (X/E/R/N). N N | | N CONTROL TIME-OUT (MSS)....... 100 100 | | N DATA TIME-OUT (MSS)......... 100 100 | | N RETRIES (NNN)............. 004 004 | | N BUFFER FILE TYPE SEND (E/M/P/C/D) M M | | N BUFFER FILE TYPE RECV (E/M/C/D).. M M | | N SENDER BUFFER NAME......... ZTBPFEL ZTBPFEL | | N RECEIVER BUFFER NAME....... ZTBPFRL ZTBPFRL | | N EXCII NETNAME................ | | | | | | | | | | EXIT, MODIFY, ADVANCE, BACK | ----------------------------------------------------------------------------- ``` ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:35:28 PARAMETER CHANGE | ----------------------------------------------------------------------------- | SINGLE PARAMETER. SELECT THE PARAMETER(S) AND ENTER NEW VALUES. | | S PARAMETER VALUE TO CHECK CHANGE VALUE | | - ----------------------------- ------------------- ------------------- | | N RECEPTION UPDATE BURST.... 020 020 | | N PREVIOUS TO EMISSION P........... ZTBGP1CD ZTBGP1CD | | N PREVIOUS TO RECEPTION P......... ZTBGP2CD ZTBGP2CD | | N POST TO EMISSION P........ ZTBGP3GD ZTBGP3GD | | N POST TO RECEPTION P...... ZTBGP4GD ZTBGP4GD | | N EXCEPTION.................... ZTBGP5CD ZTBGP5CD | | N USER EXIT.............. | | N TRACE (S/N/C)................ C C | | N TCP-PX SEND BUFFER.......... 262144 262144 | | N TCP-PX RECEPTION BUFFER...... 262144 262144 | | N SESSION ENABLED (S/N)...... S S | | | | | | | | | | EXIT, MODIFY, GO BACK | ----------------------------------------------------------------------------- ``` If accessed through unconditional modification, the SAME screens are shown, with the following exceptions: * The literal “PARAMETER CHANGE” is replaced by “PARAMETER MODIFICATION” (1). * The literal “VALUE TO CHECK CHANGE VALUE” is replaced by the literal “VALUE TO MODIFY” (2) * The literal “VALUE TO CHECK” is replaced by the literal “VALUE TO MODIFY” (3) Example: ``` ------------------------------------------------------------------------------- | (1) PARAMETER MODIFICATION | |-----------------------------------------------------------------------------| | SEL PARAMETER (2)VALUE TO MODIFY | | --- ----------------------------- ------------------- ------------------- | | x ASCII-EBCDIC................. x (4) | | | | | | (3) VALUE TO MODIFY | | x PARM.: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | | | | | |-----------------------------------------------------------------------------| ``` Once the values of the parameters to change or to modify unconditionally have been marked, a first screen of sessions is always shown which, MEETING THE SELECTION CRITERIA, may or may not meet the criteria, with a literal indicating the corresponding error if one exists (the number of parameter selections made is also shown). Example: ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:35:28 PARAMETER CHANGE | ----------------------------------------------------------------------------- | SELECTION CRITERIA: 001 SELECTIONS MADE | | LOCAL CODE..: 0 0009994 0 REMOTE CODE.: * ******* * APPLICATION.: ****** | | SESSION OBSERVATIONS | | ------------------------ -------------------------------------------------- | | 000099940A00099940EDTRF2 ===RECORD NOT AFFECTED BY THE PROPOSED CHANGES | | 000099940A00099940PRBSWC >>>INCOMPATIBLE RECORD. RSA WITHOUT KEYS OR INTERFACE | | 000099940A00099940PRUEBA OK.=== VALID RECORD. PENDING UPDATE | | 000099940A00099940TELEGC OK.=== VALID RECORD. PENDING UPDATE | | 000099940A00099960TEXTOS OK.=== VALID RECORD. PENDING UPDATE | | 000099940A0009997AAPLICA OK.=== VALID RECORD. PENDING UPDATE | | 000099940A0009997ATELECA >>>INCOMPATIBLE RECORD. CRYPTOGRAPHY PARAMETERS | | 000099940A00099980ABEURA OK.=== VALID RECORD. PENDING UPDATE | | 000099940A00099980ABEURP OK.=== VALID RECORD. PENDING UPDATE | | 000099940A00099980PRUEBA OK.=== VALID RECORD. PENDING UPDATE | | 000099940A00099980TELECA OK.=== VALID RECORD. PENDING UPDATE | | 000099940A00099980TELEGC OK.=== VALID RECORD. PENDING UPDATE | | 000099940A00099980000001 OK.=== VALID RECORD. PENDING UPDATE | | | | EXIT, ADVANCE, UPDATE | ------------------------------------------------------------------------------- ``` 👉 If PF2 is pressed, it means that the administrator respects the Editran criteria, so all matching records are updated. At the end of the process, it returns to the initial screen, indicating whether it was updated: > **Update completed, xxx sessions modified out of xxx total sessions.** ⚠️Changes made with this option ignore whether the session has started connection processes, so in that case they do not take effect until those processes finish. ℹ️ Changes made with this option are more effective than batch modification, since they do not require closing and reopening the file in CICS. There are certain situations in which, at first glance, it seems that a modification can be made but in the end it will not be. For example, if within the selection there are 2 sessions that will end up having the same transport identifier, and that identifier is not assigned to any other session, it will seem possible to carry out the process for both, but that will not be the case, because in this case the first would perform the operation and the second would not. Example: In the event that we want to change, (for our local code 000099940, all presentation sessions with remote code 000044440) the parameters translate on send (EBCDIC to ASCII), translate on receive (ASCII to EBCDIC): The input option would be: ``` ----------------------------------------------------------------------------- | 24/06/2026 EDITRAN ADMINISTRATOR EDITRAN 5.3 | | 12:35:28 PARAMETER CHANGE | ----------------------------------------------------------------------------- | ********************************************************************** | | * THIS OPTION GENERICALLY MODIFIES EDITRAN PROFILES * | | * LOCAL CODE : SPECIFIC OR SPACES (ALL) * | | * REMOTE CODE: SPECIFIC OR SPACES (ALL) * | | * APPLICATION: SPECIFIC, SPACES (ALL) OR TEXT: XX* *XX X*X * | | * THE FIRST RECORD FOUND IS TAKEN AS THE IMAGE. * | | ********************************************************************** | | | | C ---> CHANGES THE VALUE OF PARAMETERS | | | | M ---> UNCONDITIONAL PARAMETER MODIFICATION | | | | OPTION.....................: C | | PRESENTATION SESSION | | LOCAL CODE.......: 0 0009994 0 (LOCAL CODE OR SPACES) | | REMOTE CODE......: 0 0004444 0 (REMOTE CODE OR SPACES) | | APPLICATION.........: (APPL., SPACES OR TEXT) | | | | | ------------------------------------------------------------------------------- ``` Then we would select the parameters to change (with PF8-PF7, we move forward to new parameters or go back) specifically Regarding the change described, it only affects the sessions that had the value to check identical to the one described. ``` | SEL PARAMETER VALUE TO CHECK CHANGE VALUE | | --- ----------------------------- ------------------- ------------------- | | N ORIGINAL DATA ALPHABET (A/E/N). E E | | S TRANSLATE ON SEND.......... N A | | S TRANSLATE ON RECEIVE........ N E | ``` Once we press ENTER, the sessions appear and what will happen if we commit: SESSION OBSERVATIONS | ``` | ------------------------ -------------------------------------------------- | | 000099940000044440TELEC1 ===RECORD NOT AFFECTED BY THE PROPOSED CHANGES | | 000099940000044440TELEC2 OK.=== VALID RECORD. PENDING UPDATE === | | 000099940000044440TELEC3 OK.=== VALID RECORD. PENDING UPDATE === | | 000099940000044440TELEC4 OK.=== VALID RECORD. PENDING UPDATE === | | 000099940000044440TELEC5 ===RECORD NOT AFFECTED BY THE PROPOSED CHANGES | | 000099940000044440TELEC6 OK.=== VALID RECORD. PENDING UPDATE === | | 000099940000044440TELEC7 OK.=== VALID RECORD. PENDING UPDATE === | ``` At this point, we can: Query ALL sessions (PF8-PF7) to see what happens with the proposed change. Commit, PF2, performing the operation. In that case (the process may take some time), we would return to the beginning and it would show us a message similar to the following: ``` | OPERATION COMPLETED. REC.UPDATED: 0016 OF 0018 TOT. | ``` This means the number of records updated out of a total that met the session selection requirements. If both numbers are not equal, it means that there are records that met the criteria but were not updated (record not affected by the proposed changes). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.editran.onesait.com/documentacion-editran/ibm-editran-v5.3-cics-en/operacion/onesait-editran-administrator/generic-profile-modification.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.