Professional Documents
Culture Documents
TLMCL03 Training Manual v2
TLMCL03 Training Manual v2
DISCLAIMER
SmartStream Technologies Limited makes no representations or warranties
regarding the contents of this document. We reserve the right to revise this
document or make changes in the specifications of the product described within it at
any time without notice and without obligation to notify any person of such revision
or change
COPYRIGHT NOTICE
This document is copyright. All rights reserved. No part of this publication may be
reproduced, stored in a retrievable system or transmitted, in any form or by any
means, electronically, mechanically, photocopying, recording, or otherwise, without
prior written permission from SmartStream Technologies Limited.
INTELLECTUAL PROPERTY WARNING
The contents of this document and the software it describes are the intellectual
property of SmartStream Technologies Limited. The ideas contained in this
document must not be disclosed to any third party.
TRADEMARK NOTICE
TLM is a registered trademark of SmartStream Technologies Ltd. All rights reserved.
Other trademarks recognised and property of their respective owner.
DOCUMENT INFORMATION
Doc Name: TLM Client v2.6 Configuration & Operation Training Manual
Edition 1
February 2009
Page 2 of 182
Table of Contents
Introduction .......................................................................... 9
1.1
1.2
1.3
Scope ................................................................................................... 9
Purpose ................................................................................................ 9
Intended Audience ................................................................................ 9
3.1
3.2
3.3
3.4
3.5
3.6
3.7
Objectives ........................................................................................... 10
What is Reconciliation? ........................................................................ 11
Why do we reconcile? .......................................................................... 11
Ledger versus Statement (Ours versus Theirs) ....................................... 12
Manage Exceptions .............................................................................. 12
What can go wrong? ............................................................................ 13
Required reconciliation data ................................................................. 13
4.1
4.2
4.3
4.3.1
4.4
4.5
4.6
4.7
4.8
4.9
4.9.1
4.9.2
4.9.3
4.9.4
4.9.5
4.9.6
4.9.7
4.9.8
5.1
5.1.1
5.1.2
5.1.3
5.1.4
5.1.5
5.1.6
5.1.7
5.1.8
5.1.9
Objectives ........................................................................................... 27
User Maintenance Design Studio ..................................................................... 28
Adding a user ......................................................................................................... 28
User Details window .............................................................................................. 29
Maintaining user details ........................................................................................ 31
User Status ............................................................................................................. 31
Sign on Status ........................................................................................................ 31
Changing User Password ...................................................................................... 32
Setting a lead user ................................................................................................ 32
Changing the authority id ..................................................................................... 33
2
3
Page 3 of 182
5.1.10
5.1.11
5.1.12
5.1.13
5.1.14
5.2
5.2.1
5.2.2
5.2.3
5.2.4
5.2.5
5.2.6
5.3
5.3.1
5.3.2
5.3.3
5.3.4
6.1
6.2
6.3
6.4
6.4.1
6.4.2
6.4.3
6.4.4
6.4.5
6.4.6
6.4.7
6.4.8
6.4.9
6.4.10
6.4.11
6.4.12
6.4.13
6.4.14
6.5
6.6
6.7
6.8
Objectives ........................................................................................... 47
Business data ...................................................................................... 47
Configuring Categories ......................................................................... 50
Configuring Sets .................................................................................. 50
Set tab details ........................................................................................................ 51
Address tab details ................................................................................................ 52
Static info 1 tab details ......................................................................................... 52
Static info 2 tab details ......................................................................................... 52
Financial Parameters ............................................................................................. 52
Overdraft interest .................................................................................................. 53
Netting items .......................................................................................................... 53
Warning message and charge limit considerations .......................................... 54
Net to Net matching .............................................................................................. 54
Warnings cash .................................................................................................... 54
Warnings securities ............................................................................................ 55
About sets and workflow ...................................................................................... 55
Financial parameters cash tab .................................................................................. 55
Financial parameters security tab ....................................................................... 57
Configuring Message Feeds .................................................................. 58
Business Data Administration Flow ........................................................ 62
Loading Data using Validation Server .................................................... 62
Displaying Results................................................................................ 63
7.1.1
7.1.2
7.1.3
7.1.4
Page 4 of 182
7.1.5
7.1.6
7.1.7
7.1.8
7.1.9
7.1.10
7.1.11
7.2
7.2.1
7.2.2
7.2.3
7.3
7.3.1
7.3.2
7.3.3
7.3.4
7.3.5
7.3.6
7.3.7
7.3.8
7.3.9
7.3.10
7.3.11
7.4
7.4.1
7.4.2
7.4.3
7.4.4
7.4.5
7.4.6
7.4.7
7.4.8
7.4.9
7.4.10
7.4.11
7.4.12
7.4.13
7.4.14
7.4.15
7.4.16
7.4.17
7.4.18
7.5
7.5.1
7.5.2
Page 5 of 182
7.5.3
7.5.4
7.5.5
7.5.6
7.5.7
7.5.8
7.5.9
7.5.10
7.5.11
7.5.12
7.5.13
7.5.14
7.5.15
7.6
7.6.1
7.6.2
7.7
7.7.1
7.7.2
7.8
7.8.1
7.8.2
7.8.3
7.8.4
8.1
8.2
8.3
8.3.1
8.3.2
8.3.3
8.3.4
8.3.5
8.4
8.4.1
8.4.2
8.4.3
8.4.4
8.4.5
8.4.6
8.5
8.6
8.7
8.8
8.8.1
Objectives ..........................................................................................109
Matching Concepts .............................................................................109
STP Workflow Steps............................................................................110
STP Flow - Initiations .......................................................................................... 111
STP Flow - Pass Lists .......................................................................................... 111
STP Flow - Passes ................................................................................................ 112
STP Flow No Item Workflows ......................................................................... 114
STP Flow - Results ............................................................................................... 115
STP Workflow Configuration ................................................................115
STP Configuration Match Queues .................................................................. 115
STP Configuration Rule Consideration .......................................................... 115
STP Workflow Rule Configuration ..................................................................... 118
STP Workflow Configuration - Pass .................................................................. 120
STP Workflow Configuration Pass List .......................................................... 123
STP Workflow Configuration Initiations ........................................................ 125
Invoking Initiations using the STP Workflow Sever ................................ 127
Display Results ...................................................................................127
Matching with Tolerances ....................................................................127
Data Enrichment Reference Masking .................................................127
Reference Mask Types ........................................................................................ 128
Page 6 of 182
8.9
8.9.1
8.9.2
8.9.3
8.9.4
8.9.5
8.9.6
8.10
8.11
8.12
9.1
Objectives ..........................................................................................138
9.2
Workflow Tools ..................................................................................138
9.3
Workflow Decision Tree ......................................................................138
9.4
Workflow Event Types ........................................................................139
9.5
Edit/Population Events ........................................................................140
9.6
Case Events .......................................................................................140
9.7
Create Data Event ..............................................................................141
9.8
Queue Events .....................................................................................141
9.9
Initiation Events .................................................................................141
9.10
Event Lists .........................................................................................141
9.11
Filters ................................................................................................141
9.12
Business Logic Tools ...........................................................................142
9.13
Workflow Tool Configuration ...............................................................142
9.13.1 Workflow Rule Configuration ............................................................................. 142
9.13.2 Workflow Filter Configuration ............................................................................ 144
9.13.3 Edit Event Configuration ..................................................................................... 145
9.13.4 Create Case Event Configuration ...................................................................... 147
9.13.5 Resolve Case Configuration ............................................................................... 148
9.13.6 Warn, Stop/Abort Event Configuration............................................................. 148
9.13.7 Create Data Event Configuration....................................................................... 149
9.13.8 Population Event Configuration ......................................................................... 150
9.13.9 Add/Remove from Queue Event Configuration ............................................... 150
9.13.10 Initiation Event Configuration ............................................................................ 151
9.13.11 Event List Configuration ..................................................................................... 152
9.13.12 Workflow Tool Configuration ............................................................................. 152
9.14
Business Logic Tools ...........................................................................157
10
Exercises............................................................................ 158
Exercise
Exercise
Exercise
Exercise
Exercise
Exercise
Exercise
Page 7 of 182
Exercise
Exercise
Exercise
Exercise
Exercise
Exercise
Exercise
Exercise
Exercise
Exercise
Page 8 of 182
1 Introduction
This Training Manual identifies the products and applications contained within the
STP architecture and best practices used to configure and operate the TLM Client
v2.6 product.
It is a high level document that intends to identify the processes and procedures
used to configure and operate the TLM Client v2.6 product using productised
training examples for use as an aid to training and a further reference guide or aid
memoir.
1.1 Scope
All the process steps and procedures required to successfully operate the TLM
Client v2.6 product to achieve the training objectives using the training environment
are contained in this document.
1.2 Purpose
Assist the attendee during SmartStream Technologies Education Education and
provide a high level user guide or aid memoir for future reference.
1.3 Intended Audience
This Training Manual is available for to all those who attend the SmartStream
Technologies Education Training.
Page 9 of 182
2 Course Objectives
Introduce TLM Client v2.6 features and functionality to users that will be required to
understand the purpose of the product within the STP Architecture.
Configure relating processes and operate the product to support TLM Solutions and
demonstrations.
Including:
User Security Administration specific to TLM Client Users.
Why we reconcile
Potential problems
STP Architecture
Page 10 of 182
The list of reasons is endless but regardless of the reason the underlying concept is
the same, we dont want to lose money, whether that is due to our actions or their
actions, incurring interest or payment errors.
We also want to monitor the progress of transactions and identify potential problems
before they escalate which in turn will reduce any risk and financial exposure and
unwanted costs.
SmartStream Technologies product set is based around reconciliation
Page 11 of 182
Write cheques
(Ledger/Ours)
=
Withdraw Cash
(Ledger/Ours)
Bank Statements
(Statement/Theirs)
Page 12 of 182
. . .and sent to
the relevant
department
Financial Institution
Transactions
Balance?
If not, an
investigation is
raised . . .
Page 13 of 182
Account / Set reconciliation can only occur within the same set
Needless to say the reconciliation process can use multiple occurrences of the
minimum criteria, for example several dates (value and entry date), two separate
amounts (quantity and price) etc. But all four of the minimum criteria must be used
in any one reconciliation process.
4 TLM Components
4.1 TLM Reconciliations Client
There are several separate components that are used in conjunction with each other
to create a reconciliations solution. They are:
SmartSchema
Design Studio
Recon Admin
WebConnect
Servers
Page 14 of 182
Reconciliation Model
o a hierarchical structure used to identify message types including side
& sign to be loaded into the model/schema
o Object/functionality allocation at appropriate model level
o Entity attribute allocation at appropriate model level identifying
available properties
Using SmartSchema a user can configure bespoke universes containing objects and
attributes from any entity to provide the information required for the TLM products
to produce the reconciliations solutions desired.
4.3.1 TLM SmartSchema User Interface
SmartSchema is also the user interface to the data loaded relating to the
reconciliation model or product in use enabling to the user to create and configure
joins between entities or database tables detailing how the data is cascaded
throughout the database. Entity joins allows data to be accessed and referenced
from several tables based on primary key values between the entities (Figure 3).
Each SmartSchema Universe will contain objects whose properties can be identified
depending on which object and universe is being viewed. This enables the use to
view the object type and how that object can be displayed or accessed via the TLM
products. Likewise each object will contain a list of attributes, and each attribute has
its own properties dictating where and how it can be accessed via the TLM products
(Figure 4).
Building the new schema should always be the last step; therefore there are
prerequisites for use:
Because once data has been loaded into the TLM Environment is may not be
possible to reconfigure the schema if object ids, attribute ids and LNV values have
already been assigned.
Page 15 of 182
Selected Universe
Base Entity
LNV Column
Information displayed is
directly related to selected
universe and Entities and Joins
tab.
Mapped Entities and Joins
allow access to all attributes
within universe from base
entity.
Primary Keys
Selected Universe
Information on screen is
directly related to selected
universe and Object &
Attributes tab.
Object Properties
Attributes
Page 17 of 182
Chart bar, line or pie chart used to display high level information
Page 18 of 182
Loading data
Investigations
Workflow
o Processes Initiations and Workflow Tools
Transmit
o Passes TLM output product over predefined external networks
(email/swift/export)
Scheduler
o Used to schedule workflow and processing to run without operator
intervention
Currency
o Maintains exchange rates for related currencies
Stocks
o Maintains stock values
Page 19 of 182
The central component of all TLM Solutions is the business data repository or
database. This is where all live transaction data is located with a portion of the
database or more commonly a separate database for TLM Control being utilised to
store the tables required to hold the TLM product process configuration information
(straight through processing and business logic tools etc).
SmartSchema is deployed to allow access and functionality to the various TLM
products as described earlier in this document.
The GEMS server engine loads the source data files onto the relating database
tables using a Knowledge Base (KB) or a message template identifying the structure
and contents of a source file, each different message format or type will have a KB
stored as part of the database Schema.
The admin clients or thick clients (TLM Design Studio, TLM Recon Admin) configure
all processes including data loading and any automated straight through process
(STP) workflows and workflow tools (business logic tools BLT), these workflows
utilise the Workflow and Transmit server which both interact with the Schema and
database tables in order to process the workflows. The admin client will also
configure all dashboard displays and views including any operator functionality (BLT)
for access via the thin client or TLM WebConnect utilising a web browser via an
application server (weblogic, jboss etc).
And the process designer (TLM Control), which also utilises the same java
application server as TLM WebConnect for connectivity to the business data
repository and separate configuration database, and to receive process information
from TLM WebConnect (invoked BLT).
All of these components work seamlessly together providing back end engine
functionality and front configuration capability with a thin end user interface to
enable the TLM User the ability to design, configure, revise and operate their TLM
Solution
Page 20 of 182
Source
Data
KB
WebConnect
Weblogic
BDR
TLM Config
S
m
a
r
t
S
c
h
e
m
a
GEMS
Workflow
Transmit
Process Designer
Admin Clients
The admin treeview makes extensive use of context (right mouse button RMB)
menus at nearly every level.
STP Workflow contains all predefined process steps required to configure &
administrate a straight through process workflow used for matching data
Currencies complete list of currencies codes & rates used by the system. Can
be populated manually or via currency server
Page 22 of 182
Universes
s availab
ble universes and attributes dicctated by S
SmartSchem
ma that
can be acccessed whiilst creating
g TLM Reccon Admin workflowss and proce
esses.
4.9
9.2 Admin
n Tree Fam
miliarisattion Des
sign Studiio
The
e Admin tre
ee is locate
ed on the left
l of the work
w
area and includ
des all the
adm
ministrative
e functionss for Design
n Studio. When
W
you log in, if th
he Admin tree
t
is
initiially hidden
n, right-clicck anywhe
ere in the work
w
area and
a desele
ect Hide Trreeview
on the
t contexxt (right-click) menu.
To expa
and each fo
older, you can click and
display the
t branch
h structure and lowerr levels of
the tree
e. Converse
ely, you can collapse a branch
by clickiing to cllose the low
wer levels of the
tree.
The Adm
min tree makes
m
exten
nsive use of
o context
(right-cllick) menus at nearlyy every leve
el.
Pa
age 23 of 182
The Users branch of the Admin tree expands filtered according to the criteria
you entered. For example, if you entered the User ID 'TRAINING' only those
User IDs that contain the string 'DAVID' are displayed.
Some filters such as the Dashboard Filter have several checkboxes that are used to
restrict the items displayed:
You can select the type of dashboard control you want to list (using checkboxes)
and click [OK]. Any criteria you enter for controls are ANDed together. For example,
if you select the Chart and TreeView control checkboxes, all dashboards that contain
at least one chart and one treeview are displayed.
4.9.4 Creating predefined Admin tree filters
As well as using the general Admin tree filters, you can also create your own
predefined filters. These filters can then be used in place of the general filters for
the nodes that support this functionality.
The following treeview nodes support predefined filters:
Users
Roles
Rule Types
Tools
Constraints
Dashboards
You can also define one predefined filter per business object node as the default.
This default filter is pre-filled into the filter dialog when it is loaded; meaning that if
you click [OK] on the filter dialog, only a subset of the total configuration data is
displayed.
SmartStream Technologies Limited
Page 24 of 182
6. The Show All option in the context menu displays the entire list of objects for that
node, with no filter applied.
Page 25 of 182
Depending on the item you are changing and your system configuration, you might
require authorisation for this action; if this is the case, the authorising user must
enter their User Name and Password.
4.9.7 Deleting items
If you have Update Access to a branch of
the Admin tree, you can delete items from
the branch. Update Access is controlled by
your user authorities.
To delete items
1. If the Admin tree is not displayed, click in the work area and deselect Hide
Treeview.
2. From the Admin tree expand Users.
3. Right-click the user and select Delete.
4. A message is displayed, Click [Yes]
Depending on the item you are deleting and your system configuration, you might
require authorisation for this action; if this is the case, the authorising user must
enter their User Name and Password.
SmartStream Technologies Limited
Page 26 of 182
View
Modify
User Control
Message Maintenance
Access & Limits
Release Workflow
Page 27 of 182
Dstudio
Full
System
Each user must be assigned to a particular role before they can access Design
Studio or TLM WebConnect.
The following table shows the maximum level of access available to each user type
(i.e. with Access and all High). This table also includes the TLM Reconciliations
user types; Casing, Coac and Enquiry:
Tree Node
DStudio
Full
System
Casing
Enquiry
Users
Create &
Modify
Create &
Modify
Create &
Modify
Create &
Modify
View Only
Create &
Modify
Modify
Create &
Modify
Create &
Modify
Create &
Modify
Create &
Modify
View Only
Create &
Modify
Modify
Create &
Modify
Create &
Modify
No Access
View Only
View Only
No Access
No Access
No Access
No Access
No Access
No Access
No Access
No Access
No Access
No Access
Create &
Modify
No Access
View Only
View Only
Roles
Rules
Constraints
Tools
Dashboards
Customisation
Modify
No Access
Note that once a user type has been selected it cannot be changed!
5.1.2 Adding a user
A user profile holds information about a users access to the system and any
changes to the password. Other profile data, such as the user's name, telephone
and fax numbers and the employment position within the organisation's hierarchy,
are used for reporting purposes.
You can add another users details to the system if you have the appropriate
authority. Once the user profile has been created, the relevant user authorities can
be added. When you set up a new user, their first password defaults to their user
ID.
To add a user:
1. If the Admin tree is not displayed, click in the work area and deselect Hide
Treeview.
2. Expand Security.
Page 28 of 182
3. Right-click Users and select Insert to open the Add User Details window.
4. Enter a User ID. (Mandatory) The User ID is used to log on to the system. Up to
eight characters are available.
5. Several boxes are set by default but can be changed. For example:
a. The default User Type is Casing. (Mandatory)
b. The default User Status is set to Active.
c. Sign On Status is set to Signed Off and User Creation Date is todays date
(the latter cannot be changed).
d. The Next Password Change Date defaults to the day the user is added.
Password Change Days is set to 30 by default. You can change this. When
the user first logs on to Design Studio, the password is the same as the User
ID and they will be prompted to change this password. After 30 days, or
whatever number you set, this password will expire.
6. If you want the user to be a Web only user (i.e. to have no access to the
configuration application) check the WebConnect only checkbox. (This option is not
available to the Dstudio and System user types).
7. If required, enter the name, location, and contact details for the user.
8. Select the Start and End times when the user is allowed access to the system using
the format hh:mm. (Mandatory.)
9. If you want a user to have temporary access to the system, you can set an expiry
date in User Expiry Date (optional). After this date that user cannot log on to Design
Studio, Click [OK] to save and close.
Page 29 of 182
The fields in the user details window are described in the table below:
Field
Description
User ID
User Status
Indicates the current status of the user. Select from User Status list:
Active - user is able to log in to the TLM system
Inactive - user is unable to log in to the TLM system
This allows users to be given intermittent access to the system. If a user fails
to log in after three attempts the status is automatically set to Inactive.
Before the user can log in again the status has to be set to Active by a user
with the right to change User Profiles.
Authority ID
The ID for the set of authorities that this user is to follow. When a new user is
set up, the new user ID is the default for Authority ID. It can only be changed
using the User Authority option available from the User Control menu.
Sign On Status
The current status of the user. Select from Sign On Status list:
Signed on - user is currently logged in
Signed off - user is currently logged out.
If the system has failed for any reason, and the status of the user has been
left signed on in error, it is possible to update the status directly here. The
user cannot log in successfully until this has been done.
User Type
Cannot be changed once the user has been created. One of the following:
Full - can change all functions available at the User Access and Limits
window. Select this user type for users who need access to both
Design Studio and its associated application, such as Recon Admin.
Casing - can change certain functions associated with the exception
processing system.
Enquiry - can only view the functions available at the User Access and
Limits window.
System - can change certain system administration functions.
Coac - can change functions relating to CoAc workflows.
Dstudio - can change functions within Design studio only.
All these fields are used to describe the actual users contact details, job title
etc. They are restricted as follows:
20 characters: Surname, Fax, Phone, Title
40 characters: First Name
60 characters: Job Title, Section, Department, Location
Email address is not limited by character numbers.
Title, Surname,
First Name, Job
Title, Section,
Department,
Location, Phone,
Emails Id, Fax
Export Rule
Export Code
The date on which the user was added to the system. This is automatically
generated by the system for information purposes. Cannot be changed.
The date after which the user is denied access to the system. It may be left
blank for full time employees, but if temporary staff are employed from time
to time, their profiles may be set up so that entry to the system is only
allowed for the term of their employment.
Password Change
Days
The number of calendar days for which each change of password is valid.
Accepts numbers 0 to 999.
Next Password
The date that the current password becomes invalid. Changed by the system
Page 30 of 182
Change Date
each time the password is changed, based on the number of days in Password
Change Days. Can also be changed manually, effectively overriding the
number of days in Password Change Days.
Mon to Sun
Start/End
Mandatory. The times within which a user may log on to the system. This
defaults to 08:30 to 17:30 for each day, but may be changed to suit your
organizations working practices. Enter in format hh:mm, where HH is 24 hour
format. Note that this is for entry to the system and that provided you log on
before the end time, you can continue to use the TLM system after that. If
you log off, however, you are not able to log on again until the next Start
time.
Page 31 of 182
3. Expand Users, right-click the user you want and select Modify.
a. Make your changes as required. (User Details window), Click [OK].
Changes to a user profile take effect the next time the user logs on.
To delete a user:
You can delete another users profile if you have the appropriate authority. You
cannot delete your own user profile or a user profile whose authorities are being
used by others as a lead user.
If the Admin tree is not displayed, click in the work area and deselect Hide
Treeview.
1. Expand Users, right-click the user and select Delete.
2. A message is displayed asking you to confirm the deletion, Click [Yes].
Page 32 of 182
When you assign a user to follow a lead user, the following user inherits the same
settings as the lead user with respect to the following authorities options:
Attribute Maintenance
Workflow
User Universes
1. If the Admin tree is not displayed, click in the work area and deselect Hide
Treeview.
Expand Security.
Expand Users, right-click the user you want, point to User Control, and select Lead
User Authority to open the User Authority window.
Replace the users current Authority Identification with the ID of another user,
for example a 'lead' user, Click [OK] to save and close.
5.1.10
You can use User Access and Limits to determine the windows a user can access,
view, or update when they log on to Design Studio as well as control the limits they
have on various functions, such as matching amount differences. This provides a
means of controlling the administration areas available to an individual and also
governs the Admin tree options that are available for that user.
The authority options available in User Access and Limits are governed by the User
Type. For example, if a given user is set up as an Enquiry user, the user authorities
can only be set to No Access or View Access; the Update Access option is not
available.
Access and Limits enables you to set up and maintain a users access to options in
the online application.
Page 33 of 182
A users Authority ID is set by default in Add User Details to their own User ID. If
you have the authority, you can set the Authority ID for a given user to that of any
other user using the User Authority window.
5.1.11
Two sets of limits allow users within a reconciliation department to authorize each
others imperfect matches.
To set access and limits for a user:
1. If the Admin tree is not displayed, click in the work area and deselect Hide
Treeview.
Expand Security.
Expand Users, right-click the user you want, point to User Control, and select
Access and Limits.
The User Access and Limits window is displayed for the user you selected.
Use the list for each authority to select the type of access allowed to that user
for that task
You can use the [All High] or [All Low] buttons to set all the authorities to Update
Access/Yes or No Access/No respectively, Click [OK] to save.
5.1.12
The user authorities, which an Administrator can set in Access and Limits, govern
the availability of options on the Admin tree.
Page 34 of 182
If an authority is set for a higher level in the tree and if authorities for levels
below are set to no access, the higher level (parent) of the tree is displayed with
no children.
For example, if you set a user to have update/view access to Categories but no
access to Sets or Message Feed, the tree displays the Categories level only for that
user.
If an authority is set for a lower level (child) in the tree, but the authorities for
levels above (parents) are set to no access, the child level is not displayed in the
tree until all parent level authorities are set to at least view access.
For example, if you set a user to have update/view access at Message Feed level
and Categories level but no access to Sets, the tree displays the Sets level only for
that user.
If you set up a user with no access for user authorities which govern options on
the Admin tree context (right-click) menus, these options are either not available
(dimmed) or some may be missing altogether.
Any user with access to the User level can determine who is logged on to the TLM
database from the Admin tree. A person icon ( ) replaces the folder icon if a user
is logged on.
5.1.13
You can grant a user access to the dashboards configured for their lead user.
It is the user id (and therefore the corresponding
lead user id) of the user in the admin tree that is
processed, rather than the user logged into the
application. For example, you can be logged in as
user MRB, and import the Lead Users shortcuts for
user RD. To assign web shortcuts:
1. From the Admin tree expand Security.
Expand Users.
Right-click the user you want to work with, and select
User Control > Import Shortcuts. Click [OK] to
import all shortcuts.
Page 35 of 182
5.1.14
Assigning user roles
User Roles control the assignment of permissions to users. When you create a new
user, they must be assigned a role before that user can access Design Studio, TLM
WebConnect or any associated TLM application. A user can be assigned multiple
roles. Each role has its own data access rights and permissions, and the user inherits
the most favourable permissions from all of their roles.
The procedure assumes that at least
one suitable role has already been
configured.
To assign roles to a user:
Page 36 of 182
Rules
Constraints
Roles
To assign universes:
1. From the Role Details window select the Role Details tab:
2. Select the universe you want to assign to this role from the Available Universes list
and click the arrow button, or click the double arrow button to assign all universes to
the role, click [OK].
Page 37 of 182
1. From the Role Details window select the Business Logic Tools tab:
2. Select the tool that you want to assign to this role from the Available list and click the
arrow button.
3. If you want to apply constraints to the use of any selected tool:
4. Select the tool that you want to apply the constraint to and click Add.
5. Look for the constraint that you want to apply to the tool for that role and click the
arrow button, Click [OK].
Page 38 of 182
8. Look for the constraint that you want to apply to the attribute for that role and click
the arrow button to select, Click [OK].
The Universes listed in the first pane are those you allocated previously from the Role
Details tab. Expand the universe that you want to work with and select a level.
The constraints configured for that level are displayed in the Available Constraints pane.
Page 39 of 182
2. Select the constraint that you want to apply to that level and click the arrow button
to select the required constraint(s), Click [OK].
The Universes listed in the first pane are those you allocated previously from the Role
Details tab. Expand the universe that you want to work with and select a level.
The Rulelists containing Access rules that have already been configured at or above that
level are displayed in the Available Rulelists pane. You can add a new rulelist as follows:
2. Right-click in the Available Rulelists pane and select New.
3. The Rulelist Details window is displayed.
4. Enter a name and optionally a description for the rulelist, Click [Rules].
5. Select the access rule that you want to add to the rulelist and click the arrow button.
6. If required, you can select rulelists at different levels in the universe, Click [OK].
The new rulelist is displayed in the Available Rulelists pane.
7. Select the Rulelist that you want to apply and click the arrow button, then click [OK].
The rulelist is displayed in the Selected Rulelists pane, together with its level.
Page 40 of 182
TLM Recon Admin will allow the maintenance of a users details only if you have the
appropriate authority to do so, this authority is either system or a higher user type.
If access is granted you can only change the following by RMB (right mouse button)
on desired user and selecting modify:
User Type
User Status Active or Inactive
Sign On Status SignedOn or SignedOff
Page 41 of 182
Access is granted to TLM Recon Admin by allocating a relevant user type, access
level is restricted depending on the actual use type allocated:
Full
o
o
o
o
o
The user type can be changed by RMB on the desired user and selecting modify to
open the user details window created using TLM Design Studio, there is also a view
option if required as per TLM Design Studio.
However there are certain user details that must be configured using the TLM Recon
Admin client:
Any configuration of TLM Recon Admin specific user details will require the
appropriate level of authority, otherwise only view access will be granted.
5.3.1 Allocating Message Types
Page 42 of 182
There are a finite number of licences for each message type; therefore it is
important to allocate only the message types a user requires to perform their dayto-day operations. All different types of message are identified in the Message Type
universe via TLM SmartSchema and are configured as part a users profile in TLM
Recon Admin. If all licences relating to a particular message type are allocated to
other users when a new user logs into the client a warning message will inform the
user of which message types will not be accessed, the user will then open with
access to all remaining message types that have licences available. When a user
logs out of the client the allocated licences are released and made available to other
users.
Message Type allocation is performed by accessing the User Control functionality as
part of a users profile then selecting Message Maintenance. The resulting window
displays the message type universe and hierarchical structure within and the correct
level must be selected to list the appropriate message type in the message type
window. Once the message types are identified they can be select by LMB (left
mouse button) one of the greater than buttons
Page 43 of 182
The display identifies all available functionality and actual place holder/folder or
input field unique to TLM Recon Admin. Also displayed are the options available
which relate directly to which user type has been allocated, if the user type is set to
Full then all options are available; no, view and update access, however if the use
type is set to Enquiry then only no and view access are available.
Care must be taken when configuring the access and limits of a user not to remove
or restrict a higher (parent) admin tree function when lower (child) levels are
required. For example, if a user is configured for update or view access to
Categories and no access to Sets, only Categories will be displayed in the admin
tree. Likewise if a user has update access assigned to Sets and Categories is
configured for no access, Sets and Categories will not be displayed as the
application will apply the parent configuration all associated child levels.
There is also the option to set All High or All Low to aid with configuration.
Page 44 of 182
select the appropriate rule and move across to the selected items list in the right
pane. Select OK to apply selection and close window.
This results in another window opening showing the actual workflow that will be
processed when the Release business logic tool is invoked. Depending upon the
system configuration an authorisation may be required for this action; if this is the
case the user must enter their user Name and Password
Page 45 of 182
Success Path
Selected Rules
Failure Path
Event List
Only one rule is displayed in the release workflow, any additional rules added can be
displayed by either placing the cursor over the rule name or RMB and select Modify
Rules. Release workflows can also be configured for a set with each workflow (user
or set) being assigned a default priority depending upon when they were created,
this priority is configurable and if the priorities are the same for the user and set the
user workflow rule will take precedence and be processed first, with any abort or
failure paths resulting in all workflows in the list being terminated.
Additional release workflow steps can be added by RMB in the existing window and
selecting add, however care must be taken to avoid adding breaks in the incorrect
position that will terminate the sequence of the release workflow. Breaks can be
added by toggling the break icon
Event lists are added to perform any edit events (covered in a later stage) for any
items other than Cash and Securities where the productised release business logic
tool will change the status of the item to history. Event lists are added by RMB
Select modify event list and all available event lists will be displayed as per
workflow rules.
Page 46 of 182
Pre-Configured in
TLM Design Studio
User Profile
Message
Maintenance
Assign appropriate
message types
Access &
Limits
Release
Workflow
Categories
Sets
Message feeds
Source data
GEMS & KBs
Explain and demonstrate how to configure business data & load source data into
TLM system ready for further processing
6.2 Business data
All criteria that are required to be configured so that source data can be loaded into
the TLM system is contained within business data, there are message feeds that
identify source data and associate that source data with a set.
Page 47 of 182
KB ID
Message
Feed ID
Lines 61 individual transactions containing entry date (040823 yymmdd) value date (0823 mmdd) transaction sign credit or debit (C or
D) transaction amount (123,6) reference (6443829)
Lines 62F & 64 closing page and statement balances containing date
(040823) currency (GBP) amount (2991563,42)
Page 48 of 182
GL File
Set
B
Set
A
Stmt
File 1
Set
C
Set A
o Feed Id from GL
o Feed Id from Stmt 1
Set B
o Feed Id from GL
o Feed Id from Stmt 1
Set C
o Feed Id from GL
o Feed Id from Stmt 2
Stmt
File 2
Page 49 of 182
Custodian (default)
Broker
Counterpart
Correspondent
Branch
Page 50 of 182
Expand the desired category if the new set is to be grouped by category, RMB sets
and select insert or expand default, RMB sets and select insert if category
grouping is not required, There are six tabs on set administration to set up all
necessary data at set level:
There is also an option to enter a lead set which is used to follow a preconfigured
list of financial parameters very similar to lead user authority. All other details on the
address and static info tabs are optional.
If your set has been created with a set id that is all-numeric and 8 or less digits in
length, TLM Reconciliations automatically synchronises with the Set ID when it
SmartStream Technologies Limited
Page 51 of 182
generates the Internal Set Number. Synchronising the Set ID has the effect of giving
the Internal Set Number the same value as the Set ID and is controlled by a system
configuration option and cannot be subsequently amended.
Any Set IDs that do not fall into this category cannot be synchronised and are
automatically assigned an Internal Set Number by the system.
There are several details that are populated by the client once data has been loaded
through a set, these are:
Page 52 of 182
If any of the above limits are reached during reconciliation, the system acts
accordingly. It also acts on the warning settings for the set.
Securities financial parameters mostly determine the action to take for differences
between their side and our side:
A long position their side exceeds our side
A short position our side exceeds their side
These parameters enable you to decide whether warnings should be displayed when
manually reconciling securities items.
6.4.6 Overdraft interest
When a cash match occurs, a potential for an interest charge is created for each
date where the balance of the match differs from the previous date. The applicable
interest rate can be determined from a constant rate held for the specific set on the
Financial Parameter Cash tab, or from a date-dependent rate held for a lead set
defined at message feed level in the Interest Rate windows.
If the text box on the Financial Parameters Cash tab is blank, or no rate is found for
the lead set, the interest rate used is zero.
When a match is made, the interest payment record is generated, either from TLM
Reconciliations (during manual reconciliation) or by the Workflow server (during
automatic reconciliation). If the interest rates are subsequently changed for the
period covered within a match, no recalculation occurs.
A case can be raised automatically against the cash match and a document will be
issued to the relevant branch by the Transmit server. These documents can be used
to claim potential overdraft interest from branches who have created an interest loss
when using Cash (Nostro) sets.
6.4.7 Netting items
A netting item is theirs (statement) or ours (ledger) item which is created with an
amount equal to a matching amount difference, but opposite in sign to the
outstanding amount. For example, a match of 300LC to 100SD would create a
netting item of 200LC (the difference in the match being 200SD).
Any further items with the same reference as the original items which come in later
can be matched against the netting item. This can be used to prevent charges on
outstanding items when it is known that they will be received on a regular basis.
Whether a match difference becomes a charge or a netting item is determined by
the Charge Limit. If a match difference is lower than the charge limit set, it is
written off as a charge. Otherwise, a netting item is created.
Page 53 of 182
Netting items created this way take the value date of the lead our side (ledger) or
their side (statement) in the match.
6.4.8 Warning message and charge limit considerations
If you set charge limits to No Warning on the Financial Parameters Cash tab, TLM
Reconciliations creates netting items or charges transparently. With any other
setting, the system displays the Group Summary when items are reconciled. If the
reconciliation amount difference exceeds the charge limit, the Create Netting Item
check box is selected by default and the TLM Reconciliations creates a netting item
when the reconciliation is submitted. However, operators can choose to clear the
check box and create a charge instead of a netting item.
6.4.9 Net to Net matching
Net to Net matching allows matching of netting items to other netting items, as well
as to real items. In this process, provided the match difference exceeds the charge
limit, TLM Reconciliations offers the option to create a new netting item. If an
operator accepts this, the old netting items are marked as historic and a new netting
item is created with outstanding status.
6.4.10 Warnings cash
A warning allows you check the details of items before you release them. You can
set warning levels using the following parameters on the Financial Parameter Cash
tab:
These settings for these parameters determine whether Group Summary is shown
when manually reconciling items.
The list contains the following options:
Warning and Note - Group Summary is displayed and you must type a
Note before proceeding.
Warning and Source - Group Summary is displayed and you must type
a Source code before proceeding.
Page 54 of 182
Warning and Note - Group Summary is displayed and you must enter a
Note before proceeding.
Warning and Source - Group Summary is displayed and you must enter
a Source code before proceeding.
Interest Set - The number of the set from which the credit/debit interest
rates are to be taken. Use this option, in conjunction with Interest Code,
to set an overdraft rate that is date dependent. If entered, the
Credit/Debit Interest Rates should be blank.
Page 55 of 182
Interest Code - Mandatory if Interest Set is used. The short code for the
message feed from which the credit/debit interest rate is to be taken.
Credit Interest Rate and Method - The rate of interest applied when
the set is in credit and the method to be used when calculating that
interest. Select the method from the list: 360, 365, Actual. Use these
options when applying a rate that is specific to this set. If entered,
Interest Set and Interest Code should be blank.
Debit Interest Rate and Method - The rate of interest applied when
the set is in debit and the method to be used when calculating that
interest. Select the method from the list: 360, 365, Actual. Use these
options when applying a rate that is specific to this set. If entered,
Interest Set and Interest Code should be blank.
Charge Limit (Debit and Credit) - The debit / credit amount difference
between matches items that must be exceeded before a netting item can
be created when the items are released (i.e. reconciled). Amounts below
or equal to this amount are written off as amount differences when the
item is released. When amounts exceed this limit, the Netting Item check
box is automatically selected in Group Summary, indicating that a netting
item is created when the items are released. You are able to clear this
check box if, at the time of release, you do not want a netting item to be
created.
Manual Input Authorisation (Statement and Ledger) - Activates the
user authorisation logic for the manual input screens. Any changes to
these settings override the SYST values ALLOW_LDGR_AUTH and
ALLOW_STMT_AUTH. Value can be one of:
o System - Uses the value in SYST. This is the default.
Page 56 of 182
Over Minimum Interest (Debit and Credit) - Use the list to determine
whether Group Summary is to be displayed if the Minimum Interest
Amount is exceeded.
Over Charge Limit (Debit and Credit) - Use the list to determine
whether Group Summary is to be displayed if the Netting Item Limit is
exceeded.
Under Charge Limit (Debit and Credit) - Use the list to determine
whether Group Summary is to be displayed if the Netting Item Limit is
NOT exceeded.
Position Value - Use the list to determine whether the Group Summary
window is to be displayed if the position value differs between their side
and our side.
Position Price Per Unit - Use the list to determine whether the Group
Summary window is to be displayed if the position price per unit differs
between their side and our side.
Position Accrued Days - Use the list to determine whether the Group
Summary window is to be displayed if the position accrued days differs
between their side and our side.
Page 57 of 182
Position Date - Use the list to determine whether the Group Summary
window is to be displayed if the their side position date is earlier than the
our side position date.
Transaction Price Per Unit - Use the list to determine whether the
Group Summary window is to be displayed if the transaction price per unit
differs between their side and our side.
Page 58 of 182
There are three mandatory fields on the message feed static 1 tab, message type,
selected form the drop list supplied by the message feed universe and will determine
what other data is required or available. Message Feed is the message feed id from
the source data file and must be exact, and a short code of up to three characters.
All other fields are used or MIS or administrative purpose with some fields being
populated when data is loaded as per the set and category information.
Static feed 2 tab contains information populated from static feed 1, other data
relates to aliasing, allowing data enrichment on the set id etc.
Balance Type - Display only. When a message is fed into the TLM
Reconciliations system, GEMS analyses the data in the message and sets
the Balance Type flag to one of the following:
o No Balances
o Currency Balances
o Transactions Balances
o Positions Balances
o Dual Cash & Asset Balances
Page 59 of 182
Statement Origin - Source from which the message feeds are taken.
Sources should be defined by the users and implemented by SmartStream
Technologies Professional Services.
Status - The current status of the set/message feed. Allows the receipt
and loading of feeds for this set.
Advisory Items Only - Message feed is only for advisory items (MT900
and MT910).
Validate Sequence - Cash. Select this check box and the system checks
to see if the statement numbers and statement pages are out of
sequence. The system also performs a balance flow check to see if the
last closing balance is equal to the next opening balance.
Page 60 of 182
is made on the first item in each message and includes criteria such as the
statement date, statement page, and so on.
During the loading process:
If a possible duplicate is found, the message is placed in Message
Maintenance with a status of Operator Intervention.
If no possible duplicate is found, the message is loaded provided no other
errors are found. If other errors are found by GEMS during loading, the
message is placed in Message Maintenance with a status of Operator
Intervention.
Page 61 of 182
6.6
6 Busines
ss Data Administra
A
ation Flow
w
Category
(Optional)
Categories are
e optionally created
d to group
p
like sets toge
ether for administra
a
ative
purposes
Se
et
Their Side
e
Message
Feed
Ou
ur Side
Me
essage
Feed
7 Loading
g Data us
sing Valida
ation Serrver
6.7
Oncce all busin
ness data is configure
ed the source data ca
an be load
ded onto th
he system
usin
ng the valid
dation (GE
EMS) server. The GEM
MS server engine
e
loads the sou
urce data
filess onto the relating da
atabase tables using a Knowled
dge Base (KB) or a message
m
tem
mplate iden
ntifying the
e structure and conte
ents of a so
ource file, e
each differrent
messsage form
mat or type
e will have a KB store
ed as part of
o the data
abase Sche
ema. As
prevviously disscussed the
e source da
ata will alsso contain the
t messag
ge feed id which hass
bee
en associatted to a sett as part of
o the busin
ness data configuratio
c
on.
Pa
age 62 of 182
In order to manually load the data expand servers from the admin tree, RMB
validation and select insert
Enter a file name from source including file type e.g. C:\directory\file name.txt into
the file name field. Select a server program (GEMS) from the available program drop
down list, assign a priority if appropriate (not required for manual loading), and
allocate a GEMS Template for the source data file (FD950)
6.8 Displaying Results
Results of the data load can be displayed in two ways, either using a Message
Maintenance dashboard searching on the Message Feed Id in TLM WebConnect, this
will display load flag and error status, or via an ad-hoc search dashboard searching
on Set Id. If the data failed to load results will only be available in the Message
Maintenance dashboard.
File Id
Load Flag
BLT
Error Status
Message Type
Msg No
Feed Id
The details of a message loaded by GEMS is displayed as per figure 31 above, the
load flag and error status provides the user with a possible solution as to why a
message did not load successfully. Upon rectifying the cause of the error a message
can be re-processed by GEMS by invoking the appropriate business logic tool (BLT)
this will result in the message being loaded into the system updating the load flag
and error status accordingly. Other business logic tool options are delete and
undelete.
Page 63 of 182
Summary and display controls allow the execution of searches that return
summary data and present the results to the user. They also allow the user to
drill-down to other dashboards, and to control those child dashboards. The chart
control supports rendering of pie charts, bar charts and line charts. The icon
control is primarily a means of placing a picture within a dashboard, which can
function like a button. The text control allows you to annotate dashboards with
free text and aggregates from searches associated with its control segments. The
treeview control is used to summaries data in a hierarchical representation.
Detail controls show the results of searches that return rows of data. The grid
control displays the result of searches in a tabular format. Grids support the
concept of views. A view represents one way of presenting search results and
allows the user to decide which attributes should be displayed, what sort order
should be used, whether any breakpoints or totals should be shown and what
the column headers should be. Form controls display a single row of data from
search results at a time in a user-defined layout format.
Detail controls allow the user to invoke business logic on individual or groups of
result data via business logic controls. The form control is the primary interface
for editing data.
Page 64 of 182
To add a dashboard:
1. From the Admin Tree, right-click Dashboards and select Insert.
2. A new blank dashboard is created for you to start work with:
Page 65 of 182
3. Right-click the dashboard to display its context menu and select Configure
Dashboard:
The Configure Dashboard window is displayed. This allows you to:
Page 66 of 182
Page 67 of 182
7.1.10
Page 68 of 182
After the new group has been created, to add a new shortcut to the group:
1. From the Admin tree, expand Dashboards and point to the
dashboard you want to add to the Shortcut bar. Hold the left mouse
button down. The following icon is displayed:
2. Holding the left mouse button down, drag the dashboard to the
Shortcut bar. The new shortcut is created within the active group.
3. You can reorder the shortcuts within the group, or move a shortcut to a different
group by dragging and dropping each shortcut icon that you want to move.
You must close Design Studio for the new order in which the shortcuts are displayed
to be reflected in TLM WebConnect.
7.1.11
Deleting dashboards
You can delete unwanted dashboards. Doing so deletes the dashboard and any of its
controls that are not used elsewhere. The child dashboards of a deleted parent are
not deleted. To delete a dashboard from the Admin tree, right-click the dashboard
you want to delete and select Delete.
You are prompted to confirm that you want to delete the dashboard. Click [Yes].
7.2 Designing Dashboards
7.2.1 Positioning and resizing a dashboard and its controls
You can position and resize the dashboard and its controls within the Design Studio
desktop. However, these settings are not reflected when viewed through TLM
WebConnect, because dashboards are a fixed size in TLM WebConnect.
To position controls: Move the pointer inside the control and drag it to its new
dashboard location. Tab Controls can only be dragged by their tabs.
To size controls: Move the pointer over the edge or corner of the control and drag
and drop its edge, or corner, to resize the control.
7.2.2 Using frames
The frame control provides a means of grouping related controls. It consists of a
title and rectangular box in which you can add other controls. Controls are re-sizable
and movable as if they had been placed directly on the dashboard but cannot be
moved outside the frame i.e. dragging controls beyond the frame boundary results
in clipping.
When viewed through TLM WebConnect, the frames themselves are not visible;
however the arrangement of the controls within each frame is retained.
SmartStream Technologies Limited
Page 69 of 182
The tab control is displayed in Property Page style with the tabs located Top Left of
the tab page. To specify a Tab Control:
1. Add the tab control, move the cursor over
the "New Tab" text and right-click to bring up the
context menu:
2. The following menu options are pertinent to
the tab control:
a. Add tab - creates a new tab and
tab page
b. Remove Tab - deletes an existing
tab (so greyed out initially) and all the controls
placed upon it
c. Configure Tab - lets you
customize the current tab text and general
aspects of the control
3. Use the Add tab option repeatedly to
add the required tabs, for example:
4. Right-click a "New Tab", select
Configure Tab
5. Edit the Current Tab Name text and
click [OK].
Page 70 of 182
6. To add controls to a tab page, click the appropriate tab, move the pointer off the tab
into the page and right-click to open the context menu.
7. Use the Add and Add Existing... options to add controls.
Page 71 of 182
You can also create a Search by combining several search rules. The conditions of
multiple search rules are ANDed together and so are their prompts.
Universes and joins
If you associate an Item universe search with a control, for example a form, you can
use all of the attributes in your dashboard or pass them into child control prompts.
However, some of the attributes might return blank values.
This is because they are reliant on joins to tables other than, in the case of the Item
universe, Item and Bank and the joins are missing. For example, the attribute Item
Status is a column of the Item/Bank tables but Feed ID is not and requires a join. In
such cases, one way to create the necessary join is to add a neutral rule to your
search that references the attribute, for example:
... AND Feed ID=Feed ID
The same technique can be applied to other universes and is worth trying where an
attribute does not display a value.
7.3.2 Creating a search
The following procedure describes how to create a search using the single search
rule Outstanding & Advisory within the context of a dashboard grid.
To create a search from a dashboard Display the Admin tree, right-click
Dashboards, and select Insert.
A blank dashboard is displayed.
1. Either add an existing control, or add a new chart, grid, or treeview.
2. Right-click the control and select Configure.
3. Select the Population tab and click [Search].
4. Expand the Item Universe and select a level; in this example, Cash Settlements is
selected.
Any searches already created for the level you select are displayed in the Search
List.
Page 72 of 182
Page 73 of 182
To edit a search, From the Search List window, select the search you want to
change from the Search List or Selected Searches. Right-click it and select Edit.
You can edit the name and description of the search and change the status of the
search from global to private or vice versa.
1. To change the search rule or rules used for the search, click [Rules].
2. Use the arrows to remove existing rules and select different rules.
3. Click [OK] to return to Search Detail.
4. Repeat steps 3 and 4 if you want to change the attributes for the ordering of results
for the search.
5. At the Search Detail window, click [OK] to save your edits.
You are returned to the Search window.
4. Click [Search...].
Page 74 of 182
5. Expand the relevant universe and select a level. Any searches already created for the
level are displayed in the Search List.
6. Move the search that you want to use into the Selected Search panel.
The search normally prompts the user at runtime for its "prompt for..." values. You
can pre-load the Search Prompt window with default values at design-time. The
values are saved with the control and used for all future searches unless changed by
the runtime user.
If you pre-load the search prompt, you can control whether the Search Prompt
window appears at all to the runtime user and, if so, the circumstances under which
it appears.
Within the context of individual parent-child relationships, a parent control can:
1. Modify the values of a child control's search prompts such that whenever the child
dashboard launches/refreshes, the search prompts of its controls are mapped with
data from the parent control.
Page 75 of 182
2. Suppress all the prompts of a child dashboard, overriding the child controls' Prompt
option above.
To control search
prompts, on the
Population Tab, select
one of the prompts:
Launch
Window - The search prompt window appears whenever the dashboard is
launched. The values will initially be those specified on the default prompts
window, but these can be overtyped by the user. In which case, they are
stored and used for all future refreshes until the dashboard is closed and relaunched.
Each Time - The search prompt window appears on every refresh. The initial
values will be those set up in the default prompts screen, these can be
overtyped by the user, and the values should be remembered between
refreshes.
Never - The search prompt window is never shown in runtime mode. The
pre-set defaults are used and blank values where none are specified.
Page 76 of 182
specify group bys to split the data of a control segment into a number of groups.
You can map Group By attributes into the parameters prompts of child dashboards.
By default the levels or segment groups are labelled with the Group By attribute
names. To group the control data:
1. Right-click the control and select Configure <Control>.
2. Click the
Population tab and click
[Group Bys...].
3. The Dashboard
Attributes - Group Bys
window is displayed. The
list of attributes available at
the level of the search is
displayed in the left-hand
list.
4. Select the
Meaning
Attribute Type
Count
All
Sum
CountDistinct
All
Avg
Amounts
Min
Max
Amounts
The default presentation displays one aggregate value. To aggregate the data:
SmartStream Technologies Limited
Page 77 of 182
7.3.10
For any type of control, you can sort the control data in the control's search and the
control itself. Where both are specified, the control takes precedence over the
search. Effectively, this means you can define a default sort for the search,
overriding where necessary for particular controls.
For charts, if your chart contains multiple control segments, the chart data is sorted
in the top-to-bottom order of the control segments list. To sort the search:
1. Right-click the control and select Configure <Control>.
2. Click the Population tab and click [Search...].
The Search List window is displayed.
3. In the Selected Searches panel, right-click the search and select Edit.
Page 78 of 182
7.3.11
In Runtime mode, the control can automatically refresh its data after a defined
interval. To set the interval:
1. Right-click the control and select Configure <Control>.
2. Click the Population tab.
Ordering specified when associating a search with a control (the searchlist level)
The search ordering is overridden by the searchlist ordering if both are present.
When the data has been retrieved into the grid, the data is re-ordered based on the
current view.
7.4.1 Displaying the grid's title
To display the grid's title, right-click and select Configure Grid. Enter the required
title and click OK.
Page 79 of 182
Page 80 of 182
2. To allow users to insert a new row into a grid, select the Save tab, from the Insert
Tool list select the insert tool that you want to use with the grid.
The list displays any insert tools that have been configured in TLM Control (if you
have any).
Page 81 of 182
of the refresh options defined for the tool just for this dashboard.
1. Right-click the dashboard and select Configure Grid.
2. Select the Business Logic tab.
3. Select the tool that you want to change the refresh options for.
4. Click the Configure tool button
Refresh Dashboard - reruns the search for all controls on the dashboard
7. If you do not want the updated rows to still be selected following the execution of
the tool, select the De-Select Row(s) checkbox, Click [OK].
The Business Logic tab is updated to display whether the refresh behavior is the
default for the tool, or has been customized for this dashboard.
7.4.6 Changing the tool caption
When adding a business logic tool to a dashboard control, the tool caption is initially
set to default to name given to the tool. However, you can change the tool caption
just for this dashboard. In WebConnect, the new tool caption is displayed in the
context menu for the grid, and as the tooltip text when you hover the pointer over
the tool on the business logic toolbar.
1. Right-click the dashboard and select Configure Grid.
2. Select the Business Logic tab.
3. Select the tool that you want to change the caption for.
4. Click the Configure tool button
Page 82 of 182
4. Right-click on the layout grid and select Views > New View.
5. Select the object type that you want to display from the dropdown list.
6. To add more object types to the view, right-click and select Object Type >Add
New.
Page 83 of 182
7. To add the attributes to be displayed with these objects, right-click and select
Column > Add New.
A blank column is added alongside the Object Type column. For example:
8. To insert the column header, select Column > Options. The following
window is displayed:
9. In the Caption field, enter the
column header.
10. By default any new columns that
you create are visible to users. To prevent
a column from being displayed, select the
Column Visible checkbox, Click [OK].
11. Click the dropdown list on the first
row of the new column and select the
attribute that you want to be displayed:
Page 84 of 182
A
symbol is displayed in the column header showing that this column is sorted.
The number 1 indicates that this is the primary sort.
2. To save your changes, right-click on the grid and select Save View.
If there are sorts within sorts, other columns will also have this symbol. An upward
arrow indicates that the sort is in ascending order, a downward arrow indicates that
the sort is in descending order, and the number 2 means that this is the secondary
sort.
If some of the rows in the column that you want to sort on have different attributes,
of different data types (for example, Date, String, etc.), you must define the Sort
Data Type. To do this:
3. Right-click on the column and select Column > Options.
4. Select the Sort Ascending option or the Sort Descending option as required.
5. In the Sort Data Type list select
the
button.
The data types applicable to the
column are displayed. For example:
6. Select the data type that you want
the sort to be based on, and click [OK].
7. To save your changes, right-click on the grid and select Save View.
To remove any sort options on a column, right-click anywhere in the grid, and select
Clear All Sorts. To save your changes; right-click on the grid and select Save
View.
7.4.10
As well as predefining some sorting options on your grid, you can also enable users
to sort and filter the data in the grid.
To allow users to sort and filter the data
1. In Design mode, right-click on the grid and select View Options.
2. On the Sort/Aggregate tab, select the Allow Sort/Filter on Data Values, Click [OK].
7.4.11
Grouping items
You can change the display of the grid so that some items are grouped together. For
example, you might want to group items by reference number.
Page 85 of 182
Configuring a Break on Change for a column - displays a thick line when the
value of a particular column changes.
To group items
1. Right-click on the column that you want the grouping to be based on.
2. Select Column > Options.
3. Select the Break on Change
checkbox, or the Aggregate on Change
checkbox, or both.
4. If you select the Aggregate on
Change checkbox, you must also select
the Aggregate function.
5. If you select the Same aggregate
function, you must also enter a
mismatch message.
6. The mismatch message is
displayed if the values being aggregates
are not the same (otherwise the common value is displayed), Click [OK].
7. To save your changes, right-click on the grid and select Save View.
8. Group totals are displayed in any column that contains an amount, Click [OK].
9. To save your changes, right-click on the grid and select Save View.
7.4.12
Page 86 of 182
7.4.13
You can configure the grid to display a summary at the bottom of the dashboard.
The summary displays the aggregates of the selected row data. You can also
configure the summary to include group selections.
1. In Design mode, right-click on the grid and select View Options.
2. On the Sort/Aggregate tab, select the Show Summary checkbox.
3. By default, only selected row amounts are included in the summary. If you want
group selections to be included in the summary, select the Include Group Selection
in Summary option button, Click [OK].
7.4.14
Grid Aggregates
Comments
Applicable
Data type
*Default
All
*Count
All
*Max
All
*Min
All
*None
All
Absolute (Max)
Numeric
Absolute (Min)
Numeric
Sum
Numeric
Absolute (Sum)
Numeric
Net
Numeric
Page 87 of 182
Absolute (Net)
Numeric
Average
Arithmetic Mean
Numeric
Weighted Average
Numeric
*These options are always available, that is, for any column on the dashboard.
Other option availability is dependent on column attribute type.
Values from aggregate rows can be passed to child controls as required.
7.4.15
You can use the aggregate functionality and select an appropriate attribute to 'group
by' to make a more meaningful display of the data.
The procedure is as follows using options on the context menu:
1. Select an attribute to group by
2. Set Break On Change to display the groups
3. Set Aggregate On Change - gives an extra `totalling' or `aggregate' row. Applies
to any aggregates you set on other attributes
4. Decide which attributes are to display an aggregate function.
5. Set the type of aggregate function for each attribute.
6. To set the aggregates, open a dashboard.
7. Right-click the dashboard, point to Current Views, and click Design.
The following window is displayed:
Set the groups: right-click a Reference cell, and select Column > Options,
then select Break On Change.
Add the totals rows: right-click a cell of your choice, and select Column >
Options, then select Aggregate On Change.
Set the Aggregate Function for each attribute as required by selecting the
required function from the dropdown list.
Right-click and select Save View as, and enter a name and description for
the view.
If you want this view to be available to all users, and you have the authority
to do so, check the Global view checkbox.
The following image illustrates a dashboard generated from the above view settings,
when viewed in TLM WebConnect:
Page 88 of 182
The
7.4.16
In Grid Editing
With the introduction of version 2.6, the new feature of in grid editing is available.
This allows the user to directly edit the data on display, provided they have the
required privileges configured for their role.
Only attributes available for editing at schema level will be available for users to
modify. This feature is implemented by configuring a Save in Design Studio.
While in the Configure Grid
screen, select the Save tab, you ar
ethen prmpted to configure the
following items;
Edit Tool
Insert Tool
Save Caption
Cancel Caption
Save Icon
7.4.16.1
Edit Tool
The edit tool selector allows two options for selection, but the default selection is
Web Connect Native Edit Tool as this is not tied to any specific product or solution.
The other option seen in the list is only for use with a specific solution, namely TPM.
7.4.16.2
Insert Tool
This option is only used in the TPM solution, and is not applicable here.
Page 89 of 182
7.4.16.3
Save Caption
This defines the caption text that is shown on the SAVE button to the user when
editing a field.
7.4.16.4
Cancel Caption
This defines the caption text that is shown to the user on the CANCEL button when
editing a field.
7.4.17
Image decodes
Object Types can have population rules and display an icon against any required
attribute on the success of a population rule. You can use the defaults supplied from
the Central Image Store and create your own icons.
An attribute with an icon is read-only and cannot be edited.
Population Rules
You can assign multiple population rules to Object Types, as required. The first
successful population rule governs which icon is assigned to an attribute. When a
population rule succeeds, any other population rules linked to the same attribute are
not evaluated.
Allowable attributes
Each type of cell in a grid can include an icon except the Object Type cell. The
population rules can test any attribute within the row, not only attributes that are
visible in the view.
Default option
If no rules apply or if all rules fail, a user can show an icon or not as appropriate
using the Default option on the Cell Decodes screen.
Process
The following summarizes the process for adding an icon (image decode) using a
dashboard called 'Cash Ad-Hoc Item Search':
1. In design mode of the views to which you want to add the image decode
2. RMB on the column/cell and select Cell Add Decodes
3. Select the rules, image(icon) and position, Click [OK]
4. RMB and Save View.
5. Change Mode to display results, by right-clicking and selecting Change Mode
6. The selected icon is displayed when the rules selected are met.
7. To have the icon displayed for all cells in a column, in design mode RMB on the
configured decode and select Fill Down.
Page 90 of 182
7.4.18
Image decodes are removed per object type and view in Design mode.
To remove an image decode for Item Type
1. Right-click the dashboard, point to Views, and select a view.
2. Change to Design mode: right-click an Item Type cell, and select Current View >
Design.
3. In Design mode, right-click an Item Type cell, and select Cell > Clear Decodes.
4. Return to Display mode by right-clicking and selecting Display Results.
The icon is removed from the attribute for all rows for the Object Type (for example,
Our Cash Credit) that conforms to the population rule.
7.5 Configuring Forms
The Form control allows you to design a dashboard that contains selected attributes
from an associated search. The form displays the attribute values of one record at a
time for update or review, depending on the users attribute maintenance
authorities. A record browser is automatically included at the top of forms with
searches that return several records. You can add business logic tools to forms
either as toolbar/context menu options, or associated with buttons that you can
place on the form. Forms can also be used for manual input of data.
7.5.1 Form searches and prompts
Forms have associated searches that can contain Order Bys but, as the Form
presents individual records, not Group Bys and Aggregates.
After you have added the Form's search, you can start adding its attributes.
Irrespective of whether they are visible on the Form, search attributes can be
mapped into child dashboards.
Having selected the search, decide whether the records require sorting. Next, decide
how the search's default prompts are to be handled.
7.5.2 Manual Input Forms
You can also create forms that allow the manual input of data from TLM
WebConnect. To enable this, when creating a form you specify that the form is
populated by user input, rather than a search. When the form is displayed in TLM
WebConnect, the attribute fields are labeled but empty.
7.5.3 The Form Canvas
There is a difference to the canvas size
between Design Studio and TLM
WebConnect, for example when space is
taken up by the business logic toolbar in
TLM WebConnect. Therefore, in the form
design window a bar is shown at the
bottom of the form the height of the
SmartStream Technologies Limited
Page 91 of 182
business logic toolbar in TLM WebConnect. A bar is also displayed across the top of
the window where a record browser is displayed on search-based forms (but not for
manual input forms where it is not used).
For example:The area between these
bars is therefore the exact size of form
available to the TLM WebConnect user.
Page 92 of 182
You populate the form frame in the same way as for forms controls themselves, i.e.
you can add form fields, buttons and other frames.
7.5.7 Adding buttons to forms
You must configure the forms search before you can add any form objects.
To add buttons to forms, ensure that if
your form is within a frame you are not in
'form frame mode'. Click the pointer on the
form toolbar to make sure.
1. Select the Button option from the form
toolbar.
2. Position the cursor where you want the
button to start. The mouse pointer changes to
a cross and you click and drag the mouse to outline the button. Click and drag the
edges of the button to resize and reposition it.
3. Right-click on the button and select Configure Button.
4. Enter a caption for the button.
5. Select the Business Logic Tool from the drop down list.
6. Select the tool that you want to associate with the button from the list, Click [OK].
Page 93 of 182
Explicit Tab Index Order - Each form element is given a different number.
When displayed in WebConnect, tabbing through the form will cycle the
cursor through the attributes in numerical order from the lowest number to
the highest.
Column Precedence The tab flow is down each column starting with the
column on the left. This might be appropriate where the form attributes are
arranged in neat columns. Any tab indexes set for the form attributes.
Row Precedence - The tab flow is across each row from left to right. This
might be appropriate if the form attributes are arranged in neat rows. Any tab
indexes set for the form attributes are ignored.
The tab flow of the form can be controlled by configuring these options on the
Configure Form.
Select the Explicit Tab Index Order option button, click [OK]
Page 94 of 182
Each form element added to a dashboard has a default value of 1, so you can leave
tab index for the attribute that you want to be the starting attribute as 1.
1. Select the form attribute that you want to be the next in the cycle order.
2. Enter a number higher than 1 in the Tab Index field, Click [OK].
3. Repeat steps 4 to 6 for each attribute on the form, including buttons, if applicable.
You must ensure that no index numbers are duplicated, as there is no validation
performed on the numbers specified.
You could use multiples of, say, 5 for the tab indexes, therefore allowing additional
attributes to be added to the form and given an appropriate index number, without
having to renumber all the subsequent attribute indexes.
7.5.10
Text is added with the toolbar text icon or, as a consequence of using, the form's
Add attributes option. You can manipulate all text on the form, even that added
by the Add attributes option, independently of the attributes.
You must configure the forms search before you can add any form objects.
Click the toolbar text icon.
1. Click in the form window where you want the text to appear.
2. Enter the required text.
3. To modify the text; right-click on the text and select Configure Label, then edit the
Caption field.
4. To delete the text, Right-click the text and select Remove.
7.5.11
You can change the tool tip text for the attribute field, or select whether the text in
the field can span multiple lines. For manual input forms, you can also define an
attribute field as mandatory.
To modify attribute properties, right-click the attribute field and select Configure
Attribute.
1. To change the Tool tip text, edit the text in the field.
2. To add a scroll bar to the text field, which allows the text in the field to span multiple
lines, check the Multi-line checkbox.
3. If you are creating a manual input form and want this particular attribute field to be
mandatory, check the Field is Mandatory checkbox, Click [OK].
7.5.12
A form's view provides a set of potentially different attribute layouts for the different
business messages that the form needs to handle, such as "Their Cash Credit",
"Their Cash Debit" and so on. Views give the form designer greater flexibility, letting
one form cater for many situations.
Page 95 of 182
Because a form can have several views, there are the concepts of its default and
current views. The default view governs the selection and presentation of attributes
when the form first loads. It is also initially the current view. Using the form's rightcontext menu, the user can switch to another view, making that current.
At runtime, all views created for the form are available to its user but, unlike Grid
views, are unavailable globally to other forms. As the user browses the record set,
the form itself determines which of the view's layouts is used, depending on the
business nature (the level, or Leaf Node Value (LNV)) of the displayed record.
At design-time, only the default view is initially associated with the form. It's the job
of the form designer to anticipate the different messages that the form will be used
to process and create appropriate layouts for them. If all the view's layouts require
identical formats, they can be copied from one view to another.
The toolbar indicates what layout of the view the form is using. It provides a dropdown list of the layouts available for the view and its current record set, and allows
you to switch between them.
NOTE: When the form is forced to display a record for which you have not created a
layout, it displays a blank form.
Leaf Node Value (LNV):
The number of layouts within a view relates to the number of levels or LNVs
(Leaf Node Values) beneath the search's universe level. This can vary greatly
- for example, a search at the highest Item universe level has around 50
LNVs and, therefore, 50 layouts; while a search of the Queue, Set or
Category universes has one LNV and one layout. Another factor to take
account of is the record set that the search returns. Regarding that, only
records relating to the record set LNVs are presented as layouts for the view.
To determine the form's current view, Right-click the form and
highlight Views.
All the form's views are listed. A tick indicates the current one.
Page 96 of 182
7.5.13
You can also add annotations and horizontal lines to form views.
To modify a view's layout, select the view to be modified and select the required
layout from the toolbar drop-down.
7.5.14
When creating forms, each level that a form search returns is treated as a different
layout for adding tools and attributes onto. This means that the same attributes,
frames, buttons, horizontal lines, and text might need to be added to a large
number of form layouts. You can add form controls for one of the levels of the
search, and then copy them to the other levels as needed. Any attributes, frames,
buttons, lines, and text already on those layouts are removed and replaced with the
layout you are copying.
1. To copy a form's
layout, Right-click on the form
and select Copy Current
Layout.
The levels that are displayed
are the other LNVs at the same
level of the search.
2. Select the other levels
that you want this layout to
apply to and click [OK].
3. Any attributes,
frames, buttons, horizontal
lines, and text already on
the layouts for the other
levels are removed and
replaced with the layout you
have copied.
You can then add additional attributes or
other form controls that are specific to
the individual views.
7.5.15
Configuring a Manual
Input form
You can create forms that allow the
manual input of data from TLM
WebConnect.
To configure a form for manual input
1. RMB on the dashboard and select Add
> Form.
2. RMB on the form as select Configure
Form.
SmartStream Technologies Limited
Page 97 of 182
For each attribute, default text and an entry field are added to the form, for
example:
If you want any of the attribute fields on the input forms to be a mandatory field:
Any workflow tool buttons that the form contains will be disabled if there are any
blank mandatory fields, and enabled only when the mandatory fields have been
populated. Mandatory fields are displayed in TLM WebConnect with a red asterisk.
7.6 Configuring Treeview Controls
The treeview control is used to summarize data in a hierarchical representation and
to provide a drill-down facility to child dashboards.
Page 98 of 182
Treeviews are reliant on searches that return result sets of data to which Group Bys
and optionally Aggregates and Order Bys are applied.
New levels, or nodes, in the treeview are created by grouping the search result set.
For example, the treeview might display sets within categories. Using the configured
group bys, you can also enable the treeview to pivot, thereby changing the node
order displayed.
You can label treeview leaf nodes with aggregated data results. The supported
aggregate functions include min, max, average, sum, and count.
You can opt to draw the treeview with text, treelines, plus and minus symbols, and
pictures. You control whether the treeview is expanded on launch.
By default, users can drill down
only from the lowest level of the
treeview. You can configure the
treeview to enable them to drill
down from any level of the
treeview.
If you want users to be able
to drill down from any level of the
treeview clear the Drill down at leaf
nodes only checkbox
If you want users to be able
to drill down only from the lowest
level of the treeview, select the Drill
down at leaf nodes only checkbox
The treeview is normally
collapsed on launch, showing just the first level expanded. Clicking on a node
with branches opens that branch. You can configure the treeview to show all
nodes automatically on launch.
You can
configure a treeview
to allow dynamic
grouping of data. This
is achieved by
allowing the tree to
pivot.
o Using
the Default Level
spin box specify the
number of group-bys
that are displayed
when the tree is
initially loaded in TLM WebConnect.
Page 99 of 182
o You specify group by properties in the normal way. If there are more
group bys defined than the number selected here, the first group bys
in the list of those defined are displayed when the tree is loaded. For
example, if you select a default level of 3, but there are 5 group bys
defined, the first 3 group bys in the list are displayed when the tree is
loaded.
o The TLM WebConnect user can change which of the group bys are
displayed after the treeview has loaded.
7.6.1 Customising the aggregates display
You can use aggregates to label the leaf nodes with useful summaries and mapped
into the parameter prompts of child
dashboards.
On the Format tab, the Aggregates
dropdown list provides three options
that control the display of aggregates:
Do not show - hides the
aggregates; useful where you only want
to parameter-pass the attributes to child dashboards.
Show on Group By node - the default; displays one aggregate value next to
the leaf nodes.
Show as Node - creates a further level in the treeview, displaying all the
aggregates as nodes.
set up several control segments, each returning one value and drawing one
segment, bar or line coordinate.
Alternatively, you might set up
a single control segment and
define group bys to split the
result set into several groups,
represented in the chart by an
equivalent number of data
points (segments, bars or line
coordinates). These approaches
can be combined.
One aggregate is mandatory for
each chart search.
Several control segments are defined, each draws one data point. The order
of the control segments list determines the order of the data points.
One control segment is defined and group bys split the search results into
several data points. The control segment's order bys govern the order of the
data points.
time. Large data series present no problems for bar and line charts as they grow
linearly and can be scrolled.
Main tab's Chart Contents list, select Pie Chart, Bar Chart or Line Chart.
Specifying the chart projection: Charts are 2D or 3D. In 3D, you can specify the
depth of the Z(shadow) plane.
From the Format tab, select the appropriate 2D or 3D option, if you select 3D, use
the slider to set the Z plane depth.
Specifying the chart colour scheme: Bars, pie segments and lines are normally
displayed in the Blue colour scheme. Instead, you might prefer the Red or Green
colour schemes.
Specifying the Charts Boundary Lines: Bars, pie segments and lines are
normally drawn with white outlines. You can hide these.
Customizing the Charts labels: Bars, pie segments and line coordinates are
normally labeled with control segment names or Group By values, depending on the
how the chart is populated. You can customize labels to display aggregated values,
percentages and totals.
These options are described in the following table:
Option
Description
Example label
Value
10
Percentage
76.92%
Segment name
<3 Days
Name and %
<3 Days 10
% and Total
76.92% of 13
Specifying the chart's legend: You can display a legend on the chart to describe
the bars, line coordinates or pie segments. You might find this useful where you
want to un-clutter the chart's text. The Legend descriptions are control segment
names or Group By values; depending on the how the chart is populated,
concatenated with aggregated values. Although the content of the legend is
standard its position and appearance are customisable.
Specifying the chart background colour: You can select a chart background
colour. The default background is grey.
You
u can use custom
c
rather than pre-defined
p
d colours byy selecting
g Custom.... from
the dropdown
n list. You customise
c
the colourr using the Colour win
ndow, the same as
for other conttrols.
7.8
8 Parent Child Dashboard
D
d Relation
nships
The
e concept of
o parent child
c
dashb
boards is th
hat users are
a given th
he ability to
t create
rela
ationships between
b
dashboardss that enab
ble data to be passed
d through to
t other
searches and displayed on differen
nt dashboa
ards.
Para
ameters arre passed from
f
the parent
p
to itts children to synchro
onise the data
d
disp
play. Group
p Bys and Aggregate
es of a sum
mmary pare
ent control can be ma
apped into
o
search promp
pts of child controls. Group
G
Bys are typically used to
o drive the child.
A typiccal parent-child hierarchy
h
could be shown
as herre.
In thiss example
the pa
arent
treevie
ew
dashbo
oard has
direct control
over th
he child
dashbo
oards
num
mbers 1 an
nd 2. Child dashboard
d number 3 is controlled by acttions from child 1
and
d 2. Child 4 is contro
olled by the
e actions configured in child 3.
The
e Parent da
ashboard will
w pass atttributes th
hat match the
t require
ed data in the
t search
prompts for itts direct ch
hild relation
nships, sub
bsequently child 2 an
nd 3 will pa
ass the
a required to child 4..
data
Thiss kind of re
elationship
p can only be created
d if the orig
ginal search returns the
t
info
ormation re
equired by each of th
he child dashboards.
ng these re
elationship
p models ass an example, assum
me that Chiild 1 if laun
nched
Usin
alon
ne would prompt
p
the
e user for three
t
bits of
o informattion, Accou
unt Numbe
er,
Currrency, and
d Reconcilia
ation Statu
us. This me
eans that the
t data pa
assed by th
he Parent
musst include at
a the veryy least musst include those
t
fields.
Notte: as when
n configuriing these types
t
of relationshipss data is re
equired to be
b passed
betw
ween dash
hboards, it is importa
ant that the
e initial arrray contain
ns all of the
e
info
ormation re
equired to populate every
e
dash
hboard in th
he family sstructure.
martStream Tech
hnologies Limite
ed
Sm
Pag
ge 103 of 182
Further options available for configuration are shown in the figure below
Selecting Suppress Child
Prompts is considered best practise
to make the application appear
seamless, and to reduce the chance of errors when invoking a child
dashboard. Allowing child prompts will give the user the option to enter
search data, instead of using the data automatically passed from within the
existing array.
Only Refresh if Open, this option halts the refresh action if the child is not
already open, so the parent will not attempt to pass any parameters to this
dashboard as it has not yet been opened.
The only remaining option to be configured is the actual
parameter mapping and the configuration of the View to be
used to display the data(in Grid dashboards).
The fields in the window relate to both the Parent and Child dashboards. These
fields are:
Source the source represents the Group bys and Aggregates used by
the parent dashboard, one of these MUST be selected
Control this field shows the name of the child dashboard, there will be
more than one if multiple child dashboards are being linked to the parent
SmartStream Technologies Limited
Target Search allows the user to map parameters to the childs specific
search
Target Attribute the attribute required by the child search
Mapping Source the source to be passed to the child search, this can be
the actual attribute or a literal value. As the named parameters will have
defined types, the possible source attributes are constrained.
Pass Aggregate used if the user requires an aggregated value to be
passed to the child.
In this window users select the required view and then save that selection by
clicking OK.
7.8.4 Worked example of a parent-child relationship
This section illustrates how to define a parent-child relationship by using a parent
treeview to drive the record display of a child grid. An efficient order for creating the
necessary components is:
1. Create the search rule for the child grid search rule
2. Create the search rule for the parent treeview search rule
Firstly, create the child grid search rule at the Cash Settlements level of the Item
universe.
Define its Where clause as
The only condition for the parent search allows the user to restrict the types
of set presented in the treeview at runtime.
Then Insert a new dashboard called "child grid dashboard", configuring it to Listen
for parent's events:
Configure it with a new search list at the Cash Settlements level of the Item
universe
Click [Rules...] and select the "Child grid search rule" for the search list
Configure the treeview with a new search at the Set universe level called
"parent treeview search" that includes the "parent treeview search rule".
Define the treeview Group Bys: Set Category Code and Set Internal ID.
From the Available Dashboards, select the "Child grid dashboard" and move it
to the Launch Dashboards list.
Click [Setup Parameter Mapping] and map the parent's Set Internal ID and
Set Category Code into the same child search prompts.
Click [OK] and enable all the Launch/Refresh child on options, the Suppress
child prompts option and the Refresh option.
Copy the icon of the parent dashboard into you icon group for viewing in Web
Connect.
8 Module 5 - Matching
8.1 Objectives
Describe Straight Through Process Workflow (STP) or matching concepts and
processes
Scope
Population
Pass Quality Rules
Queues & Workflow
BDR
Group 3
Proposed
Match Queue
Group 2
Scope
(data set)
Group 1
Results
Population
Workflow
(further
Processing)
PQR Tests
The data set is then sorted and grouped using predefined attribute values in what is
called a population, it is worth knowing that if an item that can not be grouped with
any other item will constitute a group of its own.
SmartStream Technologies Limited
The grouped data is then tested to meet predefined criteria laid out by a collection
of pass quality rules (PQR), only items that meet all criteria will be presented as
either items on a proposed match queue or offered to other identified workflows for
further processing.
Any remaining items that did not meet the criteria identified by the all of the
predefined attributes and rules contained within the scope, population and pass
quality rules are available for the next pass.
Data
Set
Pass 1
Data
Set
Proposed
Matches
Pass 2
Data
Set
Proposed
Matches
Pass 3
Proposed
Matches
Process Flow
The process is repeated by adding additional passes until all items in the data set
returned from the business data repository by the scope have been proposed as a
match depending on the predefined criteria identified in each pass. Needless to say
after each pass the number of items in the data set is reduced, therefore only one
scope is required no matter how many passes are required to propose matches for
all items.
8.3 STP Workflow Steps
There are several steps used to define a
straight through process workflow or
matching process. The TLM Recon Admin
client groups these steps on the admin tree
under STP Workflow and are listed in order
that they require to be configured, starting
with the pass information, then pass lists and
finally an initiation.
Pass List
Scope
Pass
Pass
Population
PQR
Perfect Q
(AutoRelease)
SmallResults
Tolerance Q
Large Tolerance Q
Singleton Q
Configure
8.3.1 STP Flow - Initiations
Initiations are unique across TLM Reconciliations. Several can be created for the
same set and when invoked are a means of listing the passes identified to run for a
particular set. An initiation can be triggered manually by submitting the initiation to
the Workflow server, by scheduling, via a data load by GEMS or by an initiation
event.
8.3.2 STP Flow - Pass Lists
Pass Lists identify all passes configured to run for a particular set identified in the
initiation, the list is order specific meaning the pass at the top of the list has the
SmartStream Technologies Limited
highest priority will run first and therefore should be configured to contain the most
stringent criteria, for example a perfect pass should run first as it would by definition
exactly match or be perfect, subsequent passes will run in turn working down the
list relaxing the criteria accordingly.
8.3.3 STP Flow - Passes
Passes contain the central functionality and criteria for matching or reconciling items
for a predefined set identified in the initiation, including a scope, population and
pass quality rules. The first pass on any straight through process workflow should
contain the most stringent set of criteria; what ever does not succeed all criteria of
the first pass is presented for the next pass according to the order identified in the
pass list. Subsequent passes should be configured to contain relaxed matching
criteria including pre-identified tolerances etc.
The first thing that needs to be decided is the data to be used for the pass, we
already know that reconciliation can only occur in a set, and the set id is provided by
the initiation, we also know that to limit the amount of data a scope is used, by
default if a scope is not configured all outstanding items will be available for the
pass, therefore a scope should be used to reduce or select a range of outstanding
items. To narrow the scope further a population rule can be applied to the pass
ensuring that items are not duplicated if the pass has more than one population
row.
Population rows, which define how the item data is mapped into the matching
process grouping attributes from item types, therefore if the attributes to grouped
are the same on all sides only one population row is required encompassing all item
types by the selection of the appropriate level. The level available is dependant on
the level the scope has been configured for and therefore can not be set at a higher
level.
If the attributes to be grouped are different for different item types, additional rows
must be added to identify the item type and attributes to be grouped together.
There is also the option of aggregating or summing items together from one
population row before matching the groups with other population row items.
Aggregation can only be used if a unique reference is available for the item type
that will be aggregated, if not the user should use a pass quality rule.
Regardless of how many population rows are contained in a pass and whether
aggregation is used, the items are grouped and presented for further testing by pass
quality rules, it is important to remembering the minimum criteria needed for match;
set, date, amount and reference, the population should be configured to encompass
as many of the criteria as possible. For example:
Date
Reference
Amount
Level/Side
25/04/2008
Reference 1
12,000
CSett/Ours
25/04/2008
Reference 1
12,000
CSett/Theirs
25/04/2008
Reference 2
6,000
CSett/Ours
25/04/2008
Reference 2
4,000
CSett/Ours
25/04/2008
Reference 2
10,000
CSett/Theirs
Group
1
If the items above are returned by a scope and the matching criteria are;
same date
same reference
same amount
And thus configured as part of the population there will be four groups. We can then
test the groups using pass quality rules to ensure the item types are the correct side
and sign.
However if the same data is grouped only using reference (figure 40), there would
only be two groups and additional pass quality tests would be required to ensure the
item side and sign, dates, and amounts were correct.
If the same data is grouped on date and amount and an aggregation is applied to
CSett/Ours items using reference 2 as the unique value CSett/Ours items in group 2
will be summed together before being grouped with the CSett/Theirs item in group 2
which would provide a match.
Group
1
Date
Reference
Amount
Level/Side
25/04/2008
Reference 1
12,000
CSett/Ours
25/04/2008
Reference 1
12,000
CSett/Theirs
25/04/2008
Reference 2
6,000
CSett/Ours
25/04/2008
Reference 2
4,000
CSett/Ours
25/04/2008
Reference 2
10,000
CSett/Theirs
Each group in turn is then tested using pass quality rules which ensure the quality of
pass and test the items in each group based on criteria that can not be covered by
the population, namely item side and sign. It is also recommended that pass quality
rules are used to test for tolerances of attribute values that are not contained in the
population, or for items that constitute single groups.
8.3.4 STP Flow No Item Workflows
Some events can occur at the Set level and do not require any item detail to
operate; passes can be created so Workflow Tools are invoked against the Set being
processed without any item data.
Passes can be created without any population rows, where this is the case TLM
Recon Admin validates that the pass quality step has a Workflow Tool identified as
the processing option and no pass quality rules are present. However a scope can
still be used to select the data set negating the need to read data from the business
data repository for this and subsequent passes. If no scope is used and no
population rows are configured, the pass will use any items previously retrieved by
previous passes in the pass list, if this is the first pass no items are retrieved from
the business data repository. This is change from the previous functionality that
retrieves all outstanding items for the configured Set.
For passes with no population rows, the workflow sever can process only initiation
events and remove from queue events in the assigned workflow tool.
Operator
o How source will populate the target (equal to, greater than etc)
There are certain considerations the user needs to remember when configuring
matching rules, firstly:
The left hand side (LHS) of the condition is evaluated for all items
The right hand side (RHS) of the condition is evaluated once
Therefore expressions should be configured to only return one value from the RHS.
When checking that an attribute has the same value for each item in a group, do
not use:
WHERE attribute A Equal To attribute A
Instead make use of the ARE ALL THE SAME operator:
WHERE attribute A ARE ALL THE SAME
Likewise avoid expression such as:
WHERE attribute A operator attribute B
Unless attribute B only returns a single value for the group.
Also avoid:
WHERE attribute A +1 >= attribute A
This seems to allow a tolerance of 1 on attribute A for the matched items but the
RHS (attribute b) does not return all values for comparison. Instead tolerances
should be configured using the appropriate LHS aggregate function:
NET and NET PERCENT for amounts (only float data types). Utilise the
action property on the items which will return a + or depending on the
item type which must be catered for, to remove this sign a LHS attribute
function of ABS (absolute) should be used.
WHERE ABS(NET(Amount) Equal To 0
MIN and MAX for applying upper and lower thresholds to the LHS
attribute.
WHERE MIN(Amount) >= 1000
AND MAX(Amount) <= 10000
RANGE for specifying ranges for certain date and amount attributes.
WHERE RANGE(Date) <= 3 days
Or
WHERE RANGE(Amount) <= 500
The second consideration is the use of ORs within an expression that evaluates
items in a group. The following expression looks plausible when testing for one to
one matching of different item types:
WHERE COUNT(GIN) Equal To 2
AND Item Type Equal To type 1
OR Item Type Equal To type 2
However if there are two items in the group of different types (type 1 & type 2) they
meet the first count condition then both items are compared to type 1 and fail as
one of the items is different. Or both items are compared to type 2 and fail as
before, therefore the rule fails. The correct method is as follows and ensures that
additional counts are applied to each item found by the initial count identifying
single item types for single items:
WHERE COUNT(GIN) Equal To 2
AND COUNT(GIN) Equal To 1
WHERE Item Type Equal To type 1
OR COUNT(GIN) Equal To 1
WHERE Item Type Equal To type 2
If there are multiple values available for each different item type (Ours & Theirs),
the expression must be configured to show all possible item types:
WHERE COUNT(GIN) Equal To 2
AND COUNT(GIN) Equal To 1
WHERE Item Type Equal To Our type 1
OR Item Type Equal To Our type 2
AND COUNT(GIN) Equal To 1
WHERE Item Type Equal To Their type 1
OR Item Type Equal To Our type 2
Alternatively if the scope and population rules are configured to exclude all item
types resulting in only two item types remaining, the expression could be:
WHERE COUNT(GIN) >= 1
AND Item Type ARE NOT ALL THE SAME
When configuring rules for one to many, many to one or many to many item type
testing, the item counts should be adjusted accordingly to encompass the number
items required. E.g. many to many:
WHERE COUNT(GIN) > 1
WHERE Item Type Equal To type 1
AND COUNT(GIN) > 1
WHERE Item Type Equal To type 2
Other functionality include RHS values of Empty Date and Empty String to ensure
that dates or strings (references are empty:
SmartStream Technologies Limited
Rule Description mandatory fields used to identify the rule and level
Rule Detail expression that the rule will apply
Select the appropriate level from the down list on the rule description tab
remembering that the scope must contain the lowest level that includes all item
types for the set that is to be reconciled. Therefore population and pass quality rule
levels cannot be of a higher level than the scope. Give the rule a name (mandatory)
and a description. Select the second tab, RMB in the main window and select
insert. An expression Detail window will open prompting for values to be selected in
order to create expressions.
The configured expression is displayed in the Rule Detail tab as per figure 44.
Additional expression can be added by RMB in the window and selecting insert after
which opens the expression detail window as before. Expressions can also be
modified by RMB on the actual expression that requires amending and select either
delete or modify expression. When multiple statements are contained within one
expression there are more editing functions:
Insert After
Indent & Remove Indent
Also the expression clause can be changed by LMB on the clause and accessing the
drop down list. Please note that once an expression is changed, it is changed for all
processes that contain the rule the expression is applied to.
Once configuration is complete, select OK to save, the window will close and the
rule will appear in the appropriate rule list when expanded in the admin tree, the
rule can subsequently be re-opened for modification or viewing by RMB on the rule
and selecting the desired function.
SmartStream Technologies Limited
The resulting scope rule is displayed in the scope window (figure 46). Select the
population tab, RMB in main window, and select Population. In the resulting
population row properties window there are three tabs:
Population Rules used to narrow data set (if required). Only available
if Type is selected as population type
Aggregate Quality Rules used as per pass quality rules to apply
conditions to the aggregated population groups, i.e. ensure more than
one item is in group, or apply a threshold. Only available if Aggregate is
selected as population type
Select appropriate level, remember if a scope is used the highest available level is
dictated to the population, therefore only lower levels can be selected. Select
desired type in Population Type drop down list. Add any population or aggregate
quality rules as required as per adding scope rules. Select OK. The level is displayed
in the population window.
To group the data from the selected level RMB in the population window, select
add column. There are two options both of which are mandatory, firstly from the
drop list select whether column is to used for matching yes or aggregation no,
then select the data type from the column type drop down list and select OK.
Available options are:
String
Amount
Date
Integer
Added columns are displayed in the population window next to the level with the
data type shown as the header and a symbol to indicate a match column, LMB in
the cell below the column header and select the required attribute to group by. Only
attributes that are of the data type specified in the header will be available for
selection. Select OK column will now show selected attribute.
The final step in configuring a pass is to add the pass quality rules to test the
population groups. Select the Pass Quality tab, RMB in window and select add
step. The resulting window; rules properties has two tabs:
Properties
mandatory information to
apply universe, process
option, queue name, auto
release and priority for
pass quality step.
Rules used to
add collection of rules to
apply as part of pass
quality step.
The only universe
available for
reconciliations is item
therefore it is the only
option in the drop list,
select whether the results
of the pass quality test will be placed on a queue or assigned to an additional
workflow tool for further processing by selecting the appropriate processing option.
If queue is select as the processing option select the desired preconfigured queue
SmartStream Technologies Limited
from the queue name drop down list. Select auto release if the results are to be
automatically matched. Specify a Priority, if required, to control the order in which
matches are presented in Queue maintenance. This does not affect the order in
which the pass quality steps are evaluated. They are always evaluated in the order
in which they are displayed in the Pass Quality list.
Select the rules tab, RMB and select add, ensure the level is correct and select all
preconfigured rules from the available rule list by double LMB or highlight the
desired rule and selecting
to make rule selected. Once all rules have been
selected, select OK, results are displayed in the pass quality window.
Repeat process to add additional steps containing to test the same population
remembering not to test the same attribute that is contained as part of a population
column. Pass quality steps will run in the order they are displayed on the screen
with the step at the top of the list being evaluated first.
Pass quality steps can be edited or deleted by RMB on the desired step and selecting
the appropriate function.
8.4.5 STP Workflow Configuration Pass List
Expand STP Workflow in admin tree, RMB pass lists and select insert. The
resulting Insert pass list details window has two tabs:
Enter a unique name (mandatory) and description if required, select passes tab.
RMB in window and select add pass. From resulting passes in the add passes for
pass list window, select all required passes for this list/initiation.
Select OK and all selected passes will be displayed in insert pass list details
window. It is important to remember that the list is order specific with the pass at
the top of the list being processed first, therefore the order of the list can be
amended by highlighting the desired pass to change and selecting the up or down
order button to move the selected pass to the required position. Passes can also be
deleted from the list by RMB on pass and selecting delete. Select OK when all
passes have been added to list and the order is correct.
Pass lists can be modified in the normal way, they can also be deleted only if the list
has not been identified in an initiation, expand STP Workflow in the admin tree,
expand Pass Lists, select desired pass list, RMB select delete or modify as
required.
8.4.6 STP Workflow Configuration Initiations
Expand STP Workflow, RMB initiations, select insert. In the resulting insert
initiations details window there are five tabs:
Data Load identifies criteria for initiation on data load by set id & level
Priority identifies the precedence that one initiation has over another
Select Schedule tab. Double LMB add schedule resulting window allows the user to
configure a scheduled initiation based on:
Schedules can be edited at any time, RMB on desire schedule, select edit or delete
as required.
Select data load tab, enter level and set id of required account to be initiated.
When all information has been entered select OK. Initiation information can be
amended or deleted in the normal way, expand STP Workflow, expand initiations,
RMB desired initiation and select required function.
8.5 Invoking Initiations using the STP Workflow Sever
Once all STP Workflow configuration is complete the process can be invoked by
loading the STP Workflow initiation into the STP Workflow sever, the server or
engine will access the information in the submitted initiation including set id and
pass list and will perform the necessary tasks identified in the STP Workflow.
To configure a manual process, expand servers in the admin tree, RMB STP
Workflow, select insert, ensure submit by initiation is selected and select desired
initiation from initiation drop down list. Checks details, and select OK to submit
initiation to server.
8.6 Display Results
Results of all reconciliation processes should be displayed in the appropriate
preconfigured dashboard displays in TLM WebConnect.
8.7 Matching with Tolerances
As previously discussed all matching tolerances should be predefined as part of the
planning process for a STP Workflow (see figure 35). To configure any tolerances
the attribute that will be used is recommended not to be part of the population but
rather a pass quality rule is to be used utilising the appropriate aggregate function
and operator as per section 6.4.2, for example:
WHERE ABS(NET(Amount)) <= 50
WHERE RANGE(Date) <= 3 days
8.8 Data Enrichment Reference Masking
It is not possible to add tolerances to string fields; instead a mask can be applied to
an incoming reference or string attribute to create a valid reference by indicating
what to look for and where it is located within the incoming value. This type of data
enrichment is limited to extracting information therefore cannot insert additional
characters to the original attribute value, although the original attribute value can be
completely replaced.
TLM Recon Admin supports generic string manipulation using Reference Masking for
the identification of Sources, Brokers/Counterparties and Products as well as the
manipulation of strings for the rules-based proposal process.
References are extracted into an internal array from selected attributes based on the
Reference Mask parameters. Multiple masks can be applied to the same attribute
although caution should be taken due to performance implications especially when
the scope involves a large amount of data. The array of extracted references is then
used by Gems and Workflow depending on the Mask Type setting:
Reference Masks are not used directly by TLM Recon Admin for Search rules or
Release Workflow rules.
8.8.1 Reference Mask Types
Mask types are appropriate to the message component which contains reference
that is required for extraction. Available mask types are:
Source derives references for the GEMS validation engine enabling the
user to extract information from an incoming message that corresponds to
preconfigured source information
Different mask can be applied to different portions of the same message type. For
example a matching mask could be applied to derive a proposal reference and a
broker/counterparty mask to derive a validation reference.
Mask Sub Type only available for non-matching masks with two
available options:
o Mask Lookup takes successfully extracted reference masks and
looks them up on the alias table as an exact comparison
o Alias Lookup takes all alias for lead set and looks them up on a
partial basis on the extracted reference mask
less than identified number and extracted reference will be ignored. If left
blank parameter will not be applied
Mask from End start the extraction process from the end of the
attribute. Does not apply to strip leading zeros nor strip trailing zeros
Strip Leading Zeros applied before any other high level criteria used
to strop leading zeros from numeric portion of a reference ignoring all
alpha characters therefore stripping embedded zeros where appropriate
Strip Trailing Zeros - applied before any other high level criteria used to
strop trailing zeros from numeric portion of a reference ignoring all alpha
characters therefore stripping embedded zeros where appropriate
Test identifies the exact string to check against the extracted reference.
Can be used for all types of mask and partial matches. If not populated
extracted reference will succeed test by default.
Test Pattern Match scans the extracted reference with the test string,
can be used for partial matching and larger extracted references to ensure
a successful mask if an exact value is not known. If not selected the
extracted reference must exactly match the test string, as above.
Failure Action applies a function to the character based on a nonsuccessful character selection validation
o Proceed - if cell fails go on to the next character action
o Stop if cell fails do not continue cell evaluation but return the
reference that has been built up so far (subject to any min/max
checking)
o Fail if cell fails do not continue cell evaluation and reject the built
up reference
o Reset if cell fails return mask pointer to one while keeping the cell
reference pointer in its current position and clear any built up
reference. Example, if desired reference was five consecutive
numeric characters, reset function would effectively scan attribute
until desire reference was found.
o Reset Scan if cell fails return the mask pointer to the last scan
request and start re-evaluating the mask from the next character
keeping any built up reference so far. If there is no scan request,
process continues as per reset above clearing any built up reference.
Special
Special
This method returns the desired value including - separating numeric characters
using the special character selection. Returned value = 99-00-99
Position
Character
Selection
Anything
Anything
This method returns the desired value including - separating numeric characters
using anything character selection. Returned value = 99-00-99
Position
Character
Selection
Ignore
Ignore
This method returns a value ignoring - characters therefore reference will only
contain numeric values. Returned value = 990099
This type of mask can be refined by specifying that a minimum of six numeric
characters must be found to have a valid reference by utilising the character details
functionality.
D(9)
D(9)
D(-)
D(0)
D(0)
D(-)
D(9)
D(9)
By defining the actual characters in the relevant position including separating - the
mask is configured as an exact match. Returned value = 99-00-99
Strip Trailing
Strip Both
00123ABC45600
123ABC45600
00123ABC456
123ABC456
AA0099BB00
AA99BB00
AA0099BB
AA99BB
X01Y10Z
X1Y10Z
X01Y1Z
X1Y1Z
A0B0C
ABC
ABC
ABC
Zeros are striped depending on location of non-zero character which enables striping
of single and multiple zeros embedded in the reference
Partial Matching
Extracted Reference
ABC123DEF4
Max Partial
Characters
Partial Strings
Returned
ABC123
BC123D
C123DE
123DEF
23DEF4
By identifying 6 maximum characters for the partial match, 5 strings are returned
from the extracted reference of 10 characters
Final Test & Value. Incoming attribute = 111ABANK01999. N=numeric,
X=alphanumeric
Mask
NNNXXXXXXXNNN
Test
ABANK01
Selected
Value
ANOTHER BANK
Reference Used
ANOTHER BANK
By utilising the test details functionality, a portion of the incoming reference can be
identified by the test string and replaced by the value string for both aliasing and
matching depending on the type of mask.
8.11 Reference Mask Configuration
Expand Data Enrichment in the admin tree, RMB masks and select insert to display
the reference mask user interface. Enter relevant information into mask details
section of user interface including:
Mask Type
Description
Identify each character position and functionality by entering required test data into
character testing section.
Finally select mask fields to open choose attributes for the mask window, expand
universe hierarchy to select required level and make required attribute current from
available list. Select OK to save selected attribute and select OK again to save
mask.
Modified cell will display mask icon to the right of the attribute name. select OK to
save changes to the pass. The mask can be removed un-selecting mask in the
choose reference mask window.
Selected Rows
from
WebConnect
Fail
Question
with
Choices
Choice 1
Workflow
Rules
Pass
Choice 3
Choice 2
Event List A
Event List B
Event List B
Abort
Commit
Goto Step N
Goto Step N
If the tool is to be used as part of a STP workflow pass processing option testing the
items may not be required as elements of the STP workflow would have tested them
previously. Therefore a simpler workflow tool with little or no user interaction or
testing may be suitable.
STP Workflow
Pass
Processing
Option
Event List
Commit
Edit
Create Case
Resolve Case
Create Data
Population
Add to Queue
Remove from Queue
Initiation
Stop/Abort & Warn
Configuration Details
Population events are used within Create data events and offer the same
functionality as Edit events.
9.6 Case Events
Used to create or resolve cases of specific type using the items in the current group
(subject to schema level), however resolve case does not apply to Close when
History or Close when Re-raise Cases settings. Those are automatically handled as
items go to history or a new case is raised.
9.7 Create Data Event
Allows creation of new data records as part of workflow processing by taking values
from items in the current group, applying calculations if necessary to create new
values for new item. Typical uses for this type of event are creating a header record
or creating a net item.
Key Elements
9.11 Filters
Filters are used within edit, population and create data events to identify one or a
group of items selected on a WebConnect dashboard in order to:
Configuration Detail
Schema level
Population Rules
Sort Attributes to identify a lead item where processing requires a single
item
Universe
Name/Description
Icon
Group Threshold & Note Style (Mandatory or Optional)
Post-update action (update or remove)
There are a standard set of productised or reserved tools which are read or view
only, these are:
Create case
Resolve case
Edit
Delete
Un-delete
Link
Un-link
All business logic tools are added to dashboards and are viewed by a menu option
or a icon/button on the dashboard ready for user interaction via WebConnect
9.13 Workflow Tool Configuration
Configuration is dependant on the actual tool and will differ between each tool, for
example, if a rule list is to be used in the tool to test the items passed to it, a
collection of rules must be configured first, likewise events must be configured
before event lists, and some events namely Edit, Population and Create Data are
dependant on a Filter which must be configured before the actual event.
9.13.1
Configuration is achieved by accessing the expression builder for the type of rule
you want to create. Expand Workflow Elements expand Rules, RMB on the type of
rule required and select insert. There are two tabs in the resulting window:
Rule Description mandatory fields used to identify the rule and level
Rule Detail expression that the rule will apply
Select the appropriate level from the down list on the rule description tab. Give the
rule a name (mandatory) and a description. Select the second tab, RMB in the main
window and select insert. An expression Detail window will open prompting for
values to be selected in order to create expressions.
Selected the appropriate LHS
attribute from the drop down
list ensuring that it is
displayed in the Selected
Attributes pane before
selecting OK to return to
expression detail window.
Apply any aggregate and
attribute functions using the
appropriate drop down lists.
Select the appropriate
Operator and RHS value then
select OK
The configured expression is displayed in the Rule Detail tab. Additional expressions
can be added by RMB in the window and selecting insert after which opens the
expression detail window as before. Expressions can also be modified by RMB on the
actual expression that requires amending and select either delete or modify
expression. When multiple statements are contained within one expression there
are more editing functions:
SmartStream Technologies Limited
Insert After
Indent & Remove Indent
Also the expression clause can be changed by LMB on the clause and accessing the
drop down list. Please note that once an expression is changed, it is changed for all
processes that contain the rule the expression is applied to.
Once configuration is complete, select OK to save, the window will close and the
rule will appear in the appropriate rule list when expanded in the admin tree, the
rule can subsequently be re-opened for modification or viewing by RMB on the rule
and selecting the desired function.
9.13.2
Workflow filters are used to sort and restrict items selected on a WebConnect
dashboard when using an Edit, Population or Create Data event. Configuration is
achieved by expanding Workflow Elements then RMB on Filters and select insert.
Select the appropriate hierarchical level that the filter will be applied to and give the
filter a name (mandatory) and a description if required.
A population rule can be added to the filter by selecting the Population Rules tab,
RMB in the window and select insert. Population rules are used to narrow or
restricted the data that is contained in the filter if required, for example if only item
reconciliation status items of outstanding are to be used then a population rule to
that effect should be used. Please note that population rules are not required if all
rows on the appropriate dashboard meet the criteria of the workflow tool.
The final stage is to sort the attributes by selecting the sort attributes tab, RMB in
resulting window and selecting an appropriate attribute and selecting OK when
finished. By default the attribute will be sorting in an ascending (ASC) order which
can be changed to descending (DESC) if necessary by LMB on the attribute.
All configuration aspects of the filter can be changed by RMB on the filter in the
admin tree and select modify where necessary.
9.13.3
Identify the source criteria by selecting the Formula tab. Select an appropriate filter
from the source items browse option, and identify the source component by RMB in
the main window and selecting either:
Source from value if the target attribute is an integer, source from value
will provide a drop down list of all decodes for that integer. All other options
are disabled
Source from attribute will allow an attribute to be selected from the filter
and aggregation functions applied to that attribute where appropriate.
Select OK on all windows when configuration is complete. The event can be opened
and modified or viewed at any time by RMB on the desired event in admin tree and
selecting modify or view where appropriate.
9.13.4
Case
Other information such as case priority, code and workfolder for auto assigning to a
group of people can be provided in the case details tab.
Likewise amount and reference values from the actual items can be provided by
selecting the appropriate tab and attribute from the available browse options. This
will aid in the investigation process by pre-populating preconfigured dashboards.
Select OK on all windows when configuration is complete. The event can be opened
and modified or viewed at any time by RMB on the desired event in admin tree and
selecting modify or view where appropriate.
9.13.5
Select OK when configuration is complete. The event can be opened and modified
or viewed at any time by RMB on the desired event in admin tree and selecting
modify or view where appropriate.
9.13.6
These types of configuration are only used as part the release workflow for user and
sets and therefore are not available for standard Workflow processes or Business
Logic Tools. Configuration is achieved by expanding Workflow Element and Events
in the TLM Recon Admin admin tree. RMB Warn or Stop/Abort and select insert.
Enter a name into the name field (mandatory) and select the appropriate display
level from the drop down list as appropriate, and give a description if necessary.
SmartStream Technologies Limited
Supply an appropriate message that will be presented on screen to the user. Select
OK when configuration is complete. The event can be opened and modified or
viewed at any time by RMB on the desired event in admin tree and selecting modify
or view where appropriate.
9.13.7
Select the message type (e.g Our Cash Credit or Our Cash Debit) that is to be
created from the drop down list supplied by TLM SmartSchema. Select an
appropriate filter from the source items browse option to sort the entries selected on
a WebConnect dashboard.
Further options are Target Item Set which allows the user to select which set the
new data will be added to:
Actual attributes and their values are added to the create data event by selecting
the attributes tab and either adding/removing attributes from the attribute for item
list, or selecting attributes provided by a population event and making them
available for the item. Alternatively the user is able to copy matching attributes from
source which will provide all attributes contained in the sourced item.
Select OK when configuration is complete. The event can be opened and modified
or viewed at any time by RMB on the desired event in admin tree and selecting
modify or view where appropriate.
9.13.8
Select appropriate Queue from drop down list, check Prevent Duplicate if
appropriate and check Do not Audit if appropriate. Select OK when configuration is
complete. The event can be opened and modified or viewed at any time by RMB on
the desired event in admin tree and selecting modify or view where appropriate.
9.13.10
Select appropriate Initiation from drop down list, select Do Not Audit where
appropriate. Select OK when configuration is complete. The event can be opened
and modified or viewed at any time by RMB on the desired event in admin tree and
selecting modify or view where appropriate.
9.13.11
Select the Events tab and make available the desired event. Select OK when
configuration is complete. The event can be opened and modified or viewed at any
time by RMB on the desired event in admin tree and selecting modify or view
where appropriate.
9.13.12
Post update identifies what will happen after the tool has been processed,
options are: Refresh Rows, Refresh Control, Refresh Dashboard or Close
Dashboard.
Requires Selection indicates whether rows must be selected on the
WebConnect dashboard or not
Universe cannot be changed as the workflow engine/server only operates
on the item universe
Refresh Parent refresh the parent dashboard where appropriate
Icon different icons for representing the Tool can be selected from the
database
The actual workflow is configured by selecting the Workflow tab, the first step is to
add a step by selecting the new step icon located at the top of the vertical tool bar.
Once the step is added the size, colour and name can be changed by highlighting
the step with a LMB and then RMB to access the menu options, the step can also be
relocated by deselecting the auto arrange and resizing accordingly.
To access the properties or actual build the contents of a step either LMB then RMB
the desired step and select properties which will access the contents of the step, or
double LMB on the step to achieve the same result.
Add step
To add a rule list, event list or choice list to the step select the appropriate icon from
the tool bar once inside the step.
To add the properties of any of the above lists can be configured by double LMB of
the appropriate icon.
Event list properties opens the event list window which prompts the selection of the
preconfigured event list containing all preconfigured events. These events are
displayed in list once OK is selected.
Rule List properties are configured in a similar way to event list properties apart
from the list is not pre-configured and individual rules are added to properties
window.
Choice List properties are configured as per the Event and Rule List properties but a
question must be provided in the question field to display in WebConnect and
subsequent choices are added for each outcome, the configured choices are
presented to the user as a drop down list in WebConnect under the configured
question. Default choices are indicated by a bold line in the workflow configuration
window and a tick icon next to the actual choice.
All list properties have Next Action. The next action identifies what will happen next
depending on the List currently in use. Options are:
Select OK on all windows when configuration is complete. The tool can be opened
and modified or viewed at any time by RMB on the desired tool in admin tree and
selecting modify or view where appropriate.
Universe
Name/Description
Icon
Group Threshold & Note Style (Mandatory or Optional)
Post-update action (update or remove)
There are a standard set of productised or reserved tools which are read or view
only, these are:
Create case
Resolve case
Edit
Delete
Un-delete
Link
Un-link
All business logic tools can be added to dashboards and are viewed by a menu
option or a icon/button on the dashboard ready for user interaction via WebConnect,
or added as part of a STP Pass process for automated processing.
10 Exercises
Exercise 1 SmartSchema Familiarisation
Instructor Lead Demo
Access Rights
All High
Release Workflow
None
Procedure:
Login to TLM Recon Admin Client
With a system administrator user log into TLM Recon Admin.
User name setup
Password password
If not visible unhide admin treeview.
RMB anywhere in client display and deselect Hide Treeview
Allocate Message Types
Access user control function on desired user and allocate appropriate message
types
a. select message maintenance from user control list
b. double LMB message type in left pane on user message maintenance
window to expand universe structure.
c. Expand cash and select cash settlements to display appropriate
message types for that level in message type pane
d. Select Our Cash Settlements in message type pane then add to make
selection appear in current selection pane by double LMB or select
greater than sign
e. Repeat step d for Their Cash Settlements
f. Select OK
Assign Access Rights
Access user control function on desired user and assign appropriate access and
limits
a. select access and limits from user control list
b. select All High to assign maximum access right for this user type
c. select OK
Configure Release Workflow
SmartStream Technologies Limited
Access user control functions of desired user and configure unique release
workflow
a. select release workflow from user control list
b. RMB in release workflow window to access available options
c. Select remove to delete currently assigned workflow
d. Select OK
Test new user
Log out of TLM Recon Admin
Log into TLM Recon Admin using new user
User name training
Password - password
Type: Custodian
Set
ID: Training
Currency: GBP
Type: Nostro
Name: Training
Set Basis: DoubleEntry
Message Feed 1
Feed: BASIC_OUR_CASH
Message Feed 2
Feed: 0081190-00-BASIC-1
Procedure:
Create new category
Expand business data, RMB categories and select insert to display category
details window and enter relevant information
a. Enter training cash into category code field
b. Select custodian from type drop down list
c. Select OK
Create new set
Expand expand new category, RMB sets and select insert to display set
administration window and enter relevant information
a. enter training into set id field
b. select GBP from currency drop down list
c. select nostro from type drop down list
d. select doubleentry from set basis drop down list
e. select address tab and enter training into name field
f. select OK
Create new message feed for our side
Expand new set, RMB message feed and select insert to display message feed
static window and enter relevant information
a.
b.
c.
d.
select Our Cash Settlements from message type drop down list
enter BASIC_OUR_CASH into message feed field
enter L01 into short code field
select message feed static2 tab and ensure following is selected
i. proposal triggering any matching input
ii. status active
iii. validate sequence checked
iv. validate balances checked
v. check duplicate item checked
e. Select OK
On tab two, add a Bar Chart to use the Item universe at the Cash
Settlements level
o Group the chart by Item Currency
o Aggregate by Sum of Item Amount
o Tidy the chart by adding a legend, labels and the size of the chart
so that it both easy to use and pleasing to the eye
Pass details
Method: Set Id
Condition: Outstanding
Reconciliations Items
Condition: String, Date & Amount
Processing: Queue
Description: Perfect 1-1
Procedure:
Create Processing Queue
RMB Queues in admin tree, select insert to display queue detail window and
enter relevant information:
a. Enter TRG CSett Perfect into Queue Name field
b. Enter Perfect 1-1 into Description field
c. Select OK
Create STP Scope Rule
Expand Workflow Elements in admin tree, expand rules, RMB Scope and select
insert to display New Scope Rule Detail window and enter relevant information
in Rule Description tab:
a.
b.
c.
d.
e.
f.
Select Rule Detail tab, RMB in main window, select insert to display expression
detail window and build appropriate scope rule:
g. Select Item Reconciliation Status from available left hand side
attribute list
h. Select Equal To from Operator drop down list
i. Select Outstanding from Right Hand Side Decode list
j. Select OK to view expression
k. Check expression reads
Where item reconciliation status equal to outstanding
Select OK to save expression if correct
l. RMB on expression, select modify, make necessary changes where
required, select OK as per step j above
Create STP Pass Quality Rule
Expand Workflow Elements in admin tree, expand rules, RMB Pass Quality and
select insert to display New Pass Quality Rule Detail window and enter relevant
information in Rule Description tab:
a. Access drop down list in Level field
b. Expand Item
c. Expand cash reconciliations
d. Select cash settlements
e. Enter TRG CSett 1-1 into Name field
f. Enter appropriate description into description field
Select Rule Detail tab, RMB in main window, select insert to display expression
detail window and build appropriate pass quality rule:
g. Select Item Gin from available left hand side attribute list
h. Select Count from left hand side aggregate function list
i. Select Equal To from Operator drop down list
j. Enter 2 into Right Hand Value field
k. Select OK to save expression
l. RMB in main window, select insert at end to open expression detail
window
m. Select Item Gin from available left hand side attribute list
n. Select Count from left hand side aggregate function list
o. Select Equal To from Operator drop down list
p. Enter 1 into Right Hand Value field
q. Select OK to save expression
Name:
Pass details
Name:
Condition: <50
Condition: +/- 3 days
Condition: 6 numeric characters
Method:
Scope Level:
Name:
Condition:
Population Level:
Condition:
Condition:
Condition:
Condition:
Condition:
Condition:
Condition:
Condition:
Condition:
Condition:
Condition:
Condition:
Condition:
Condition:
Condition:
Condition:
Queues Name:
Name:
Name:
Name:
Name:
Name:
Procedure:
Complete STP Workflow planning process
Complete STP Workflow configuration including:
all necessary processing queues
all necessary rules required to complete pass configuration
apply reference mask to appropriate population cell
Create Reference Mask
Expand Data Enrichment, RMB masks, select insert to display reference mask
user interface window and enter relevant information:
a. Enter Matching from mask type drop down list
b. Enter TRG Item Ref 1 6 numerics into description field
c. Complete character details to read:
i. Minimum characters = 6
ii. Minimum numeric characters = 6
d. Complete character test information to read:
Character position = 1
Character selection = numeric
Character action = scan & select
Fail action = fail
e. Repeat for character positions 2,3,4,5 & 6
f. Select mask field
g. Ensure item reference 1 is made selected
h. Select OK to save selected attribute
i. Select OK to save mask
Manually invoke initiation
Expand servers from admin tree, RMB STP Workflow, select insert to display
STP Workflow Details window and enter relevant information:
a. Select previously configured initiation from initiation drop down list
b. Select OK to send initiation to workflow sever
Verify process completion and display results
Verify completion of process by RMB STP Workflow and selecting refresh,
entries will disappear from list when processing is complete. View results in TLM
WebConnect
iii.
j.
k.
l.
m.
n.
o.
Locate desired filter in available filter list and make select by moving it
to select filter list
Select OK
RMB in main formula window and select add
Select source from attribute option in source type box
Select browse button in source attribute field
Browse, select and make active item Gin from list of available attributes and
make selected by moving to selected attributes list
Select OK three time to save and apply configuration
q. Locate TRG CSett Copy Ref1 Event List in available event lists list and make
selected by moving to selected items list
r. Select OK event list properties will now show contained events
s. Select next action tab and select [New] commit workflow
t. Close properties window by selecting standard Windows close option located
top right of window
u. Select OK in tool details window to save and apply configuration
Apply & Test Tool
Ensure tool is located and selected for use in user assigned role. Add tool to
appropriate dashboard and save dashboard configuration changes.
Login to WebConnect, access desired dashboard, select single row and invoke tool
Observe results item reference 2 will not be replaced with value from item
reference 1
g. Add rule list to step properties by selecting new rule list icon located two from
top of tool bar
h. Access rule list properties as per accessing step properties
i. Double LMB rule list properties to display select rules window
j. Expanded universe level and select cash settlements
k. Select and make selected rules created at start of exercise from available
rules list
l. Select OK, selected rules will appear in list
m. Select next action tab and select [New] event list for available actions
(pass)
n. Select [New] abort workflow for available actions (fail)
o. Close rule list properties window
p. Select event list 1 located in main workflow window and add TRG Manual
Match Event List
q. Select OK to save and apply configuration
Apply & Test Tool
Ensure tool is located and selected for use in user assigned role. Add tool to
appropriate dashboard and save dashboard configuration changes.
Login to WebConnect, access desired dashboard, select multiple rows and invoke
tool
Observe results item reconciliation status will change to History and match id
column will be updated
Try selecting a single row or no rows and invoke tool again, observe results as tool
is aborted