Using code entry help functions to create and edit processes

You can use different code entry help functions of the Application Engine Process Editor to create and edit a process.

To use code entry help functions:

  1. Open a process file. You can create a new process, load an existing process file from a folder, or load a process from a repository to which you are connected. If you load an existing process, the process code is shown in the work space. If you create a new process, a process frame is shown in which you specify the code:
    #define EngineVersion 3.0
    #define RuntimeVersion 3.0
    
    bool NewProcess()
    @Description: "Describe your process here";
    @Category: "Place your process category here";
    @Returns: "Place the return value description here";
    {
    	/* To use intellisense press Ctrl-Space and select a function from the list */
    	/* To use autocompletion start typing the function. When the right function appears type the round opening bracket and select from a list of available signatures. */
    	/* add your BI# code here */
    
        
    	return true;
    }
    
  2. To specify the code, you can use these code entry help functions:
    Function Description
    CTRL+SPACE Press this keyboard shortcut to show the list of available functions in a list box. When you select a function, a tooltip on the right side of the list box shows the function definition, parameters, and a description of the selected function. To insert the function in the process code, double-click the function. Alternatively, press the enter key. If you select, for example, the function GetProcessDescription, the tooltip shows this information:
    String GetProcessDescription() (+1 overload)
    Returns the description of the current process as defined 
    with the @Description tag.
    Left parenthesis '(' When you have specified a function name, add a left parenthesis to show the parameter definitions of the function, a description, and the return value in a tooltip. If a function is available with different parameter lists, use the cursor keyboard keys to navigate up and down through the different versions. If you have specified, for example, the function name GetProcessDescription, the tooltip shows this information:
    1 of 1 string GetProcessDescription()
    Returns the description of the current process as defined
    with the @Description tag.
    Return Value: The description of the current process.
    ALT+I If you press this keyboard shortcut or right-click the work space and select Insert Function, the Select Function dialog opens. The dialog shows the list of available runtime functions that you can use to create your process. You can filter the functions by category. When you select a runtime function in the list, a description of the function, return value, and parameter descriptions are shown. To insert the function in the code, click OK.

    See Using runtime functions.

    SHIFT+F9 Press this keyboard shortcut to insert a breakpoint that stops the process at a code line when debugging it. A red dot marks the line number. The Watch tab on the right side shows the variables and variable values that are used by the process when it stops. To remove the breakpoint, press again SHIFT+F9.
  3. To save the process in a folder of the file system, select File > Save As. Navigate to the folder where you store the file, specify the file name, and click Save.
  4. To store the process in the repository database to which you are connected, click Publish on the toolbar. Click Yes to confirm that you want to publish the process. A message is displayed that the process has been published. The version number of existing processes is incremented by one.
    Note: Ensure that the process has been tested and validated before publishing a new version in the repository database.