Administration and Management

This page describes common concepts, general administration and management in Desktop.

The following topics are covered:

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 https://infozone.atlassian.net/wiki/spaces/MD95/pages/574784206.

To update, click on the Dynamic Update button. The text “Dynamic Update #1“ will appear after the workflow number within parentheses. This number will be increased each time you update the workflow configuration while it is running.

Dynamic update

Folders

Folders enable the user to categorize configurations and simplify their maintenance and operation. Folders can be created based on traffic type, decode for a specific network element, be based on geographic location, etc.

There is a system folder named Default. This folder cannot be renamed or removed.

Configuration Naming

Configuration names within a folder must be unique.

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

The following characters are allowed. Any other character results in a validation error.

a-z
A-Z
0-9
- (dash)
_ (underscore)

The system has an internal key for every configuration. This key is used to identify the configuration. Renaming a configuration does 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, 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:

http://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html.

Letter	Date or time component	Example

Letter	Date or time component	Example
G	Era designator	AD
y	Year	1996; 96
M	Month in year	July; Jul; 07
w	Week in year	27
W	Week in month	2
D	Day in year	189
d	Day in month	10
F	Day of week in month	2
E	Day in week	Tuesday; Tue
a	am/pm marker	PM
H	Hour in day (0-23)	0
k	Hour in day (1-24)	24
K	Hour in am/pm (0-11)	0
h	Hour in am/pm (1-12)	12
m	Minute in hour	30
s	Second in minute	55
S	Millisecond	978
z	Time zone	PST; GMT-08:00
Z	Time zone	-08:00

Example - Date and time patterns are interpreted in U.S. local time

The following examples show how date and time patterns are interpreted in U.S. local time. The example shows local date and time 2001-07-04 12:08:56 in the U.S. Pacific time zone.

Format	Example

Format	Example
"yyyy.MM.dd G 'at' HH:mm:ss z"	2001.07.04 AD at 12:08:56 PDT
"EEE, MMM d, ''yy"	Wed, Jul 4, '01
"h:mm a"	12:08 PM
"hh 'o''clock' a, zzzz"	12 o'clock PM, Pacific Daylight Time
"K:mm a, z"	0:08 PM, PDT
"yyyyy.MMMMM.dd GGG hh:mm aaa"	02001.July.04 AD 12:08 PM
"EEE, d MMM yyyy HH:mm:ss Z"	Wed, 4 Jul 2001 12:08:56 -0700
"yyMMddHHmmssZ"	010704120856-0700

Code Editor

At various places in the environment, editable code areas are available in order to enter APL code or Python code. To assist in writing the code, right-click anywhere in the text area to show a pop-up menu with available functions.

Code Editor right-click menu

The menu has the following options:

Option	Description

Option	Description
Cut	Moves the selected text to the clipboard. You can also press `CTRL+X` to perform this action.
Copy	Copies the selected text to the clipboard. You can also press `CTRL+C` to perform this action.
Paste	Pastes the contents of the clipboard into the place where the insertion point is. You can also press `CTRL+V` to perform this action.
Select All	Selects all the text. You can also press `CTRL+A` to perform this action.
Find	Searches the code for the highlighted text. You can also press `CTRL+F` to perform this action.
Toggle Line Numbers	Adds or removes line numbers at the beginning of the current line or selection.
Code Completion	Performs code completion on the current line. For more information about Code Completion, see APL Code Completion below. You can also press `SHIFT+CTRL+SPACE` to perform this action.
UDR Assistance...	Opens the UDR Internal Format Browser from which the UDR Fields can be inserted into the code area.
MIM Assistance...	Opens the MIM Browser from which the available MIM Resources can be inserted into the code area.
Show Definition	If you right-click a function in the code that is defined somewhere else and select this option, you are redirected to where the function is defined. If the function is defined within the same configuration, you jump to the line where the function is defined. If the function is defined in another configuration, the configuration opens, and you jump directly to the line where the function is defined. Note! If you refer to an external function with the same name as a function within the current code, 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.

Code Completion

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

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

Code Completion covers:

All installed functions.
Function blocks such as beginBatch and consume.
Condition statements such as while and if.
Functions created in APL Code configurations.
Functions created with the Development Toolkit

UDR Browser

In places where one or many UDR types or UDR fields need to be selected, the UDR Browser is utilized. 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:

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

For further information about UDR types and fields, see the https://infozone.atlassian.net/wiki/spaces/MD95/pages/575250996.

UDR Internal Format Browser

Setting	Description

Setting	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 the folders to display all the subfolders and types by clicking the Expand All button. You can collapse the folders again by clicking the Collapse All 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	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	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 checkbox to display read-only fields. The text appears in red. Note! Clearing this checkbox 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 used.

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.
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.
Single selection of UDR fields. Same as for UDR Type, but fields are selected instead.
Multiple selections of UDR field. Same as for UDR Type, but fields are selected instead.
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, MediationZone 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 the system, for instance, when selecting which MIM resources to use in a file name.

MediationZone uses Java Management Extensions (JMX) to monitor MIM tree attributes in running workflows. For more information, see https://infozone.atlassian.net/wiki/spaces/MD95/pages/574784312.

A MIM tree example

MIM resources for each agent have their values assigned at any time, depending on type. As an 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 four types of MIMs in total:

MIM Type	Description

MIM Type	Description
Batch	Batch MIMs are dynamic values, populated during batch processing. An example of such a value is outbound UDRs.
Global	A global MIM value can be accessed at any time during the execution phase of a workflow. For instance, static values such as Agent Name.
Header	Header MIM values are populated when a batch is received for processing (an agent emits Begin Batch ). For example, Source Filename (published by the Disk collection agent).
Trailer	Trailer MIM values are populated after a batch is processed (an agent emits End Batch ). An example of such a value is Target Filename (published by the Disk forwarding agent).

By default, all agents may publish the following MIM resources depending on their Input/Output data types.

MIM Parameter	Description

MIM Parameter	Description
Agent Name	This MIM parameter contains the name of the agent as defined in the workflow editor. All agents publish this resource. The value is set when the workflow starts executing. `Agent Name` is defined as a global MIM context type.
<route name> UDRs (or Bytes)	This MIM parameter contains the number of UDRs (or Bytes) routed on the link by the agent. The value is updated continuously during processing. This MIM is not valid for forwarding agents. `<route name> UDRs (or Bytes)` is defined as a batch MIM context type.
<route name> Queue Size	This MIM parameter contains the number of objects that are currently in the route's queue.
<route name> Queue Full Count	This MIM parameter contains the number of queue state changes. The value is updated each time a route's queue enters "full" state.
Inbound UDRs (or Bytes)	This MIM parameter contains the number of incoming UDRs (or Bytes) since last Begin Batch. The value is updated continuously during batch processing. This MIM is not valid for collection agents. `Inbound UDRs (or Bytes)` is defined as a batch MIM context type.
Outbound UDRs (or Bytes)	This MIM parameter contains the number of outgoing UDRs (or Bytes) since last Begin Batch. The value is updated continuously during batch processing. This MIM is not valid for forwarding agents. `Outbound UDRs (or Bytes)` is defined as a batch MIM context type.

Note!
Some MIM resources are not available until the agent to which they belong is configured.

There are also pico specific MIM resources representing information about the picos' JVMs. These are:

MIM Parameter	Description

MIM Parameter	Description
Available CPUs	This MIM parameter states the number of processors that are available for the JVM. `Available CPUs` is defined as a global MIM context type.
System Load Average	This MIM parameter states the average system load during the last minute. The system load is the sum of the number of runnable entitites that are queued or running on the available processors, and this value shows the average of this sum for the last minute. This information is useful for indicating the current system load and may be queried frequently. `System Load Average` is defined as a global MIM context type.
Heap Memory Used Percentage	This MIM parameter states JVM's heap size, i.e. the amount of memory that is currently used by the JVM, in percent. `Heap Memory Bytes Usedn` is defined as a global MIM context type.
Non Heap Memory Used Percentage	This MIM parameter states the amount of memory outside of the heap (non-heap memory) that is currently used by the JVM, in percent. `Non Heap Memory Bytes Used` is defined as a global MIM context type.

There are workflow specific MIM resources representing information of a running workflow. These are:

MIM Parameter	Description

MIM Parameter	Description
Batch Cancelled	This MIM parameter states if the current batch has been cancelled. `Batch Cancelled` is defined as a header MIM context type.
Batch Count	This MIM parameter contains a unique sequence number that is associated with each batch processed by the workflow. This value is increased by 1 up to 2⁶³ and is saved between workflow invocations. `Batch Count` is defined as a header MIM context type.
Batch Duration	This MIM parameter contains the time it took to process a batch. This value is updated during processing. `Batch Duration` is defined as a batch MIM context type.
Batch End Time	This MIM parameter contains the end time for the processing of a batch. `Batch End Time` is defined as a trailer MIM context type.
Batch Start Time	This MIM parameter contains the start time for the processing of a batch. `Batch Start Time` is defined as a header MIM context type.
Execution Context	This MIM parameter contains the name of the Execution Context hosting the current workflow. `Execution Context` is defined as a global MIM context type.
Processed UDRs Interval Duration	This parameter contains the duration of an interval in minutes for counting the number of processed UDRs in the current real-time workflow. This MIM parameter is only valid for real-time workflows. `Processed UDRs Intverval Duration` is defined as a global MIM context type.
Processed UDRs Per Interval	This parameter contains the UDRs processed during the defined interval in the current real-time workflow. This MIM parameter is only valid for real-time workflows. `Processed UDRs Per Intverval` is defined as a global MIM context type.