Editing a Stored Procedure

The text editor menu bar is shown in the following image.

The following functions are available.

• Save. Saves the current text under the same name.
• Save As. Saves the current text under a new name.
• Run. Runs the current text, if it is a procedure.
• Tab Navigation. Enables cycling through the interface using the Tab key.
• Find. Opens the search function.
• Selection folding. Folds unselected lines.
• Uppercase. Changes selected text, or the token with the cursor, to uppercase. A token is an unbroken string of alphanumeric characters and underscores.
• Lowercase. Changes selected text, or the token with the cursor, to lowercase. A token is an unbroken string of alphanumeric characters and underscores.
• Comment/Uncomment. Toggles comments on and off for the current line or selected lines.

  Note: If a line is already commented, and you click the Comment/Uncomment button, new comment characters are added in addition to the comment characters that already existed. In this way, if you click the button again, the line goes back to its original state (commented). This prevents you from unintentionally uncommenting a line that was meant to be a comment.

• Undo. Undoes any number of edits.
• Redo. Redoes any number of edits.
• Select All. Selects all of the text in the text editor.
• Options. Opens the text editor options dialog box.

Certain syntax components in FOCEXECs and Master Files are color-coded in the text editor.

• Strings are displayed in dark green.
• Comments are displayed in light green.
• FOCEXEC keywords are displayed in blue.
• Numbers are displayed in blue.
• Expression keywords are displayed in gray.
• Amper variables are displayed in light brown.
• SQL keywords are displayed in purple.

Clicking Find (magnifying glass) on the menu bar opens the search panel. Clicking the plus sign (+) under the Search for text box opens the Replace section, as shown in the following image.

The following Find options are available.

• Search for. Enter text in the input field. If you click the Regular Expression button (.*) at the bottom, enter a regular expression. If text is selected when you click Find, the text will automatically be entered in the Search for input field. When there is text in the Search for field, clicking the x next to the term deletes it.

  Note: The bottom row of the Find panel identifies which instance has the focus and the total number of matches found, in the form n of m.

  • Find previous (<)/Find next (>). Enables you to go from instance to instance of matching text.
  • All. Click All to highlight all matching instances and place a cursor on each of them for bulk deletion or replacement.
• Replace with. Enter replacement text in the input field.
  • Replace. Click Replace to replace the current instance.
  • All. Click All to replace all matching instances.
• RegExp Search (.*). Click .* to enter a JavaScript regular expression in the Search for input field.
• CaseSensitive Search (aA). Click aA to toggle between case sensitive and case insensitive search.
• Whole Word Search (\b). Click \b to toggle between accepting matches within words and whole words only. A word is an unbroken string of alphanumeric characters and underscores.
• Search in Selection (S). Searches within the current selection.

The following image shows a regular expression search for the characters colon, left brace, and left bracket, with the focus on instance 2 of 40.

To close the Find function, click x at the right of the Search for row.

Pointing to the down arrow at the right end of the text editor menu bar and clicking Text Editor Options opens the Editor Options dialog box, as shown in the following image.

The following options are available. Click the check box next to an option to toggle the selection on and off.

• Enable Code Folding. Code folding places down arrows next to certain commands and characters that flow onto multiple lines, so that you can compress them to hide their content. When code is folded, the arrow changes to a right-facing arrow that you can click to unfold the syntax. This option is selected by default.
• Enable Ctrl-Space Autocompletion. Provides a list of keywords available in the current context when you click the Ctrl key and the space bar together. This option is selected by default.
• Enable Live Autocompletion. Provides a list of keywords available in the current context whenever you place the cursor in the text editor at a point where a keyword is available and you start typing. This option is unselected by default.
• Highlight Active Line. Highlights the line with the cursor in yellow. This option is selected by default.
• Show Line Numbers. Displays line numbers to the left of each line. This option is selected by default.
• Color Theme. Changes the color theme for the current session. Choices are Light, which is the default, and Dark, which makes the background dark blue.

When you have finished selecting the options you want, click OK.

When code folding is enabled, certain commands and syntax components that flow onto multiple lines can be rolled up so their content is hidden. Lines that can be folded display a down arrow to the left of the line, as shown in the following image.

The following image shows the same content with the DEFINE FILE command folded.

The arrow next to the DEFINE FILE command has changed to a right-facing arrow. Clicking it unfolds the command.

The following commands and characters can be folded.

• DEFINE FILE.
• TABLE FILE.
• GRAPH FILE.
• MATCH FILE.
• MODIFY FILE.
• MAINTAIN FILE.
• SQL.
• Parentheses, braces, and brackets that open on one line and close on another line.
• SEGNAME/SEGMENT in a Master File.
• END in a Master File (this folds the DBA section of the Master File).

Custom folding enables you to choose the type of commands that you want to remain unfolded. This is especially useful when you open the Session Log, which contains all of the commands generated in your session.

To enable custom folding, click the down arrow on the text editor toolbar, and click Custom Folding....

The Custom Folding dialog box opens, as shown in the following image.

Check the boxes for the commands that you do not want to be folded. For example, DEFINE is checked for the following image that shows a file with comments, SET commands, a DEFINE command, and TABLE request.

If you previously implemented custom folding and want to remove it, click Remove Custom Folding. You can also unfold any folded text by clicking it.

Click OK.

If you make selections in the editor and click the Selection Folding button, all lines that were not selected are hidden so that only the selected lines display. The following image shows selection folding after searching for occurrences of the characters LITE in the WF_RETAIL_LITE Master File.

This feature is useful when you make multiple non-contiguous selections, so that you can easily view all of your selections. The button toggles selection folding on and off, so that once selections are folded, you can click the button again to unfold them.

Autocompletion opens a list of supported keywords as you enter text in the Text Editor. Autocompletion is context sensitive. That is, it will only display keywords available in the portion of the syntax that has the focus. If you select a keyword, autocompletion does not parse the syntax to make sure it is correct.

You can enable autocompletion on an as requested basis (Ctrl+Space autocompletion) or whenever you are entering text where a keyword is available (live autocompletion).

The following image shows an autocompletion list within a GRAPH FILE command.

Click a keyword on the list to insert it into the syntax.

The text editor Tab key navigation supports Section 508 Accessibility Compliance by enabling users to navigate through the interface using the Tab key on the keyboard.

To implement Tab key navigation, either press the Esc key when in a file open in the text editor, or click the Tab Navigation button on the toolbar that is shown in the following image:

Once you have enabled Tab key navigation, the icon on the button becomes hollow in the center, as shown in the following image.

With Tab key navigation enabled, pressing Tab cycles between the features on the page.

• If you press Tab from within a file open in the text editor, the focus moves to the URL bar at the top of the web page, then to the actual URL.
• Continuing to press Tab cycles to the buttons on the ribbon, with a change in color intensity identifying which button has the focus.
• After the ribbon buttons, the focus moves to the data tree, with a cursor or outline showing the position of the focus.
• From there, the focus moves to the text editor toolbar, indicated by a rounding of the edges of the button that has the focus.
• Pressing Enter selects the option that has the focus.

Using the server Compare Files and Merge Files options, you can compare or merge two files in the server text editor.

To compare or merge files, multi-select two files (by clicking one file, holding down the Ctrl key (or the Shift key if the files are contiguous) and clicking the second file), right-click, and select either Compare Files or Merge Files. Although both can show the differences, only Merge Files enables you to move content between the files. Compare Files is read-only.

Note: If the two files represent synonyms, selecting:

• Compare Files compares the Master Files.
• Compare Access Files compares the Access Files.
• Merge Files merges the Master Files.
• Merge Access Files merges the Access Files.

The files open in side-by-side panes. The differences are highlighted in light blue, with arrows indicating insertions and deletions. For Merge Files, the arrows let you copy lines between the files.

When the files first open, left and right scrolling is locked to the first difference, aligned in the middle of the window (when the file sizes allow), as shown in the following image for Merge Files.

If you click an arrow to copy a line from one file to the other, the highlighting and arrow disappear once the line is copied.

You can use the following buttons to move between differences and control the merge process. The arrows for the current difference will be aligned and displayed with left and right scrolling locked.