SMART SCHEMA DESIGN

Current Version:

1.0

Author:

Neha Singh

Date Created:

6th November 2012

Last Updated By:

Neha Singh

Date Last Updated

8th November 2012

Reviewers:
Name

Role

Mani, Dhayalamoorthy

Project Lead

Shweta Kulkarni

Team Member

Goranthla Suman

Team Member

Praveen Kumar P

Team Member

Praveen Kumar DR

Team Member

Document Contorl:
Version number

Key updates

1.0

- Customizing Smart Schema

TABLE OF CONTENTS

1 Introduction

2 Logging in

3 Entities And Joins

4 Important Schema Features

Creating Objects
5. a. Deleting/Copy-Paste an Objects
5. b. Grouping Objects
5. c. Object Properties

10
15
17
19

Creating Attributes
6. a. Setting Attribute Properties

28
31

Universe Creation
7. a. To Edit Entity and Joins
7. b. Delete Universe

37
39
43

Important Considerations

44

1.

Introduction

Smart Schema is a sensitive and important component provided by Smart

Stream technology as a part of Transaction Lifecycle Management software
package and it plays a vital role in handling various kinds of reconciliation.
The objective of this document is to guide TLM professionals about various
features of Smart Schema and its customization.
After reading this guide, user should be able to customize Schema as per the
business requirement.

2.

Logging in:

If the TLM software is installed in your machine then go to Start menu and
select Programs -> Smart Stream Technologies -> Smart Schema.
If the software is installed in clients machine and you have an access to a
citrix URL. Login and select TLM Utilities -> Smart Schema.
After the application is launched login prompt will appear in front of you as
shown below:

Choose your database type (e.g. Oracle, SQL Server, Sybase or Sybase 15).
Enter Server name followed by port number separated by a coma.
Then enter the database user credentials i.e. user id and password used for
logging into database.

Click Login button. If all the above details are correctly entered, Smart Schema
Interface will appear on the screen as displayed below:

Using Options we can change the interface access view as Normal or

Administrator.

Using Administrator access mode gives extra privileged to modify property for
the productized objects and attributes.

3.

Entities and Joins:

Entities and Joins define a universe. To see a universes entity and joins view
select the particular universe and then click Entities and Joins tab right
beside the Object and Attributes tab at the bottom of the current screen as
shown below:

You can go back to the universes hierarchical view again by selecting the
Object and Attributes tab.
Below is the entities and joins view of a universe:

Components displayed in the below picture are:

Base table table which is the parent of all the other tables and builds the
first join/relationship with other tables which in turn are joined with several
other tables. In this case it is item (I). Here I represents the alias name given to
this table.
Solid line without any end point circle solid line represents an inner join
(only matching records based on the mapping attribute) and no end point circle
represents a mandatory join.
E.g. join between acgr (AC) and grup (G) tables in the below picture.
Dotted line with a circle at the end point Dotted line represents an outer
join (all records from a specific table) and a circle at the end point represents
an optional join.
E.g. join between item(I) and stck (SK) tables
Base Entity It is represented by a pink background around the rectangular
box. Base entity is the one who has the mapping attributes as the primary key.
Other Entities They are represented with a dark blue outline. They are joined
with the Base entity using the foreign key concept which references the
primary key of the base entity.

4.

Important Schema features:

- This icon is used to see attributes which are common to more
than one child objects/levels and created at parent level and are
inherently available to be used at the child levels or leaf node levels.

Note: Attributes created for the objects at the same levels wont be
available for use to the other levels present at the same level in the
hierarchy.
- This icon is used to see only those attributes which belong to
the base table (that is the table present at the pick of the entities
and joins view). For Item universe base table is item. Again if you
click this icon it will show the attributes of all the tables joined
together.
- This icon provides filtering option for attributes based on their
name table data type. To remove filter option once again click the
same icon.

5.

Creating Objects:

For any creation or modification in the Schema, it should be in unlocked mode.

To change the mode, click the Lock button placed on the top of the left side.
As soon as we click, it changes to unlocked mode as shown below:

If you are going to create a new object, it must have objects created in Item,
Message Type, Message Header and Case Summary (this universe is required if
handling cases are a part of the business requirement) universes.
To create a new object or level steps are as below:
Go to Item universe:
Expand the Item Level, you will be able to see some levels are
already present under Item level e.g. Cash Reconciliations, Position
Reconciliations etc. These are productized levels created by smart
stream and ready to use.
All the objects/levels have a hierarchical structure as shown below:

10

The lowest levels or the child levels are also known as Leaf Nodes.
In this case Credit Confirmation, Debit Confirmation, Our Cash Credit, Our
Cash Debit, Their Cash Credit, Their Cash Debit, Credit Request and Debit
Request are leaf nodes as shown above.
To create a new object,
Either right click Item level and select Add Object option or select
the Add Object icon

11

Name the object following business convention. Then create child

levels for the newly created level in the similar fashion as mentioned
in step 4.
Child nodes may either represent a credit/debit (for cash
reconciliations), ours/theirs (for cash/security reconciliations) as all
the reconciliations commonly have at least one statement and one
ledger side.
Each level is assigned a unique id to reference it to; it helps in
referencing an object and setting its properties values or licences
from backend (i.e. database) which are disabled for a normal user to
edit.
Similarly levels have to be created under Message Header and
Message Type universe.
Whatever Leaf Nodes / Child Objects we create in Message Type
universe; those levels appear in Recon Admin while creating a
Message Feed.

12

e.g.
Levels in Item Universe:

In Message Header Universe:

In Message Type Universe:

13

So levels available for creating message feed in recon admin is Their Cash
Confirmations

14

5. a. Deleting/Copy-Paste an Object

An object with one or more child objects cant be deleted until its
child objects are deleted.
To delete a lead node/child object, either right click and select the
delete object property or use delete icon

Similarly to copy/paste a selected object use copy

and paste

icons or use copy paste option from the menu after a right click
on the selected level.

15

16

5. b. Grouping Objects

All the objects created under Item and Message Header universe must be
grouped with the objects created under Message Type universe.
Grouping pane is available just below the Attributes pane in the middle for
each level.
It can be done in both the ways.
Either you group message type object with the corresponding object in Item
universe. This grouping link will automatically appear in the grouping pane for
the corresponding object under Message Type universe.
Or under Message Type Universe, for the newly created Leaf Node/Object
group the corresponding object of Item and Message Header universe in the
Groupings pane. These grouping links will automatically appear in both Item
and Message Header Universe for the corresponding levels.
Usage: Grouping is use full when you are going to use Generic Message
Maintenance functionality for your newly created Message types.
Also it helps linking the items loaded into item table with Message Header and
Message Feed table which helps in loading data and reloading it using Generic
Message Maintenance (if feed goes in Operator Intervention).
Hence Grouping must be done for all the newly created levels.

Note: If you have a client requirement to remove an attribute (created for a

particular level). Then you are going to try deleting an existing attribute for a
level in Item universe and if data is loaded for that particular level in database.
It wont allow deleting the attribute.
In that case remove grouping for this particular level in Item Universe and then
delete the attribute.
It will allow deleting, but later do not forget to add the grouping again.
Otherwise any items loaded for this feed wont appear in the dashboards and
Generic Message Maintenance wont work.

Below is the Grouping pane under Message Type universe:

17

Similarly all case levels present in Case Summary universe can be grouped for
the particular level in Message Type. It defines which types of case can be
raised on a particular item loaded for the particular Message feed (or message
type level).

18

5. c. Object Properties:

Objects properties govern the behaviour of the items loaded for the
particular object in TLM web connect as well as recon admin.
By default Schema displays only checked properties for an object. To see all
the properties available for selection, the checkbox icon
unchecked.

can be

Note: Object properties are not inheritable i.e. they dont get inherited
from the parent level object to its child level object. Only those properties
which are assigned to an object will depict the behaviour of it.
Object Properties pane is available just in the middle of the interface above
Attributes pane. If you select a particular object, properties for that object
will appear in the properties pane and can be set as per the requirement.

a. Each leaf node for which data needs to be loaded in the database must
have the following properties set in Item universe:
Item Side - Side depicts that whether the item loaded for this level will be
treated as Ours (Ledgers) or Theirs (Statements).
If the values is L, item is considered to be an Our side item. If it is S, item
is considered to be Their side item.

Item Sign Sign depicts the type of the item value C (Credit), D (Debit) or
U (Unassigned).

19

Generally Credit and Debit comes for cash items and unassigned is used for
both security position items.

Action It depicts the sign of the amount. It is used by TLM while evaluating
aggregate functions like NET or NETPERCENT upon the amount attributes.
The sign will be appended to the amount value and then it will be netted.
Note: It is not applicable to all aggregate functions like SUM doesnt make
use of sign mentioned in the Action property.
For our side items (for which Side is L) Action used is and for their side
items (For which Side is S) Action is +.
Above mentioned properties are the mandatory properties need to be set
for a Leaf Node/Child level object in Item universe. Apart from these, some
optional properties also can be set as required (in Item universe):
Note: You may have requirements of creating some objects for which you will
never load data. Those levels will only be used to create a netting item if a
data mismatch is there. Such leaf nodes wont require Action, Item Side and
Item Sign properties to be set.
Events- Create Item Available Makes the level available for Create Data
event in Recon Admin. (This is required for those levels which are used to
create a netting item when a data mismatch occurs).
Event Edit Available This property if checked, allows the developer to use
this level in Edit events i.e. to edit the attribute values for data loaded at this
level.
Dashboard Grids and Searches Available This property must be checked if a
dashboard has to be created at the particular level, so that the level will be
available for all the components of a dashboard i.e. Search Rule & Grids.
20

b. There are no properties to be set in Message Header universe.

c. In Message Type universe, following properties must be set for those newly
created leaf node for which message feed will be created and data will be
loaded into database.
If you are going to use Generic Message Maintenance functionality for your new
message types, then following properties must be checked for the
corresponding leaf node in Message Type universe:

Generic Manual Input Max Rows If this property is set, it tells the maximum
number of rows permitted in Generic Manual Input for an object.
Generic Manual Input View General Manual Input is available for this
object.
Mtype is the Leaf Node value of the object in Item universe which is grouped
with the selected object of Message Type universe.

Mtype is set to 10019 which is the LNV of this object in Item universe:

21

Below properties governs the message feed properties in recon admin:

Message Feed Admin check_duplicate_item field enabled If we check this

property, it enables the Check Duplicate Item checkbox while creating a
message feed in Recon Admin as shown below:

22

Value 1 makes the checkbox auto checked whenever a message feed is created.
Message Feed Admin collect_stats field enabled - If we check this property,
it enables the MIS Statistics checkbox while creating a message feed in Recon
Admin as shown below:

Value 0 represents the checkbox wont be auto selected but enabled to be

selected if required.

23

Message Feed Admin load_advisory field enabled - If we check this property,

it enables the Advisory Items Only checkbox while creating a message feed in
Recon Admin as shown below:

Message Feed Admin over_inbrcode field enabled - If we check this property,

it enables the Item Overrides Default checkbox while creating a message
feed in Recon Admin as shown below:

24

Message Feed Admin proposal_triggering field enabled - If we check this

property, it enables the Proposal Triggering dropdown while creating a
message feed in Recon Admin as shown below:

25

Message Feed Admin stmt_freq field enabled - If we check this property, it

enables the Statement Freq dropdown while creating a message feed in
Recon Admin as shown below:

Message Feed Admin stmt_source field enabled - If we check this property,

it enables the Statement Source dropdown while creating a message feed in
Recon Admin as shown below:

26

Message Feed Admin Value of balance_type - If we check this property, it

doesnt enable but populates the Balance Type field with a value while
creating a message feed in Recon Admin as shown below:

Value
Value
Value
Value

0
1
2
3

represents No Balances,
represents Currency Balances
represents Transactions Balances
represents Positions Balances

27

6.

Creating Attributes:

Attributes to objects are the fields mapped to a database and which can
also be used in Recon Admin to construct the match flow. Attribute pane is
situated just below the Object properties pane in the middle of the Schema
interface.

Considerations:
In Normal access mode a user can map only those fields which are
spare for use. Since there are a fixed number of fields available for
customization for each universe.
But the required field can be copied from Generic Item template and
pasted at the desired object level. After pasting the attribute, names
can be modified.
With Administrators access this field mapping can be overridden at a
different level and fields can be re-used for different objects.

28

Object at child level inherit all the attributes of their parent level
under which they have been created.
Since objects at the same level do not inherit each others attributes,
so objects at the same level can use same field for mapping.
In this case, to optimize the schema structure, it is preferable to add
all the common attributes among the same level objects at a
common parent node.
Caution: While overriding a field mapping, you should take care that it
is not creating any ambiguity for TLM i.e. if same field is available with
different names after inheritance for an object then it might create
confusion for TLM while using this attribute for build in Recon Admin.
Attributes are inheritable from parent nodes. Hence all the common
attributes for ledger and statement level can be added to the parent level
and will be inherited by leaf nodes.
Note: You cannot add attributes to the levels in Message Type universe.
To add an attribute, use following steps:

Unlock Schema using

button.

Select Item universe from the Universe selector pane situated at the
very leftmost of the Schema interface.
Then select the desired object level for which you want to add the
attributes.
If the Attributes pane is collapsed, expand it using

If already attributes are present, scroll to the bottom of the pane

and at the end. An empty row will be available.
Now either you can create an attribute selecting the field from the
available fields dropdown OR can copy attribute from an object
where the desired field is already defined using copy button
then paste it to your selected object level using paste button

and
.

To delete an attribute use following steps:

29

Unlock Schema using

button.
Select Item universe from the Universe selector pane situated at the
very leftmost of the Schema interface.
Then select the desired object level for which you want to add the
attributes.
If the Attributes pane is collapsed, expand it using
.
Then select the attribute which you want to delete and click delete
button.
Note: If already some data is loaded for the particular object, then you
might not be able to delete the attribute directly. In such case, first remove
grouping of the selected object from grouping pane. After that attribute can be
deleted, but dont forget to add the grouping again. Then lock the schema.

30

6. a. Setting Attributes Properties

Attribute properties govern the behaviour of an attribute in Recon Admin,
Smart Studio and web connect.
Attribute Properties pane is situated at the rightmost corner of the Schema
interface as highlighted with a black background in the below pic:

If you create an attribute by selecting from the available fields dropdown, then
there wont be any properties set by default.
But if you have copied an attribute from Generic Item template level and
pasted it to your object level, then it will have some default settings for
attribute properties.
Following are the properties need to be set for an attribute related to
dashboard grids:

Dashboards Editable If this property is checked, then the attribute will be

editable in web-connect dashboards.
Dashboards View Displayable This property must be checked to make the
attribute available while creation of dashboard in Smart Studio.
Dashboard totals Method If this property is checked, then this attribute
participates in grid total calculation otherwise not. If the value for this

31

attribute is set to 1, a normal sum will be applied to this attributes values

otherwise normal netting calculation will happen for the selected items in the
dashboard (in web connect).
Note: grid total calculation in we connect when we select few items then at
the bottom of the dashboard a row with sum of all the amount columns for
which this property is set will appear.

Following are the properties need to be set for an attributes display and input
ways in the dashboard:

Date & Time - This property is effective only for those attributes which are
mapped to date field. If this property is checked it displays date along with the
timestamp in the dashboard grid for this attribute.
Exclude from comparison If this property is checked, it excludes the
attribute from compare controls.
E.g. In PB OTC Derivative rec, we have a compare item dashboard which is built
on a compare control url, hence any attribute for which we check this property
wont appear on this dashboard.
Number of decimal places required - It sets the number of decimal places
which will be displayed for this attribute in the dashboard grid. Also, user will
be able to enter only mentioned number of digits after the decimal in the
search prompt while making a search based on this attribute.
Target Currency - Currency to display the linked attribute amount. Value
should be the base currency defined in the database.
Uppercase - It this checkbox is checked, the value of the attribute will be
displayed in uppercase in the dashboard grid. Also, while making a search for
this attribute whatever text user enters will automatically be converted to
uppercase and searched for the same even if the caps key is not on.

32

Following are the properties which governs the availability of an attribute in

different events in Recon Admin:

Events Create Case Available - If this property is checked the attribute will
be available in Create Case event.
Events Create Data NOT Available - If this property is checked the attribute
will not be available in Create Data event.
So make sure this property should not be checked if you are going to use this
attribute in Create Data event.
Events Edit Available - If this property is checked the attribute will be
available in Edit events.
Events Resolve Case Available - If this property is checked the attribute
will be available in Resolve Case event.
Events Stop/Abort Available - If this property is checked the attribute will
be available in Stop/Abort event.
Events Warn Available - If this property is checked the attribute will be
available in Warn event.
The below properties are set when business requires message maintenance and
manual input functionality through dashboards:

33

Closing balance for GMI header - Applicable to decimal types of columns i.e.
amount fields. Provides GMI with the closing balance amount attribute for on
screen balance calculations while entering data in GMI.
Generic Manual Input Displayable If checked, attribute will be visible in
GMI control.
Generic Manual Input Editable - If checked, attribute will be editable in GMI
control.
Generic Message Maintenance Displayable- If checked, attribute will be
visible in GMM dashboard.
Generic Message Maintenance Editable- If checked, attribute will be
editable in GMM dashboard.
Mandatory If checked, attribute (field) will be marked as mandatory in GMI
and GMM controls.
Netting field for GMI balance If checked, this attribute will contribute to the
on screen balance calculation in GMI.
Opening balance for GMI header - Applicable to decimal types of columns i.e.
amount fields. Provides GMI with the opening balance amount attribute for on
screen balance calculations while entering data in GMI.

34

Under Miscellaneous category we have a property called Optional Audit This

property is applicable to those attributes which are used in edit events and
dont want to be traced through Audit trail (a web connect utility which
displays a log of events happening on the selected item in a dashboard).
So if this property is checked for an attribute, that attribute wont show up in
Audit trail for any edit event.

Below properties govern availability of an attribute in passes in Recon Admin:

Passes populations Available If checked, attribute will be available to be

selected in population rows of pass.
Passes Initiation Pass Sequence - If checked, attribute will be present for
pass initiation sequence.
Passes reference masks Available - If checked, attribute will be present for
reference masking i.e. it will be listed in the available mask attributes list.

Below properties govern the availability of an attribute in Rules creation in

Smart Studio and Recon Admin:

35

Passes Rule (Aggregate Quality) Available If checked, attribute will be

available at the particular level for aggregate quality rule creation in Recon
Admin.
Passes Rule (Match Quality) Available If checked, attribute will be
available at the particular level for pass quality rule creation in Recon Admin.
Passes Rule (Population) Available If checked, attribute will be available
at the particular level for population rule creation in Recon Admin.
Passes Rule (Scope) Available If checked, attribute will be available at the
particular level for scope rule creation in Recon Admin.
Rules Access Available - If checked, attribute will be available at the
particular level for access rule creation in Smart Studio.
Rules Group Right hand Side - Available - If checked, attribute will be
available at the particular level for a rule creation works on a group of items.
Rules Search Available - If checked, attribute will be available at the
particular level for search rule creation in Smart Studio.
Rules Search Right hand Side - Available - If checked, attribute will be
available for right hand side of search rule creation in Smart Studio.
Rules Workflow Available - If checked, attribute will be available at the
particular level for workflow rule creation in Recon Admin.
Rules (Constraints) Available - If checked, attribute will be available at the
particular level for constraint rule creation in Smart Studio.

36

7.

Universe Creation

Sometimes we create views joining existing tables in database and write

backend scripts to populate these views based on business requirements.
To make the data of this view available for front-end user, it is required to
build a dashboard. To make a dashboard we need to select a particular universe
and then the level.
In that case, we create a new universe using our customized views or joining
existing tables in the desired way.
To create a new universe use this icon
Universe Selector tab as shown below:

placed in the toolbar just below the

When we select this button below prompt appears on the interface screen as
shown below:

37

Provide a name for your new universe.

Select suitable product type, this is just to categorize the universes
based n the product type.
Then you must select a base entity. It can either be your own view or
an existing table which you want to use as the base entity in your
join strategy.
Once you click ok here, you will be directly moved to the Entity and
Join page of your new universe.
If it is only one view, it will display the available attributes. You can
join more entities if required.

38

7. a. To Edit Entity and Join

To add a new entity select an entity from the available entities list and use add
entity

button as shown below:

A rectangular box will appear in the blank space where already your
base entity is present. If you click on the entity you will be able to
define its alias as shown below:

This alias is useful while defining the join properties. If you want you
can delete an entity using

button visible in the above picture.

39

But if the entity is joined with some other entity, it cant be deleted.
First you have to delete the join by right clicking on the join line and
select option Delete Join as shown below. Once the entity is free of
all joins then that entity can be deleted. After all the entities are
deleted, universe can be deleted in turn.

Then to join this new entity with your base entity, click on the base
entity and start dragging you will see a line will appear drag it up to
the new entity.
Then click on the line appeared connecting both the entities and
select the mapping attribute in the Join Mappings pane situated just
above Available Entities pane as shown below:

40

Parent column is the attribute of the base entity and child column is
the attribute of the entity which is joined with the base entity. You
can delete the join mapping using the delete button
the above picture.

shown in

Mention the type of join in the Join Properties pane situated above
the Join Mapping pane as visible in the above picture.
If you want it to be an inner join select Only Matching Both option
under the Type section.
If you want an outer join, select from which table you want it to. As
shown above if it is All fromd will be an outer join selecting all
records from dcod table here d is the alias specified for this table.
Define whether the join has to be a mandatory or an optional one.
41

Then move to Objects and Attributes tab. Base table attributes will
be listed in the Attributes pane, accordingly the properties can be set
for each of the attribute.
7. b Delete Universe

To delete a Universe, all the entities have to be removed from Entities and
joins tab. Then use delete button
to delete the universe. Delete
universe button can be found on the toolbar situated just below the
Universe Selector tab as shown below:

42

8. Important Considerations:

Whenever we do any schema modification which affects Smart

Studio/Web Connect, we need to restart the web server in order to
see the changes in Smart Studio/ Web Connect.
But if we do only those changes which affect attributes availability in
Recon Admin, then need not restart the web server to see the
changes, instead logout and re-login to Recon Admin works.
After modifying Schema, do not forget to use lock button to lock the
schema.

*********************************************END***********************************************

43