Open

Desktop Background Color

You can start several Desktop applications on a specific computer. To tell the difference between the applications and their respective views you can vary the background color of every Desktop. To change the Desktop application background color, set the Desktop property mz.gui.color.space.active.

The value can be any color of the following: blue, green, yellow, orange, red, darkblue, darkgreen, magenta, or darkred. For further information about Desktop properties, see Starting and Managing Desktop Client (4.2).

Dynamic Update

While a real-time workflow is being executed, you can change the value of the following parameters:

• The Host and Port parameters of the TCP/IP agent

• The NAS list of the Radius agent

To be able to dynamically update TCP/IP Host and Port parameters, you need to set them to either Default or Per Workflow in the Workflow Properties dialog box. See the figure The Workflow Table Tab in Workflow Table Tab (4.2).

To update, select Dynamic Update from the Edit menu. On the title bar of the monitor dialog-box, the text Dynamic Update followed by a number appears. It represents the number of times that you have updated the workflow configuration while running it, that is since the last time you started it.

Folders

Folders enable the user to categorize configurations, and simplify their maintenance and operation. Folders could for instance be created based on traffic type, decoding for a specific network element, as well as being based on geographic location etc.

Usage Engine includes a system folder named Default. This folder cannot be renamed nor removed.

Configuration Naming

Configuration names within a folder must be unique.

Some named items in the Usage Engine environment are used when constructing file names. To avoid potential conflicts in the file systems, Usage Engine converts the illegal characters when constructing the file names.

The following characters are considered to be legal. Any other character will result in a validation error.

• a-z

• A-Z

• 0-9

• - (dash)

• _ (underscore)

Usage Engine has an internal key for every configuration. This key is used to identify the configuration. Renaming a configuration will not change this key. The key is constructed using the system name and the date when the configuration was created. You can view the generated key by selecting the Show Properties option in the right-click menu in the Configuration Navigator, as well as in the Configuration Browser and Configuration Tracer.

Date and Time Format Codes

In various places in Usage Engine, date formats are entered. The following list shows valid date and time format codes that can be combined with any characters that are not in the ranges of 'a'-'z' and 'A'-'Z'. For instance, characters such as ':', '.', ' ', '#' and '@' will appear in the resulting time even if they are not specified within single quotation marks.

The date syntax conforms to the Java class SimpleDateFormat. This section contains a summary only. For a full description see:

https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/SimpleDateFormat.html

Text Editor

At various places in the Usage Engine environment, editable text areas are available in order to enter APL code. To assist in writing the code, these areas host functions available in a pop-up menu that is displayed when you right-click anywhere in the text area.

The menu has the following options:

Option	Description

Option	Description
Font Size	Sets the font size.
Cut	Moves the selected text to the clipboard. You can also press the CTRL+X keys to perform this action.
Copy	Copies the selected text to the clipboard. You can also press the CTRL+C keys to perform this action.
Paste	Pastes the contents of the clipboard into the place where the insertion point has been set. You can also press the CTRL+V keys to perform this action.
Select All	Selects all the text. You can also press the CTRL+A keys to perform this action.
Undo	Undoes your last action. You can also press the CTRL+Z keys to perform this action.
Redo	Redoes the last action that you undid with Undo. You can also press the CTRL+Y keys to perform this action.
Find/Replace...	Displays a dialog where chosen text may be searched for and, optionally, replaced. You can also press the CTRL+H keys to perform this action. Open Find/Replace dialog
Quick Find	Searches the code for the highlighted text. You can also press the CTRL+F keys to perform this action.
Find Again	Repeats the search for last entered text in the Find/Replace dialog. You can also press the CTRL+G keys to perform this action.
Go to Line...	Opens the Go to Line dialog where you can enter which line in the code you want to go to. Click OK and you are redirected to the entered line. You can also press the CTRL+L keys to perform this action.
Show Definition	If you right-click a function in the code that has been defined somewhere else and select this option, you are redirected to where the function has been defined. If the function has been defined within the same configuration, you jump to the line where the function is defined. If the function has been defined in another configuration, the configuration opens and you jump directly to the line where the function has been defined. You can also click a function and press the CTRL+F3 keys to perform this action. Note! If you have references to an external function with the same name as a function within the current code, some problems may occur. The Show Definition option will point to the function within the current code, while the external function is the one that is called during workflow execution.
Show Usages	If you right-click a function where it is defined in the code and select this option, a dialog called Usage Viewer opens and displays a list of the Configurations that are using the function. You can also select a function and press the CTRL+F4 keys to perform this action.
UDR Assistance...	Opens the UDR Internal Format Browser from which the UDR Fields may be inserted into the code area. You can also press the CTRL+U keys to perform this action.
MIM Assistance...	Opens the MIM Browser from which the available MIM Resources may be inserted into the code area. You can also press the CTRL+M keys to perform this action.
Import...	Imports the contents from an external text file into the editor. Note that the file has to reside on the host where the client is running.
Export...	Exports the current contents into a new file to, for instance, allow editing in another text editor or usage in another Usage Engine system.
Use External Editor	Opens the editor specified by the Desktop property mz.gui.editor.command, e g "notepad.exe".
APL Help...	Opens the APL Reference Guide.
APL Code Completion	Performs code completion on the current line. For more information about Code Completion, see the section below, APL Code Completion. You can also press the CTRL+SPACE keys to perform this action.
Indent	Adjusts the indentation of the code to make it more readable. You can also press the CTRL+I keys to perform this action.
Jump to Pair	Moves the cursor to the matching parenthesis or bracket. You can also press the CTRL+SHIFT+P keys to perform this action.
Toggle Comments	Adds or removes comment characters at the beginning of the current line or selection. You can also press the CTRL+7 keys to perform this action.
Surround With	Adds a code template that surrounds the current line or selection: for Loop (CTRL+ALT+F) while Loop (CTRL+ALT+W) Debug Expression (CTRL+ALT+D) if Condition (CTRL+ALT+I) Block Comment (CTRL+ALT+B)

APL Code Completion

In order to make APL coding easier, the APL Code Completion feature will help you find and add APL functions and their respective syntax.

To access APL Code Completion, place the cursor where you want to add an APL function, press CTRL+SPACE and select the correct function. To reduce the number of hits, type the initial characters of the APL function. The characters to the left of the cursor will be used as a filter.

APL Code Completion covers:

• All installed APL functions.

• Function blocks such as beginBatch and consume.

• Condition statements such as while and if.

• APL functions created by APL Code configurations.

• APL functions created with the Development Toolkit.

APL Code Editor Outline

In order to make it easier to navigate in an APL code configuration, there is an Outline navigation panel to the right of the APL Code Editor.

The APL Code Editor Outline provides a view of all the blocks, variables and methods in an APL code configuration and makes it possible to easily navigate between different types in the APL code. The entries in the navigation panel are automatically updated as you make valid entries in the APL Editor.

You can also filter what you want to display in the Outline navigation panel. You can search for a specific block, variable or method using the free text field, or by selecting one of the quick filter buttons for different types:

The Outline navigation panel can be hidden or made visible. By default, it is visible and all the elements are displayed. To hide or display the navigation panel, click the vertical Outline button to the right of the APL Code Editor.

Configuration List Editor

The Configuration List Editor appears in many Agent Configuration dialog boxes and usually looks like the example in the figure below, Configuration List Editor. This table enables you to select and list several entries that you want to include in a certain Configuration definition.

Button	Description

Button	Description
Add Open	Click to open a dialog box where you can add an item to the Configuration list.
Edit Open	Select a row and click Edit; an Update dialog box opens and enables you to modify the data entry.
Remove Open	Select a row and click Remove.
Open	Select an entry from the Configuration list and click Up or Down to move it to an upper or lower position

UDR Browser

In places where one or many UDR types or UDR fields will be selected, the UDR Browser is utilized. See the figure below, UDR Internal Format Browser. You access the UDR Internal Format Browser from the Analysis or Aggregation agents, by right-clicking in the APL Code area and selecting UDR Assistance... .

The browser contains all UDR types available in the system:

1. UDR types created in the Ultra Format Editor. These include events and sessions for the Aggregation sub-system.

2. UDR types installed with the system.

For further information about UDR types and fields, see Ultra Format (4.2).

Open

UDR Browser

Item	Description

Item	Description
UDR Types	List of available UDR types ordered in a tree structure. You can search for a specific UDR type using the filter text box. You can also expand all of the folders to display all the subfolders and types by clicking the Expand button. You can collapse the folders again by clicking the Collapse button. If you click the Refresh button, the view is refreshed and the folders are collapsed. Formats created in Ultra Format Editor usually have the following structure: folder name - configuration name - internal type name Note! There are a number of agents, for example Diameter and Inter Workflow, that have predefined UDR types with corresponding folder names.
Expand All Open	Click this button to expand all of the UDR Types folders to display all the subfolders and types. If you click the Refresh button, the view is refreshed and the folders are collapsed.
Collapse All Open	Click this button to collapse the UDR Types folders so that only the folders are displayed.
UDR Fields	Displays the UDR type fields in a tree structure. You can search for a specific UDR type field using the filter text box. To refresh the view, click the Refresh button. To ease identification, the fields are color coded: Optional - Italic black Read-only - Red Default - Blue Nested UDRs - Gray Note! A nested UDR that is optional appears in Italic Black.
Show Optional	If enabled, fields declared as optional are displayed in black italic text.
Show Readonly	Select this check box to display read-only fields; the text appears in red. Note! Clearing this check box also affects the blue text entries. These are reserved fields that you cannot modify.
Datatype	If enabled, only fields that match the selected data type are displayed.

Selection Modes

The browser operates in five modes depending on where it is utilized.

1. Single selection of UDR Type. You can choose the UDR Type either by double-clicking the UDR Type, or by selecting it followed by OK or Apply. OK and double-click dismisses the dialog.

2. Multiple selections of UDR Type. You can choose several UDR Types at once by selecting them followed by OK or Apply. OK or double-click dismisses the dialog.

3. Single selection of UDR fields. Same as for UDR Type, but fields are selected instead.

4. Multiple selections of UDR field. Same as for UDR Type, but fields are selected instead.

5. Field input assistance. You can insert fields in the target text field by double-clicking them, or by selecting them followed by Apply. The OK button is not available.

MIM

Some agents in a workflow need information from the workflow or other agents in order to operate. For instance, an agent that produces a file might need the source file name and the number of processed UDRs to be used in the outgoing file name. In order to satisfy these requirements,  Usage Engine uses a model called Meta Information Model (MIM) .

Agents may use MIM parameters to publish information during run-time that other agents may need to use. The MIM information is used in various parts of Usage Engine, for instance, when selecting which MIM resources to use in a file name.

Usage Engine uses Java Management Extensions (JMX) to monitor MIM tree attributes in running workflows. For more information, see Workflow Monitor (4.2).

MIM resources for each agent have their values assigned at any time, depending on type. For example, the Disk collection agent publishes the MIM resource Source Filename which is set at Begin Batch. The agent puts the name of the collected file in this resource before it starts collecting the file.

There are in total four types of MIMs: