IBM Incentive Compensation Management

Version 10.0.0

User Guide

IBM
 Note
Before using this information and the product it supports, read the information in “Notices” on page
333.

Product Information
This document applies to IBM Incentive Compensation Management Version 10.0.0 and may also apply to subsequent
releases.
Licensed Materials - Property of IBM
© Copyright International Business Machines Corporation 2005, 2018.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with
IBM Corp.
Contents

Introduction...................................................................................................... xvii

Chapter 1. What's new...........................................................................................1

Chapter 2. Overview of the IBM Incentive Compensation Management client.......... 3

Chapter 3. Getting started..................................................................................... 5

Models.......................................................................................................................................................... 5
Viewing the model summary..................................................................................................................5
Viewing upcoming model maintenance.................................................................................................5
Global action restrictions.............................................................................................................................5
Modules........................................................................................................................................................ 6
Home page................................................................................................................................................... 7
Adding items to your watch list..............................................................................................................7
Finding items from the Home page........................................................................................................7
Documentation and support........................................................................................................................ 7
Client Success portal.............................................................................................................................. 7
Accessing help........................................................................................................................................ 8
Video tutorials.........................................................................................................................................8
Request a feature................................................................................................................................... 8

Chapter 4. Process lists......................................................................................... 9

Viewing process lists....................................................................................................................................9
Adding process lists..................................................................................................................................... 9
Adding tasks to process lists..................................................................................................................... 10
Adding subtasks to process lists............................................................................................................... 11
Copying process lists................................................................................................................................. 11
Editing process lists................................................................................................................................... 12
Marking tasks as complete........................................................................................................................ 12

Chapter 5. Composer........................................................................................... 13
Composer object arrangement..................................................................................................................13
Composer object visibility......................................................................................................................... 13
Displaying specific object types only in Composer............................................................................. 14
View Composer object sources............................................................................................................14
View table or calculation data..............................................................................................................14
Sidebar....................................................................................................................................................... 14
Palette tab............................................................................................................................................14
Navigation tab......................................................................................................................................14
Viewing dependencies......................................................................................................................... 15
Exporting the Used By list.................................................................................................................... 15
Adding objects to the Favorites list......................................................................................................15
Overview window.......................................................................................................................................16
Multi-Edit and Single-Edit mode.............................................................................................................. 16
Exporting the Composer diagram..............................................................................................................17
Composer navigation................................................................................................................................. 17
Selecting objects and zooming in Composer.......................................................................................17

Chapter 6. Components....................................................................................... 19
Component organization........................................................................................................................... 19

iii
 Navigation between components..............................................................................................................19
Breadcrumbs........................................................................................................................................ 19
Viewing components............................................................................................................................ 19
Data flow between components................................................................................................................20
Data accessibility in components........................................................................................................ 20
Component activities................................................................................................................................. 20
Adding components............................................................................................................................. 20
Setting the color of components..........................................................................................................21
Renaming components........................................................................................................................ 21
Adding documents to components......................................................................................................21
Copying components............................................................................................................................22
Deleting components........................................................................................................................... 22
Wrap and unwrap components................................................................................................................. 22
Wrapping objects into components..................................................................................................... 22
Unwrapping components..................................................................................................................... 23
Connections............................................................................................................................................... 23
Connection names................................................................................................................................24
Adding connections..............................................................................................................................24
Renaming connections.........................................................................................................................24
Editing connections.............................................................................................................................. 25
Editing connection mapping.................................................................................................................25
Replacing a connection with a global table......................................................................................... 26
Deleting connections............................................................................................................................26
Viewing current values in a connection............................................................................................... 27
Viewing the flow of data through connections.................................................................................... 27

Chapter 7. Tables.................................................................................................29
Table types................................................................................................................................................. 29
System tables....................................................................................................................................... 29
Hierarchy tables................................................................................................................................... 30
Data tables............................................................................................................................................31
Structural tables................................................................................................................................... 31
Custom tables.......................................................................................................................................31
View tables........................................................................................................................................... 32
Table structure........................................................................................................................................... 33
Table column types.............................................................................................................................. 33
Table columns between components..................................................................................................33
Primary keys......................................................................................................................................... 33
Table creation............................................................................................................................................ 34
Adding tables........................................................................................................................................34
Defining pick list field types................................................................................................................. 34
Adding Data tables............................................................................................................................... 35
Adding View tables...............................................................................................................................35
Defining global tables...........................................................................................................................36
Globalizing and replacing connections................................................................................................ 36
Viewing and editing table structure..................................................................................................... 36
Editing View tables............................................................................................................................... 37
Deleting tables......................................................................................................................................37
Copying tables...................................................................................................................................... 37
Viewing table dependencies................................................................................................................ 37
Table data edits..........................................................................................................................................38
Adding table data................................................................................................................................. 38
Editing table data................................................................................................................................. 39
Changing the default edit date for a table........................................................................................... 39
Editing multiple rows in tables.............................................................................................................39
Copying multiple rows in tables...........................................................................................................39
Deleting multiple rows in a table......................................................................................................... 40

iv
 Turning off the warning message when deleting rows in tables that are pick listed by other
tables............................................................................................................................................... 40
Purging table and calculation data...................................................................................................... 40
Clearing tables......................................................................................................................................41
Displaying a description field in tables................................................................................................ 41
Navigating between tables...................................................................................................................42
Filtering table data............................................................................................................................... 42
Finding and replacing data in a table...................................................................................................43
Managing saved transformations.........................................................................................................43
Table data export....................................................................................................................................... 44
Exporting table data to a .csv file.........................................................................................................44
Copying table data to the clipboard.....................................................................................................44
Effective dates in tables............................................................................................................................ 44
Adding tables with effective dates.......................................................................................................45
Converting tables to effective dated tables.........................................................................................45
Viewing data in tables with effective dates......................................................................................... 46
Viewing multiple versions of data in tables with effective dates........................................................46
Adding versions of records to tables with effective dates.................................................................. 47
Adding end dates to records in tables with effective dates................................................................ 47
Deleting multiple versions of records in tables with effective dates..................................................48
Table history...............................................................................................................................................48
Disabling table history collection.........................................................................................................48
Disabling table history collection for all future tables........................................................................ 49
Purging history for multiple tables.......................................................................................................49
Purging history for a single table......................................................................................................... 49
Web data.................................................................................................................................................... 49
Defining accessible information for the web client............................................................................. 50
Restricting visible rows for tables on the web client...........................................................................50
Enabling direct editing on the web client............................................................................................ 51
Approving web data edits.....................................................................................................................51

Chapter 8. Input forms........................................................................................ 53

Adding input forms.................................................................................................................................... 53
Viewing input forms................................................................................................................................... 53
Input form security.................................................................................................................................... 54
Assigning users to the input form role.................................................................................................54
Adding input form validation rules.......................................................................................................54
Submission change through an input form............................................................................................... 55
Adding new rows to input forms.......................................................................................................... 55
Importing data into input forms...........................................................................................................55
Editing rows in input forms.................................................................................................................. 56

Chapter 9. Data imports.......................................................................................57

Data import types...................................................................................................................................... 57
Importing data from text files.............................................................................................................. 57
Importing data from Microsoft Excel files........................................................................................... 58
Importing data from XML files............................................................................................................. 59
Importing data from database files..................................................................................................... 60
Importing data from Salesforce.com...................................................................................................61
Adding sub-items................................................................................................................................. 61
Merging fields....................................................................................................................................... 63
Changing the import escape character................................................................................................64
Effective date table imports...................................................................................................................... 64
Importing files containing replacement characters................................................................................. 64
Track import progress in the Activity module........................................................................................... 65
Refreshing table data.................................................................................................................................65
Data from IBM Cognos Territory and Quota Management....................................................................... 65

v
 Adding IBM Cognos Territory and Quota Management objects..........................................................65
IBM Cognos Territory and Quota Management data synchronization................................................ 66
Data from IBM Producer Lifecycle and Credential Management............................................................. 67
Adding IBM Producer Lifecycle and Credential Management objects................................................67
IBM Producer Lifecycle and Credential Management data synchronization......................................67
Managing saved imports............................................................................................................................68

Chapter 10. Calculation creation.......................................................................... 69

Calculation types....................................................................................................................................... 69
Adding user-defined calculations........................................................................................................ 69
Adding sort calculations.......................................................................................................................70
Adding time shift calculations..............................................................................................................71
Adding a category calculation..............................................................................................................71
Creating a calculation with a left outer join......................................................................................... 73
Calculation results export..........................................................................................................................74
Exporting calculation results to a .csv file........................................................................................... 74
Copying calculation results to the clipboard....................................................................................... 74
Working with calculations..........................................................................................................................74
Editing calculations.............................................................................................................................. 74
Refreshing calculation data................................................................................................................. 75
Copying calculations............................................................................................................................ 75
Previewing calculations........................................................................................................................76
Running calculations from Composer..................................................................................................76
Viewing current calculation values...................................................................................................... 76
Filtering calculation data......................................................................................................................76
Purging calculation data.......................................................................................................................77
Viewing calculation history.................................................................................................................. 77
Viewing sources that use the calculation............................................................................................ 77
Viewing sources that the calculation uses.......................................................................................... 78
Locked calculations..............................................................................................................................78

Chapter 11. Data sources..................................................................................... 79

Adding a data source................................................................................................................................. 79
Replacing a data source with another source........................................................................................... 80
Multiple sources.........................................................................................................................................80
Add sources by columns...................................................................................................................... 80
Renaming a joined source.................................................................................................................... 84
Moving data sources.............................................................................................................................84
Anchor feature......................................................................................................................................84
Add sources by rows............................................................................................................................ 85
Data sources preview.................................................................................................................................87

Chapter 12. Restrictions...................................................................................... 89

Defining restrictions for joined sources.................................................................................................... 89
Disabling automatic joins in calculations.................................................................................................. 90
Defining global restrictions........................................................................................................................91
Multiple restrictions that use AND or OR groups...................................................................................... 91
Adding AND or OR groups in restrictions.............................................................................................91
Moving sources for restrictions................................................................................................................. 92
Deleting restrictions...................................................................................................................................92

Chapter 13. Display columns................................................................................93

Defining display columns...........................................................................................................................94
Empty partitions.........................................................................................................................................94
Including empty partitions...................................................................................................................95
Accumulating partitions.............................................................................................................................96
Adding accumulating partitions........................................................................................................... 96

vi
Chapter 14. Formulas.......................................................................................... 97
Formula functions...................................................................................................................................... 97
Creating formulas in calculations............................................................................................................101
Formatting formulas................................................................................................................................ 102

Chapter 15. Calculate........................................................................................ 103

Calculating results................................................................................................................................... 103
Canceling a calculation that is in progress..............................................................................................103
Viewing calculation details......................................................................................................................104
Calculation performance......................................................................................................................... 104
Using incremental calculation to increase calculation speed.......................................................... 104
Enforcing single row formulas........................................................................................................... 104
Enabling Data Tier Performance Optimization.................................................................................. 105
Troubleshooting calculations.................................................................................................................. 105

Chapter 16. Data stores..................................................................................... 107

Adding data stores...................................................................................................................................107
Data store export..................................................................................................................................... 108
Exporting data store rows to a .csv file..............................................................................................108
Copying data store rows to the clipboard..........................................................................................108
Data stores and IBM Watson Analytics...................................................................................................108
IBM Watson Analytics registration.................................................................................................... 109
Connecting to Watson Analytics........................................................................................................ 110
Exporting data from data stores to Watson Analytics.......................................................................110
Using Postman for development and testing.................................................................................... 111
Troubleshooting the Watson Analytics connection...........................................................................111

Chapter 17. Presenter report data components.................................................. 113

How the pieces fit together..................................................................................................................... 113
Presenter naming conventions................................................................................................................114
Presenter report creation........................................................................................................................ 114
Adding Presenter reports...................................................................................................................114
Renaming Presenter reports..............................................................................................................114
Presenter parameters..............................................................................................................................115
Adding parameters.............................................................................................................................115
Report parameter links...................................................................................................................... 116
Presenter report link with parameters example............................................................................... 116
Presenter values...................................................................................................................................... 117
Adding stored values..........................................................................................................................117
Adding calculated values................................................................................................................... 118
Adding constant values......................................................................................................................118
Presenter report sources.........................................................................................................................118
Available data sources for Presenter sources................................................................................... 119
Adding data sources...........................................................................................................................119
Transformations................................................................................................................................. 120
Row form sources.................................................................................................................................... 122
Adding row form sources................................................................................................................... 123

Chapter 18. Presenter report layout and display options..................................... 125

Layout tables............................................................................................................................................125
Adding layout tables.......................................................................................................................... 125
Deleting layout tables........................................................................................................................ 126
Swapping two components in layout tables......................................................................................126
Deleting layout table contents...........................................................................................................126
Editing layout tables...........................................................................................................................126
Resizing cells in layout tables............................................................................................................ 127

vii
 Format Presenter components............................................................................................................... 127
Editing the font for components in layout tables.............................................................................. 127
Editing the alignment for components in layout tables.................................................................... 127
Editing the border for components in layout tables..........................................................................127
Editing the padding for components in layout tables....................................................................... 127
Presenter component links..................................................................................................................... 128
Linking a Presenter component to another Presenter report........................................................... 128
Linking a Presenter component to a web form................................................................................. 128
Linking a Presenter component to a web page................................................................................. 129
Basic Presenter components.................................................................................................................. 129
Adding text......................................................................................................................................... 129
Setting the default font...................................................................................................................... 129
Adding links to documents................................................................................................................ 130
Adding images....................................................................................................................................130
Presenter data components.................................................................................................................... 130
Adding text value displays................................................................................................................. 130
Adding numeric value displays.......................................................................................................... 131
Adding date value displays................................................................................................................ 132
Adding data grids............................................................................................................................... 132
Adding a data grid with an input row form........................................................................................ 133
Adding fixed grids...............................................................................................................................134
Adding a workflow dashboard........................................................................................................... 135
Data grid display options......................................................................................................................... 135
Expanding a data grid.........................................................................................................................135
Selecting columns in data grids.........................................................................................................136
Adding computed columns to data grids...........................................................................................136
Adding computed rows to data grids.................................................................................................137
Setting the sort order for data grids.................................................................................................. 138
Adding section breaks to data grids.................................................................................................. 138
Adding editable columns to data grids..............................................................................................139
Adding validation rules for editable data grid columns.................................................................... 140
Formatting data grid rows..................................................................................................................141
Setting alternating row fonts in data grids........................................................................................ 142
Showing grid lines.............................................................................................................................. 142
Reordering data grid columns............................................................................................................142
Showing or hiding data grid columns................................................................................................ 143
Hiding data grid headers....................................................................................................................144
Freezing the data grid header row..................................................................................................... 144
Enabling data grid row copy into inquiries........................................................................................ 145
Adding pagination to data grids......................................................................................................... 145
Renaming a data grid column............................................................................................................ 145
Resetting the name of a data grid column.........................................................................................146
Setting the width of a column............................................................................................................ 146
Formatting data grid columns............................................................................................................147
Setting conditional formatting........................................................................................................... 147
Enabling text wrapping and alignment in columns........................................................................... 148
Showing the date and time in data grid columns.............................................................................. 148
Null numeric values in data grids...................................................................................................... 149
Data grid templates................................................................................................................................. 150
Adding data grid templates................................................................................................................150
Editing data grid templates................................................................................................................151
Applying templates to data grids.......................................................................................................151
Presenter chart components...................................................................................................................151
Adding single series charts................................................................................................................ 151
Adding charts with no axes................................................................................................................ 153
Adding multi series charts................................................................................................................. 154
Adding gauges.................................................................................................................................... 156
Presenter control components................................................................................................................158

viii
 Adding submit buttons.......................................................................................................................158
Adding a pick list control....................................................................................................................158
Adding signature controls.................................................................................................................. 159
Adding text controls........................................................................................................................... 159
Preview Presenter reports.......................................................................................................................160
Previewing a Presenter report........................................................................................................... 160

Chapter 19. Web forms...................................................................................... 161

Adding a web form...................................................................................................................................161
Web form filters....................................................................................................................................... 161
Defining simple filters........................................................................................................................ 161
Defining Portal Access filters............................................................................................................. 162
Defining custom filters....................................................................................................................... 163
Web form sources....................................................................................................................................163
Adding sources to web forms............................................................................................................ 163
Adding validation rules to editable web form columns.................................................................... 164
Adding a saved web form filter.......................................................................................................... 164
Web form row forms................................................................................................................................ 164
Adding row forms............................................................................................................................... 164
Adding admin form columns................................................................................................................... 165
Adding JavaScript.................................................................................................................................... 165
Adding web resources............................................................................................................................. 165
Web form format......................................................................................................................................166
Setting the cell span...........................................................................................................................166
Formatting web forms........................................................................................................................166
Copying and pasting web form cells.................................................................................................. 166
Web form options.................................................................................................................................... 166
Setting web form options...................................................................................................................166
Setting web form preferences........................................................................................................... 167

Chapter 20. Publisher........................................................................................ 169

Defining the export tagline...................................................................................................................... 169
Managing saved publications.................................................................................................................. 169
Email publications................................................................................................................................... 169
Publishing tables..................................................................................................................................... 170
Publishing tables to Microsoft Excel..................................................................................................170
Publishing tables to PDF files............................................................................................................ 170
Publishing tables to text files.............................................................................................................171
Publishing tables to Salesforce.com..................................................................................................172
Publishing calculations............................................................................................................................173
Publishing calculations to Microsoft Excel files................................................................................ 173
Publishing calculations to PDF files...................................................................................................173
Publishing calculations to text files................................................................................................... 174
Publishing calculations to Salesforce.com........................................................................................175
Publishing Presenter reports...................................................................................................................175
Selecting publishing preferences...................................................................................................... 175
Publishing Presenter reports............................................................................................................. 176
Publishing web forms.............................................................................................................................. 177

Chapter 21. Activity tab..................................................................................... 179

Filtering activities.................................................................................................................................... 179
Canceling running activities.................................................................................................................... 179
Viewing failed activity details.................................................................................................................. 179

Chapter 22. Pulse.............................................................................................. 181

Pulse reporting hierarchy........................................................................................................................ 181
Plans.........................................................................................................................................................181

ix
 Adding plans.......................................................................................................................................181
Setting the calendar for Pulse plans..................................................................................................182
Setting the Pulse reports pay schedule.............................................................................................182
Editing plans....................................................................................................................................... 183
Viewing plan overview........................................................................................................................183
Pulse reports............................................................................................................................................183
Pulse report data sources.................................................................................................................. 183
Creating Pulse plan admin reports.................................................................................................... 188
Creating a Pulse Transaction Report................................................................................................. 188
Creating a Pulse Earnings Report...................................................................................................... 189
Creating a Pulse Team Performance Report..................................................................................... 190
Creating a Pulse Team Rankings Report............................................................................................190
Pulse report access................................................................................................................................. 191

Chapter 23. Workflow Manager.......................................................................... 193

Workflows................................................................................................................................................ 193
Adding a workflow..............................................................................................................................194
Editing a workflow..............................................................................................................................195
Deleting a workflow........................................................................................................................... 195
Copying a workflow............................................................................................................................ 196
Setting default parameters for a workflow........................................................................................196
Starting a workflow............................................................................................................................ 196
Adding payees after a workflow is started........................................................................................ 197
Organizing workflows.........................................................................................................................197
Searching for a workflow................................................................................................................... 197
Swim lanes...............................................................................................................................................197
Editing the Form Initiator swim lane................................................................................................. 198
Adding a swim lane............................................................................................................................ 198
Deleting a swim lane.......................................................................................................................... 199
Adding and removing columns in swim lanes................................................................................... 199
Nodes....................................................................................................................................................... 199
Editing the Start node........................................................................................................................ 200
Adding alert nodes............................................................................................................................. 200
Adding action nodes...........................................................................................................................201
Adding process nodes........................................................................................................................202
Adding conditional nodes.................................................................................................................. 203
Editing nodes......................................................................................................................................203
Cutting, copying, and pasting nodes..................................................................................................203
Connecting nodes...............................................................................................................................204
Deleting connections......................................................................................................................... 205
Workflow value submission in pending state......................................................................................... 205
Enabling pending workflows..............................................................................................................205
Workflow errors and reports................................................................................................................... 205
Viewing workflow errors.................................................................................................................... 206
Resolving node errors........................................................................................................................ 206
Viewing workflow events in the Audit log..........................................................................................206
Viewing workflow events in Workflow Manager................................................................................206
Viewing pending actions.................................................................................................................... 207
Filtering workflow errors, pending actions, or history...................................................................... 207
Exporting errors, pending actions, or history to Microsoft Excel...................................................... 208
Clearing history.................................................................................................................................. 208
Workflow Manager in the web client.......................................................................................................208

Chapter 24. Portal Access.................................................................................. 209

Web tabs.................................................................................................................................................. 209
Adding web tabs.................................................................................................................................209
Editing web tabs.................................................................................................................................210

x
 Deleting web tabs...............................................................................................................................210
Moving web tabs................................................................................................................................ 210
Adding web tab groups...................................................................................................................... 210
Setting access to web tabs................................................................................................................ 210
Portal Access groups............................................................................................................................... 211
Adding Portal Access groups............................................................................................................. 211
Managing web access........................................................................................................................ 212
Forcing web users to change passwords on next login.....................................................................213
Portal Access trees.................................................................................................................................. 213
Creating Portal Access trees..............................................................................................................214
Using the Portal Access tree builder................................................................................................. 214
Defining hierarchies for sign off......................................................................................................... 215
Adding web adjustments................................................................................................................... 216
Assignments............................................................................................................................................ 216
Assigning tree access.........................................................................................................................217
Validating tree assignments...............................................................................................................217
Notifying access tree about available documents............................................................................ 217
Sign off..................................................................................................................................................... 217
Starting a sign off............................................................................................................................... 218
Ending the sign off process................................................................................................................218
Sending email notification about the sign off process to pending payees....................................... 218
Sending email notification about the sign off process to all members of one group.......................218
Setting automatic notifications to users when a sign off is pending................................................ 219
Forcing sign off approval.................................................................................................................... 219
Viewing sign off status for group members.......................................................................................219
Inquiry process........................................................................................................................................ 220
Disabling inquiries..............................................................................................................................220
Enabling inquiries...............................................................................................................................220
Sending email notifications about inquiries to pending payees....................................................... 220
Sending email notifications about inquiries to all members of one group....................................... 221
Setting automatic notifications to users when an inquiry is pending...............................................221
Viewing inquiry assigned to a group.................................................................................................. 221
Viewing inquiries made by a group....................................................................................................221
Viewing inquiries assigned to the administrator............................................................................... 222
Adding inquiry categories.................................................................................................................. 222
Web client theme.....................................................................................................................................222
Changing the theme to Salesforce.com.............................................................................................222
Adding a custom logo.........................................................................................................................223
Disabling the web client Message Center icon..................................................................................223

Chapter 25. Scheduler....................................................................................... 225

Scheduler properties............................................................................................................................... 225
Setting global Scheduler properties.................................................................................................. 225
Setting process-level properties........................................................................................................226
Scheduler process................................................................................................................................... 226
Adding processes............................................................................................................................... 227
Adding a subfolder............................................................................................................................. 227
Copying and pasting processes......................................................................................................... 227
Disabling tasks and processes...........................................................................................................228
Scheduler tasks....................................................................................................................................... 228
Adding tasks....................................................................................................................................... 230
Viewing the tables and date ranges for a scheduled history purge..................................................230
Scheduled items...................................................................................................................................... 231
Running an item................................................................................................................................. 231
Scheduler timing................................................................................................................................ 231
Scheduler time conflicts.................................................................................................................... 231
Scheduler error notification.................................................................................................................... 231

xi
 Accessing the Scheduler log.............................................................................................................. 232

Chapter 26. PGP Encryption............................................................................... 233

Scheduling PGP encryption and decryption........................................................................................... 233
PGP encryption automation.................................................................................................................... 233

Chapter 27. Task Manager..................................................................................235

Task Manager groups...............................................................................................................................235
Adding Task Manager groups.............................................................................................................235
Organizing Task Manager groups....................................................................................................... 236
Task Manager rules..................................................................................................................................236
Adding Task Manager rules................................................................................................................ 237
Organizing Task Manager rules.......................................................................................................... 237
Generate and administer tasks............................................................................................................... 237
Generating a task list......................................................................................................................... 237
Running a task.................................................................................................................................... 238
Deleting a task....................................................................................................................................238
Deferring a task.................................................................................................................................. 238
Canceling a deferral........................................................................................................................... 238
Adding email notifications for tasks.................................................................................................. 239
Alert options for tasks............................................................................................................................. 239
Activating a payee alert......................................................................................................................239
Disabling a payee alert.......................................................................................................................239

Chapter 28. Scenarios........................................................................................241

Workspaces..............................................................................................................................................242
Adding workspaces............................................................................................................................ 242
Editing workspaces............................................................................................................................ 242
Deleting workspaces.......................................................................................................................... 242
Calculating workspaces..................................................................................................................... 243
Workspace scenarios...............................................................................................................................243
Adding scenarios................................................................................................................................ 243
Adding items to scenarios..................................................................................................................243
Moving items to another scenario..................................................................................................... 244
Scenario change sets...............................................................................................................................244
Adding overwrite change sets............................................................................................................244
Adding transform change sets........................................................................................................... 245
Reordering change sets..................................................................................................................... 245
Editing change sets............................................................................................................................ 246
Scenario results....................................................................................................................................... 246
Previewing transform change set results.......................................................................................... 246
Generating scenario reports.............................................................................................................. 246
Promoting scenarios.......................................................................................................................... 247

Chapter 29. Logs................................................................................................249

Audit log................................................................................................................................................... 249
Audit log functionality........................................................................................................................ 249
Filtering Audit log results................................................................................................................... 250
Viewing details of table edits.............................................................................................................251
Exporting the Audit log.......................................................................................................................251
Setting Audit log options....................................................................................................................251
Computation log...................................................................................................................................... 251
Disabling the generation of a Computation log................................................................................. 252
Viewing Computation log details....................................................................................................... 252
Error logs..................................................................................................................................................252
Viewing the export error log...............................................................................................................252
Viewing import exceptions log...........................................................................................................253

xii
 Viewing the Scheduler error log.........................................................................................................253
Viewing the task error log.................................................................................................................. 253
Signature log............................................................................................................................................ 254
Viewing the Signature Control log..................................................................................................... 254
Performance log.......................................................................................................................................254
Viewing the calculation performance log.......................................................................................... 254
Comparing computations...................................................................................................................254
Tenant log................................................................................................................................................ 255
Viewing the tenant log....................................................................................................................... 255
Exporting the tenant log.....................................................................................................................255

Chapter 30. Security.......................................................................................... 257

Roles........................................................................................................................................................ 257
Adding roles....................................................................................................................................... 257
Deleting roles..................................................................................................................................... 258
Copying roles......................................................................................................................................258
Exporting roles................................................................................................................................... 258
Role permissions..................................................................................................................................... 258
Access permissions............................................................................................................................258
Process list security........................................................................................................................... 267
Composer security............................................................................................................................. 268
Component security........................................................................................................................... 269
Table security..................................................................................................................................... 270
Import data security.......................................................................................................................... 272
Input form security............................................................................................................................ 274
Data store security............................................................................................................................. 276
Scenarios security.............................................................................................................................. 277
Web form security.............................................................................................................................. 278
Presenter report security................................................................................................................... 278
Pulse security..................................................................................................................................... 279
Portal Access security........................................................................................................................279
Scheduler security............................................................................................................................. 280
Setting Task Manager security........................................................................................................... 281
Audit module security........................................................................................................................ 281
Workflow Manager security............................................................................................................... 282
Setting calculate security...................................................................................................................283
Administration security......................................................................................................................283
Tools security..................................................................................................................................... 286
User security............................................................................................................................................ 288
Adding users.......................................................................................................................................288
Concurrent users................................................................................................................................288
Role segregation example................................................................................................................. 290
Changing users' passwords............................................................................................................... 291
Setting web user login security options............................................................................................ 291
Setting email address for Request Assistance link on the web client.............................................. 292
Setting the base URL for the web client............................................................................................ 292
Forcing web users to change passwords on first login..................................................................... 292
Publishing a users and permissions report....................................................................................... 293

Chapter 31. Tools...............................................................................................295

Optimizing a model..................................................................................................................................295
Calendars................................................................................................................................................. 295
Adding calendars................................................................................................................................296
Editing calendars................................................................................................................................296
Multiple calendars..............................................................................................................................296
Period locking.......................................................................................................................................... 297
Period accuracy.................................................................................................................................. 297

xiii
 How period locking works..................................................................................................................297
Locking a period................................................................................................................................. 298
Unlocking a period............................................................................................................................. 298
Adding periods to a locked calendar................................................................................................. 299
Period locking and system functions.................................................................................................299
Period locking and calendar changes................................................................................................ 300
Payee groups........................................................................................................................................... 300
Adding payee groups..........................................................................................................................300
Deleting a payee from a payee group................................................................................................ 301
Editing effective dates for individual payee group members........................................................... 301
Star schemas........................................................................................................................................... 301
Adding a star schema.........................................................................................................................302

Chapter 32. Admin client management...............................................................303

Managing documents.............................................................................................................................. 303
Downloads............................................................................................................................................... 303
Downloading saved imports.............................................................................................................. 303
Downloading saved publications....................................................................................................... 303
Deleting downloads........................................................................................................................... 304
Web messages......................................................................................................................................... 304
Adding web messages....................................................................................................................... 304
Editing web messages........................................................................................................................304
Deleting web messages..................................................................................................................... 304
Sending notifications to all web users...............................................................................................304
External tools........................................................................................................................................... 305
Adding external tools......................................................................................................................... 305
External tools and Python scripts........................................................................................................... 305
Uploading standard Python scripts using the admin web application............................................. 305
Uploading standard Python scripts using FTP.................................................................................. 305
Running Python scripts from Scheduler............................................................................................ 306
Troubleshooting Python scripts run...................................................................................................306
Python script development................................................................................................................306

Chapter 33. Migration........................................................................................ 311

General practice and rules for migration................................................................................................ 311
Rules for migrating Composer........................................................................................................... 312
Rules for migrating components........................................................................................................312
Rules for migrating tables with pick lists...........................................................................................312
Rules for migrating global tables....................................................................................................... 313
Rules for migrating web forms and Presenter reports......................................................................313
Rules for migrating web form filters.................................................................................................. 313
Rules for migrating Portal Access items............................................................................................313
Rules for migrating process lists........................................................................................................314
Rules for migrating Workflow Manager workflows........................................................................... 315
Objects that cannot be migrated....................................................................................................... 315
Performing a migration............................................................................................................................ 316
Filtering and sorting columns in the Migration wizard............................................................................317
Migrating individual Composer objects...................................................................................................317
Migration methodology and approach.................................................................................................... 318
Planning phase................................................................................................................................... 318
Migration phase..................................................................................................................................320
Validation phase.................................................................................................................................321
Configuration-only models...................................................................................................................... 321
Pros and cons of configuration-only models.....................................................................................322
Keys for success.................................................................................................................................322
Change management...............................................................................................................................322

xiv
Chapter 34. Command Line Tool......................................................................... 325
Command Line Tool security................................................................................................................... 325
Using the command-line interface to connect to a model .................................................................... 325
Command-line interface commands.......................................................................................................326
Return code from the command-line interface...................................................................................... 327
Using the CLI tool to upload import files................................................................................................ 327
Using the CLI tool to overwrite saved imports........................................................................................328
Using the CLI tool to download saved publications............................................................................... 328

Appendix A. Accessibility features..................................................................... 331

Keyboard shortcuts................................................................................................................................. 331
IBM and accessibility...............................................................................................................................332

Notices..............................................................................................................333
Glossary............................................................................................................ 335
A............................................................................................................................................................... 335
C............................................................................................................................................................... 335
D............................................................................................................................................................... 336
F................................................................................................................................................................336
I................................................................................................................................................................ 336
J................................................................................................................................................................336
L................................................................................................................................................................336
M...............................................................................................................................................................337
O............................................................................................................................................................... 337
P............................................................................................................................................................... 337
Q............................................................................................................................................................... 337
R............................................................................................................................................................... 338
S............................................................................................................................................................... 338
V............................................................................................................................................................... 338
W.............................................................................................................................................................. 338
Index................................................................................................................ 339

xv
xvi
Introduction
®
The IBM Incentive Compensation Management User Guide describes how to use IBM Incentive
Compensation Management to calculate and create compensation plans.
Incentive Compensation Management enables organizations to automate the process of administering,
calculating, reporting, and analyzing variable-based pay programs. The solution simplifies incentive
compensation management for organizations by increasing accuracy, reducing costs, and improving
visibility into sales performance and compensation plans.

Audience
The IBM Incentive Compensation Management User Guide is intended for administrators who work in the
Incentive Compensation Management client.

Finding information
To find documentation on the web, including all translated documentation, access IBM® Knowledge
Center (http://www.ibm.com/support/knowledgecenter).

Publication date
This document was published on 2018-01-31.

Accessibility features
Accessibility features help users who have a physical disability, such as restricted mobility or limited
vision, to use information technology products. IBM Cognos® HTML documentation has accessibility
features. PDF documents are supplemental and, as such, include no added accessibility features. For
information about these features, see Appendix A, “Accessibility features,” on page 331.

Forward-looking statements
This documentation describes the current functionality of the product. References to items that are not
currently available may be included. No implication of any future availability should be inferred. Any such
references are not a commitment, promise, or legal obligation to deliver any material, code, or
functionality. The development, release, and timing of features or functionality remain at the sole
discretion of IBM.

© Copyright IBM Corp. 2005, 2018 xvii

xviii IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 1. What's new
The What's new section contains a list of new, changed, and deprecated installation and configuration
features for this release. It also contains a cumulative list of similar information for previous releases. You
can use this section to plan your upgrade and application deployment strategies and the training
requirements for your users.
For information about upgrading, see the installation and configuration guide for your product. To review
an up-to-date list of environments that are supported by IBM products, including information on
operating systems, patches, browsers, web servers, directory servers, database servers, and application
servers, go to IBM Knowledge Center (http://www.ibm.com/support/knowledgecenter).
New features in version 10.0.0
Click the link above to view the features that are new in Incentive Compensation Management version
10.0.0.

© Copyright IBM Corp. 2005, 2018 1

2 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 2. Overview of the IBM Incentive
Compensation Management client
®
In the IBM Incentive Compensation Management, you can manage payment for individuals who receive
variable compensation, including the sales force, management, or distribution channels.
Incentive Compensation Management enables organizations to design, manage, and automate the
calculation of variable payment for dozens of plans and thousands of employees simultaneously. From the
client, administrators can add models, customize tables, import data, add calculations, and report on
results.

© Copyright IBM Corp. 2005, 2018 3

4 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 3. Getting started
®
Before you start working in the IBM Incentive Compensation Management admin client there is some
basic information that you should be aware of.
Important: Your login remains active for 60 minutes after your last action in any tab or window of the
application that you have open.
Here's a quick demonstration to help you get started with navigating in the admin client:

https://youtu.be/3KKTBE2JDwA

Models
®
In IBM Incentive Compensation Management, models are the space in which you will create
compensation programs and maintain compensation processes over time.

Viewing the model summary

®
The IBM Incentive Compensation Management model summary provides basic model statistics.

About this task

These statistics include the size of the model as well as the number of calculations that exceed 20
minutes.
When viewing the model size, if the size is less than 10 GB the size is displayed as green, if the size is
between 10 GB to 99 GB, it is displayed as orange, if it is greater than 99 GB it is displayed as red.

Procedure
Click Admin > Model Summary.

Viewing upcoming model maintenance

®
You can view the model maintenance details for IBM Incentive Compensation Management that is
scheduled over the next seven days.

Procedure
1. Next to the model name in the application header, click the drop-down arrow.
2. Click Upcoming Maintenances.

Global action restrictions

®
To protect the integrity of the model, users cannot complete certain model edits in IBM Incentive
Compensation Management while a global action is in progress.
Additionally, only one global action can be performed at a time. Global actions include calculations,
imports, exports, period locking, calendar edits, and migration.
If a global action is running, you will see the global action status icon in the application header turn
yellow.

© Copyright IBM Corp. 2005, 2018 5

 If a second administrator tries to perform a calculation or data import while another one is in progress,
the second administrator sees a warning message. The second administrator must wait for the first
administrator's global action to complete.
When the global action has completed, the icon will turn green. The global action status updates when
you place your cursor over the icon and when the URL changes. When a user is inactive, the global action
status updates every five minutes for an hour. If you place your cursor over the global action status icon or
change pages, the inactive update count is reset.
The following actions cannot be performed while a global action is in progress:
• Imports into tables, new table or input form creation, manual submissions to tables and any other edits
to the data or structure of a table.
• Generation and edits to a star schema.
• Scenario addition, edits, and promotion.
• Addition or edits to calculations.
• Running of the Optimize Model feature.

Modules
®
The IBM Incentive Compensation Management client is divided into multiple modules for ease of
navigation.
The following modules are available:

Table 1: Incentive Compensation Management modules

Icon Module name Description
Home The Home page provides a dashboard for
managing your model.

Process Lists Process lists can be used to create, view, and

complete model maintenance tasks.
Composer Composer is used to view, manage, and build
your model.

Pulse Pulse is used to view and share key information

through prebuilt reports.
Workflow Manager Workflow Manager is used to create and
manage your business processes.

Portal Access Portal Access is used to define web tabs and

web access to the web client.

Scheduler Scheduler is used to create and schedule

model processes.

Task Manager Task Manager is used to maintain your model.

Activity Activity is used to track model activities.

Scenarios Scenarios is used to build what-if scenarios,

view side-by-side comparisons of results, and
analyze significant variances to plans.

6 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Home page
®
The Home page is your entry point for working with models in IBM Incentive Compensation
Management. It provides a dashboard that you can use to manage your models.
The Home page is designed to help users complete the following actions:
• Navigate directly to tables and reports on your watch list without having to drill through components.
• View and access process lists that have run recently.
• View recent activity in the model.
Here's a quick demonstration to help you get started with navigating the Home page:

https://youtu.be/d6oymbkdJ1c

Adding items to your watch list

®
In IBM Incentive Compensation Management, you can create a list of items in your model that you want
to quickly access from the Home page.

About this task

This list is specific to each individual login ID. Users can add items such as calculations, components,
Presenter reports, and web forms to their watch list.

Procedure
1. On the Home page, click the Add icon next to the My Watchlist heading.
2. Select the item that you want to add to your watch list.
3. Click Add.

Finding items from the Home page

®
You can use a filter on the Home page of IBM Incentive Compensation Management to find components,
calculations, and reports in large models.

Procedure
On the Home page, in the What are you looking for? field, type the name or partial name of the item that
you are looking for.

Results
The filtered list consists of any component, calculation, Presenter report, or web form that contains the
text that you typed.

Documentation and support

®
Use the IBM Incentive Compensation Management Support portal and the IBM Knowledge Center to
access more information on the product, submit feature requests, or contact the Support team.

Client Success portal

®
You can access the IBM Client Success portal from the Help menu of IBM Incentive Compensation
Management.
From the Help menu, you can contact the IBM Support team, view the Support Portal, or submit a feature
request. On the Client Success portal, you can log tickets, access the knowledge base, and download
documents. A user name and password are required for this portal.

Getting started 7
Accessing help
®
You can access help documentation in IBM Incentive Compensation Management.

About this task

You can access the IBM Knowledge Center from within the product.

Procedure
1. From the application header, click the Help icon.
2. Select Knowledge Center from the menu.

Video tutorials
®
There are many video tutorials that can give you a better understanding of how to perform tasks in IBM
Incentive Compensation Management.
Many topics in the documentation link directly to an associated YouTube video. You can also click the
Help icon in the Incentive Compensation Management application, then click YouTube Channel to view
the complete list of video tutorials.

Request a feature
®
You can access the RFE Community through IBM Incentive Compensation Management to submit a
feature request.
If you have a great idea for a new feature or a way to improve on an existing one, you can click the Help
icon in the Incentive Compensation Management application and select Submit a Feature Request.
This opens the IBM Software RFE Community where you can submit your idea to the team for review as
well as view and vote on other requests.

8 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 4. Process lists
®
You can create process lists in IBM Incentive Compensation Management to help users complete model
maintenance tasks.
A process list is useful to remind users what tasks must be completed and in what order to maintain the
model.
Here's a short video that shows you how to add tasks to process lists:

https://www.youtube.com/watch?v=nt1SdPXlhKs

Viewing process lists

®
In IBM Incentive Compensation Management, you can view all saved process lists.

Before you begin

You can see only the lists that you have been granted access to.

Procedure
1. Open Process Lists.
Process lists are organized by their date of creation. The most recently created process lists are first.
2. To search for a process list, type the name (or partial name) of the process list in the Search field.
3. Click a process list to open it.
Tip: When viewing a process list, click the Minimize icon to hide the process list overview.

Adding process lists

®
You can add process lists that identify the tasks that users must complete for a particular process in IBM
Incentive Compensation Management.

Procedure
1. In Process Lists, click Add New Process List.
2. Type a name for your list.
3. Select one of the following types of process lists:
Process type Description
Ordered A process whose items must be completed in a particular order.
Perpetual A process whose items can be completed in any order.
4. In the Process Overview field, type a description for the process list.
5. Click Save.

© Copyright IBM Corp. 2005, 2018 9

Adding tasks to process lists
®
A process list in IBM Incentive Compensation Management can contain any number of tasks.

About this task

Each task can have a description to provide users with information about the task. Tasks can be linked to
an appropriate item in the model and an action for the selected item can be created. For example, you can
link a process list item to a table, and then add an action like importing data into the table.

Procedure
1. In Process Lists, open the process list that you want to add tasks to.
2. Click Add Task.
Tip: To add a task to the end of the process list, click Add New Task at the bottom of the screen.
3. Type a name for the task.
4. Click Add to select an item that you want the task to link to and complete the following steps:
a) In the Search field, type the name of the item that you want to link to.
b) Expand the category that the item belongs to.
c) Click the name of the item that you want to link to.
d) Click Select.
Process list users can navigate to the component, table, input form, web form, Presenter report,
Scheduler process, or module by clicking a linked task.

5. From the Select drop-down menu, select an action that you want to complete on the linked item or the
subordinate module that you want to open.

10 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 6. To show the row count of an input form or table next to the task name, select the Show Details check
box.
Important: If the input form contains more than 1000 rows, the row count displays as (1000+).
7. Type a description of the task to help users understand its purpose.
8. Click Save.

Adding subtasks to process lists

®
A process list in IBM Incentive Compensation Management can contain any number of subtasks.

Procedure
1. In Process Lists, open the process list that you want to add subtasks to.
2. Place your cursor over the task that you want to add a subtask to and click the Add icon.
3. Create the task.

Copying process lists

®
In IBM Incentive Compensation Management, you can duplicate a process list and edit the duplicated
process list instead of creating a new process list from scratch.

Procedure
1. In Process Lists, place your cursor over the process list in the left pane, and click the Copy icon.

2. Click the Edit icon next to the copied process list name to rename it.

The copied process list is displayed at the bottom of the list.

Process lists 11
Editing process lists
®
You can make changes to existing process lists in IBM Incentive Compensation Management.

Procedure
1. In Process Lists, open the process list.
2. Click the Edit icon next to the process list name to make changes to the process list name, type, or
overview.
3. To make changes to the task list, you can perform the following actions:
• To change the order of the tasks, drag a task up or down the task list.
• To delete a task, place your cursor over the task and click the Delete icon.
• To edit a task, place your cursor over the task and click the Edit icon.

Marking tasks as complete

®
In IBM Incentive Compensation Management, completed tasks can be tracked and flagged as complete
in process lists.

Procedure
1. In Process Lists, open the process list.
2. To mark a task as complete, select the check box next to the task.

Results
The user name of the administrator who selected the check box and the date and time that the task was
completed is populated automatically.
Important: The date and time of task completion are recorded as the time on the database server,
regardless of the local time on the user's computer. This approach ensures that the completed time is
consistent and accurate for all users in all locations.

12 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 5. Composer
®
Use Composer in IBM Incentive Compensation Management to view, manage, and build a model.
From this interface, you can build and edit the following items:
• tables
• components
• Territory Management objects
• calculations
• Producer Lifecycle and Credential Management (PLCM) objects
• data stores
• Presenter reports
• web forms
Composer is also used to manage hierarchies, such as the payee structure, and to import data into the
model.
Composer provides a visualization of the entire model, which is helpful for design, troubleshooting, and
refinement. This visual representation is configurable and can show either a high-level representation of
the model or a detailed picture of table and calculation streams.
At a high level, the following steps describe how to build a model:
1. Add components to organize model objects.
2. Set security for each component.
3. Add any necessary or relevant documents to a component. These documents might include a
description of the contents of the component.
4. Build tables to contain data.
5. Import data into the tables from external source systems.
6. Manipulate the data by using calculations.
7. Present calculation results in a report or web form.
Important: If any of your calculations require a data source that is contained in another component, you
must add an inbound connection from that data source to use it in your calculation. If any of your table
data or calculation results must be used as sources for a calculation that is contained in another
component, you must add an outbound connection so that your data can be used outside the component.

Composer object arrangement

®
In IBM Incentive Compensation Management, you can automatically arrange the components and
objects into a logical pattern in Composer.

In the Composer toolbar, the Arrange icon smooths out connection lines and moves objects to
produce an organized diagram. You can undo the auto arrange by refreshing the page if you do not like the
layout.

Composer object visibility

®
In Composer in IBM Incentive Compensation Management, you can choose to show or hide objects
based on their type, sources, or other criteria.
Here's a short video that gives you a look at how to filter and search for objects in Composer:

© Copyright IBM Corp. 2005, 2018 13

 https://www.youtube.com/watch?v=SgUKNlx7XlA

Displaying specific object types only in Composer

®
In IBM Incentive Compensation Management, you can choose to display only specific types of objects in
Composer.

Procedure
1. In the Composer toolbar, click the Filter icon.
2. Clear the check boxes next to the items that you do not want to view in Composer.

View Composer object sources

®
In IBM Incentive Compensation Management, you can see which Composer objects a selected object
uses as data sources. Alternatively, you can see which objects use a selected object as a data source.

When you select an object in Composer and click the Uses icon , only the objects that are sources for
the selected object and exist in the same component as the selected object are displayed.

When you select an object and click the Used By icon , only the selected object and the objects that
use it as a source and exist in the same component are displayed.

View table or calculation data

®
In IBM Incentive Compensation Management, when you click a table in Composer, you can see the data
and results in the Viewer window at the bottom of the screen.

Sidebar
®
In IBM Incentive Compensation Management, the sidebar allows you to add items to Composer from the
Palette tab or find previously added items from the Navigation tab.
Tip: You can collapse the sidebar to see more of the Composer screen by clicking the Hide the Sidebar
icon in the Composer toolbar.
This short video demonstrates how to view object dependencies in the Used By section on the Navigation
tab:

https://www.youtube.com/watch?v=B1-Mtr_pzO0

Palette tab
®
In IBM Incentive Compensation Management, the Palette tab in Composer stores empty components
and objects that can be dragged and added to the main Composer window.

Navigation tab
®
In IBM Incentive Compensation Management, the Navigation tab in Composer contains a Favorites
section, a Component Search section, and a Used By section.
Any object in Composer, except connections, can be added to the Favorites section. When objects are
added to the Favorites section, links to those objects in Composer are created. When a user clicks the
link in the Favorites section, the object is highlighted and centered in the Composer window. You can
organize the object links into folders and sub-folders.
Here's a short video that show you how to use the Favorites section on the Navigation tab:

https://www.youtube.com/watch?v=LaPUZSLe1Lg

14 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 The Component Search section lists all the objects in Composer and groups them by object such as
components, tables, calculations, Presenter reports, and web forms. You can type the name of the object
that you want to find in the Search field. When you stop typing, Incentive Compensation Management
searches for any objects that contain the text string that you typed. The results return the top 50 matches
for all objects; however, the search results do not limit the number of components shown. To only view
the results from the component that you are currently viewing, clear the Show All Components check
box.
You can access the menu that is associated with the object from the Navigation tab.

Viewing dependencies
®
In IBM Incentive Compensation Management, on the Navigation tab in Composer, you can view a list of
the objects that use a selected object as a source.

About this task

The dependency list on the Navigation tab includes objects in Composer as well as Presenter data
sources, row form sources, and stored values that use a selected Composer object as a source. When you
view the dependencies for a data store, the Presenter reports and star schemas that use the data store
are displayed. Web forms are not supported by this feature.
You can use the Lock View check box to prevent the Used By tab from refreshing when a new object is
selected in Composer. To view the dependencies of a new Composer object, you must clear the Lock
View check box.

Procedure
1. In Composer, click the Navigation tab.

2. Click the Used By tab .

3. In the Composer window, select the object.
The objects that are dependent on the selected object are displayed on the Used By tab.

Exporting the Used By list

®
In IBM Incentive Compensation Management, you can export information from the Used By tab to a CSV
file.

Procedure
1. In Composer, click the Navigation tab.

2. Click the Used By tab .

3. In the Composer window, select the object.
4. On the Used By tab, click the Export to CSV icon.

Adding objects to the Favorites list

®
In IBM Incentive Compensation Management, you can add a link to any frequently used object, except
connections, to the Favorites section in Composer.

Procedure
1. In Composer, click the object.
2. In the menu that displays on the right side of the window, click the Add To Favorites icon.

Composer 15
 3. In the sidebar, click the Navigation tab, and click the Favorites tab to view the list.
Tip: You can add folders and sub-folders to the Favorites tab to organize your Favorites list.

Overview window
®
In IBM Incentive Compensation Management, the Overview window in Composer shows a scaled-down
version of the Composer diagram.
The whole Composer diagram is displayed in the window. Dependency view selection and object visibility
selection in Composer are reflected in the Overview window.

The section of the Composer diagram that you are currently viewing is outlined in blue. You can resize and
move the blue box around the Overview pane to navigate to different areas.
Here's a short video that gives you a look at how to use the Overview window in Composer:

https://www.youtube.com/watch?v=kscIq0KvW8M

Multi-Edit and Single-Edit mode

®
When you work in Composer in IBM Incentive Compensation Management, you can use single-edit mode
or multi-edit mode. In single-edit mode, every change is immediately saved. In multi-edit mode,
validation is suspended and changes are not saved until you leave multi-edit mode or save your model.
You can make many temporary changes in multi-edit mode.

If you want to use multi-edit mode, click the Multi-Edit icon and make sure that it is highlighted. If
you want to use single-edit mode, make sure that the Multi-Edit icon is not clicked and the icon is not
highlighted.
Imagine that you want to change the source of a calculation that is used by another calculation. You must
edit each calculation in the chain, but until you change all calculations, some calculations might be
invalid. These temporary changes can occur only in multi-edit mode because only valid calculations can

16 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 be saved in single-edit mode. If you try to make an invalid change or connection in single-edit mode, an
error message is displayed.
In single-edit mode, you can complete the following tasks:
• Open components and objects
• Auto arrange
• Add or delete components
• Add or delete tables, calculations, Presenter reports, and web forms
• Import data into tables
• Add inbound or outbound connections
• Set component color
• Export Composer diagram
• Select visibility icons
• Cut, copy, and paste
• Preview calculations
In multi-edit mode, you can complete the following tasks:
• Open components and objects
• Add, edit, or delete calculations
• Edit the partitions of a calculation and the port that is connected to the partition, so that it matches the
new calculation
• Add inbound or outbound connections
• Select visibility icons
• Export Composer diagram

Exporting the Composer diagram

®
In IBM Incentive Compensation Management, you can export the Composer diagram to an image file.

Procedure
1. In Composer, in the toolbar, click the Download icon.
2. Set the size of the image.
3. Click Finish.

Results
The image is downloaded as a PNG file.

Composer navigation
®
In IBM Incentive Compensation Management, you can easily work with and locate objects in Composer.

Selecting objects and zooming in Composer

®
In IBM Incentive Compensation Management, you can select multiple items and zoom in and out of the
Composer window.

Procedure
1. Open Composer.

Composer 17
 2. Complete one or more of the following steps:
• To select multiple items, drag a selection box around the items or press Ctrl + click.
• To select a group of items, drag a selection box around the items.
• To zoom in and out, scroll up and down with the mouse wheel. The Composer window centers on
your cursor.

18 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 6. Components
®
In IBM Incentive Compensation Management, a component is a container that is used to organize your
Composer model.
Add components to give your model a framework and to make sure that your model is easy to use. After
you add components, you can build model objects such as tables, calculations, and reports.

Component organization
®
In IBM Incentive Compensation Management, you can organize your Composer model in many ways.
You can build your model wide by placing components side-by-side (sibling model), or you can build your
model deep by placing components inside other components (parent-child model).
For example, a typical model might have all of its compensation plans represented by high-level
components and all of the plan objects (tables, calculations, and data stores) contained in child
components. Complex plans might have multiple levels of components that are used to separate and
organize different calculation pieces.
When you are planning how to organize your model, you must also consider security and data
accessibility.
Security
While granular access permissions can be defined, typically Composer security is defined at a
component level. If you want to grant access to particular compensation pieces, but deny access to
other pieces, you can put the compensation pieces in separate components. Then, by turning access
on or off for a particular component, you can deny or allow access to everything in the entire
component.
Data accessibility between components
While data can flow between components through connections, certain restrictions do exist. For
example, any sources that must be added to a web form must be contained in the same component as
the web form.

Navigation between components

®
In IBM Incentive Compensation Management, you can move in, out and between Composer components
easily by using breadcrumbs or simply viewing the component.

Breadcrumbs
®
In IBM Incentive Compensation Management, breadcrumbs can help you understand the location of
Composer components.
Breadcrumbs provide links back to each parent component from the current component that you are
viewing. The Top breadcrumb represents the top level, or main window, in Composer.

Viewing components
®
In IBM Incentive Compensation Management, after you build the Composer model structure, you view
components and display their contents.

About this task

There is no limit to the depth of the model. The number of component levels is determined by model size,
complexity, and security requirements.

© Copyright IBM Corp. 2005, 2018 19

 Procedure
In Composer, click the arrow on the component to open it.

The contents of the component is displayed.

Data flow between components

®
In IBM Incentive Compensation Management, when you work with Composer components, you might
want to connect data in one component to another component.
To share data between components, you must create a connection between the two components.
Connections can flow from parent to child components or from one sibling component to another.

Data accessibility in components

®
In IBM Incentive Compensation Management, add outbound and inbound connections to make data
inside one Composer component available to another component.
You can add inbound and outbound connections to complete the following tasks:
• Use table data as a source for a calculation in another component.
• Use calculation results as sources for a calculation or report in another component.
Data accessibility between sibling components
You can create connections to use data from tables or calculation results that are in a sibling
component. Sibling components are components that are on the same level in Composer.
Data accessibility between parent and child components
You can create connections to use data from tables or calculation results that are in a parent
component (one level up in Composer). An outbound connection from the object that contains the
data in the parent component must be linked to the child component. In this way, you can create an
inbound connection in the child component so that the data stored in the parent component is
available in the child component.

Component activities
®
In IBM Incentive Compensation Management, you can add and format Composer components.
You can rename and change the color of components to make specific components easily identifiable. You
can attach documents to components to show users the data that is available inside the component. You
can also move components around the Composer diagram and organize them by cutting and pasting or
wrapping them into parent components.

Adding components
®
In IBM Incentive Compensation Management, add empty components to contain and organize Composer
objects.

Procedure
1. In Composer, from the Palette tab in the sidebar, drag the Component object onto the Composer
window.
2. Type a name for the component.

20 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Setting the color of components
®
In IBM Incentive Compensation Management, you can change the color of any component in Composer,
and you can define custom colors.

Procedure
1. In Composer, select the component.
A menu for the component displays on the right side of the window.
2. Click the Change Color icon.

3. Select a color and click Apply.

4. To define a custom color, complete the following steps:
a) Click the Custom tab.
b) Define the custom color.
c) Click Apply.

Renaming components
®
In IBM Incentive Compensation Management, you can change the name of a component after the
component is added to Composer.

Procedure
1. In Composer, select the component.
A menu for the component displays on the right side of the window.
2. Click the Rename icon.
3. Type the new name for the component.

Adding documents to components

®
In IBM Incentive Compensation Management, you can attach files that contain data or information about
the Composer component to the component.

Procedure
1. In Composer, select the component.
A menu for the component displays on the right side of the window.
2. Click Show More.
3. Click Manage documents from the menu.
4. Click Add a Document.
5. Select the document that you want to attach.
Tip: You can select more than one document to add.

Components 21
Copying components
®
In IBM Incentive Compensation Management, you can copy a selected component along with the
calculations and tables that it uses or depends upon.

Procedure
1. In Composer, select the component that you want to copy.
2. In the toolbar, click the Copy icon.
3. Navigate to the place where you want to paste the component and click the Paste icon.
4. In the Suffix field, type a suffix to add to the component so that you do not have two components with
the same name and ensure that you can distinguish the copied component from the original.
5. If the copied component contained any connections, specify the new sources for the connections by
clicking Automatch or by manually mapping the sources. You must map the old sources to the new
sources.
6. Click Save.

Results
The component is pasted as required. All connections (if any) stay intact.

Deleting components
®
In IBM Incentive Compensation Management, you can delete components as long as they do not contain
any objects that are used as sources for objects in other components.

Procedure
1. In Composer, select the component that you want to delete.
2. In the toolbar, click the Delete icon.
Tip: Delete all of the component's dependencies before you delete the component.

Wrap and unwrap components

®
In IBM Incentive Compensation Management, you can organize objects in Composer by grouping them
together inside components.
The wrap feature takes the selected objects and puts a component around them, adding connections and
linking them as needed. The unwrap feature takes the selected component and moves its contents into its
parent component; removing connections and relinking parent objects as needed.

Wrapping objects into components

®
In IBM Incentive Compensation Management, you can wrap any number of objects into a component as
long as they comply with the restrictions for wrapping.

About this task

The following list describes the restrictions for wrapping:
• If the set of selected objects would create a cycle, they cannot be wrapped, for example, if A > B > C,
then you cannot wrap A and C only.
• Web forms that contain sources with editable fields, row forms, multi-select, or admin forms that
reference non-global tables must exist in the same component as the referenced table.
• Tables with a single key column cannot be made into connections that are used by calculations.

22 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Procedure
1. In Composer, select an object.
Tip: To select multiple objects to wrap, press Ctrl and select.

2. In the toolbar, click the Wrap icon.

Unwrapping components
®
In IBM Incentive Compensation Management, you can delete a component. The objects that were inside
the deleted component are placed in its parent component.

About this task

The following list describes the restrictions for unwrapping:
• If the parent component has an inbound connection with the same name as something in the target
component, it cannot be unwrapped. This restriction prevents the possibility of two items with the same
name in the same component.
• If any connections are not linked, the component cannot be unwrapped.
• Components that are empty cannot be unwrapped. A message instructs you to delete the component
instead.

Procedure
1. In Composer, select the component.

2. In the toolbar, click the Unwrap icon.

Connections
®
In IBM Incentive Compensation Management, connections in Composer link components together.
Connections can be inbound and outbound.
Use connections to send data from tables, calculations, and other sources to related components that
require the information. For example, if a component contains a data table with transactional data, it can
be connected to another component that contains a calculation that must calculate results by using the
transactional data.
Connections from one object to another are represented by arrows in the Composer diagram. From inside
the components, inbound connections are at the bottom of the component, and outbound connections
are at the top.
Outbound connections
A resource that is used to export calculation results or table data from a component. They can be
created from calculations, tables, or other connections. When you add a connection, you are
specifying that the data in the selected table or calculation is available for use in child or sibling
components. To use the outbound connection in a second component, you must make a
corresponding inbound connection to the second component.
Inbound connections
A resource that is used to import data from selected outbound connections into a component. They
specify which component the selected outbound connection must connect to.

Components 23
Connection names
®
When you add an outbound connection, IBM Incentive Compensation Management automatically gives
the outbound connection the same name as the source.
For example, if you add an outbound connection from a table that is named ERP, the connection is named
ERP.
You can rename the connection to distinguish it from other model objects such as tables and calculations.
For example, you can use a suffix such as Out, or you can choose another suffix, such as Feed. You can
also change inbound connection names and the Out suffix to a prefix, or add a prefix such as IN.
The following list gives you a few examples of naming options:
• Out ERP
• ERP Feed
• In ERP
• Connect ERP

Adding connections
®
In IBM Incentive Compensation Management, you can use inbound and outbound connections in
components to send data from one component to another. Inbound connections can be used as sources
in components.

Procedure
1. In Composer, view the component with the object that is your outbound connection source.

2. From inside the component, click the New outbound connection icon .
3. Select the data source for the connection.
4. Click the Edit icon in the window header to give the connection a name.
5. Click Next.
6. Delete or add the columns that you want to include in the connection and click Next.
7. Select the connection columns on the right that map to the source columns on the left.
8. Click Create.
9. View the component that you want to add the inbound connection to.
10.From inside the component, click the New inbound connection icon and add the connection created
in step 2.

Renaming connections
®
In IBM Incentive Compensation Management, you can give connections new names.

Procedure
1. In Composer, view the component that contains the connection that you want to rename.
2. Click the Edit icon on the connection.
3. Click the Edit icon next to the connection name.
4. Rename the connection and click Save.

24 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Editing connections
®
In IBM Incentive Compensation Management, you can rename a connection and change the source of a
connection.

About this task

Connections cannot be disconnected from their sources, but disconnected connections can be
reconnected to other sources.

Procedure
1. In Composer, open the component that contains the connection that you want to edit.
2. Click the Edit icon on the connection.
3. Perform any of the following actions:
Action Description
Click the Edit icon Rename the connection.
Click the "X" next to data sources Delete sources from the connection.
Drag sources from the right to the left pane Add new sources for the connection.
4. Click Next.
5. Perform any of the following actions:
Action Description
Click the "X" next to columns Delete columns from the connection.
Drag columns from the right to the left pane Add new columns to the connection.
6. Click Next.
7. Map the source columns to the connection columns.
8. Click Finish.

Editing connection mapping

®
In IBM Incentive Compensation Management, you can change the source columns that the connection
columns are matched to.

Procedure
1. In Composer, click the component containing the inbound connection.
A menu for the component displays on the right side of the window.
2. Click Manage links.
3. Expand the connection that you want to edit.
4. From the drop-down lists, select the connection columns to match to the source columns.
Tip: Click Automatch to have the application map identical column names automatically.

Components 25
 5. Click Save.

Replacing a connection with a global table

®
In IBM Incentive Compensation Management, you can replace connections with global tables.

About this task

If the global table has more columns than the connection, it can replace the connection as long as
identical column connections exist in the table and connection.

Procedure
1. In Composer, view the component containing the connection that you want to replace with a global
table.
2. Click the connection that you want to replace.
A menu for the connection displays on the right side of the window.
3. Select Show More.
4. Select Replace connection from the menu.
5. From the drop-down list, select the global table that you want to replace the connection with.
6. Click Finish.

Deleting connections
®
In IBM Incentive Compensation Management, you can remove inbound and outbound connections from
components.

About this task

You cannot delete a connection if it is in use by another object.

26 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Procedure
1. In Composer, view the component that you want to remove connections from.
2. Click the connection that you want to delete.
A menu for the connection displays on the right side of the window.
3. Click Show More.
4. Select Delete Connection from the menu.

Viewing current values in a connection

®
In IBM Incentive Compensation Management, you can view the data from the table or calculation that is
the original source of a connection in Composer.

Procedure
1. In Composer, view the component that contains the connection.
2. Click the connection that contains the values that you want to view.
3. Click Show More.
4. Select View Current Values from the menu.

Viewing the flow of data through connections

®
In IBM Incentive Compensation Management, you can see where a selected connection was added and
where the connection is being used.

About this task

Use the information to analyze the flow of data through your model.

Procedure
1. In Composer, view the component containing the connection that you want to view information for.
2. Select the connection.
A menu for the connection displays on the right side of the window.
3. Click View connection.

Components 27
28 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 7. Tables
®
In IBM Incentive Compensation Management, you can edit the database structure to store the metrics
that are needed for compensation calculations. To edit database structure, you can add fields or entire
tables.
For example, you might need to include commission rates or quotas by customer, product, or payee. Use
Composer to add that information to an existing table, such as the Payee table, or you can choose to add
an entirely new table for lookup purposes. The rate and quota information can be retrieved later for
calculations.
When you add a model, the hierarchy tables (Payee, Account, and Time), are displayed in the top level of
Composer. The hierarchy tables, and any other tables that you add, can be moved by cutting and pasting,
as long as the table is not used as a source.

Table types
®
In every model, IBM Incentive Compensation Management adds system tables when the model is
created. In addition to these system tables, you can create Data, Structural, Custom, Hierarchy and
View tables.
After a table is created, new fields can be added and existing fields can be deleted. However, the primary
key structure of the table cannot change and adding or deleting primary key fields is not permitted after
table creation.

System tables
®
System tables are automatically added in IBM Incentive Compensation Management. System tables
include Title, Salutation, Currency, and Group Member tables.
System tables are added to contain common attributes for fields in the Payee table. The Title,
Salutation, and Payee Currency fields in the Payee table are populated with information from their
respective System tables. Therefore, all possible titles, salutations, and currencies that are needed by the
Payee table must be listed in the System tables. More fields can be added to System tables as needed.

Table 2: Types of system tables

Table Description
Title This table contains a TitleID field and a Title field.
The Title column in the Payee table picks from the TitleID field in the
Title System table, so all job titles attributed to any payee in the Payee
table is loaded into the Title table. More fields can be added to this table
if needed.

Salutation This table contains a Salutation column and is pre-populated with

common salutations.
The Salutation field in the Payee table picks from the Salutation table,
so any salutations attributed to any payee in the Payee table must be
loaded into the Salutation table. More fields can be added to this table if
needed.

© Copyright IBM Corp. 2005, 2018 29

Table 2: Types of system tables (continued)
Table Description
Currency This table is populated with USD after model creation. More currencies
can be added if necessary.
This table contains a CurrencyID field and a Name field. The Payee
Currency field in the Payee table picks from the Currency table, so any
currencies needed to pay any payee must be contained in the Currency
table. More fields can be added to this table if needed.

Group Member This table contains the PayeeID, Name, Start Date, and End Date for
each payee that has been added to a payee group.
The Group Member table is created automatically and its structure
cannot be edited. The primary key field for this table is the GroupID,
which is automatically generated. This table can be used as a calculation
source, but you cannot view its structure or contents in Composer.

Hierarchy tables
Hierarchy tables contain relationships that are necessary to analyze and manage organizational data in
®
IBM Incentive Compensation Management.
After a model is created, the Account, Payee, and Time hierarchy tables are created automatically.
More hierarchy tables can be added after the model is created. Common hierarchy examples include
product, customer, and territory hierarchies.
Hierarchies use parent-child relationships to organize structural information. In a parent-child hierarchy,
two table columns define the hierarchical relationships among the dimension members. The primary key
column uniquely identifies each dimension member and a parent column identifies the parent of each
dimension member. Each parent can have many children, but each child can have only one parent. The
parent column in hierarchies has a self-referencing relationship, or self-join, within the table.
For example, if the Parent column in the Payee table contains each payee's manager, your table might
look like the following table. The Parent column contains the ID for each payee's manager and references
the PayeeID column.

Table 3: Parent column example

PayeeID Name Parent
E010 HUDDLE Dan Huddle E030 CLARKSON
E020 HUMPHREY Darnell Humphrey E030 CLARKSON
E030 CLARKSON Debbie Clarkson E040 YOUNG
E040 YOUNG Diana Young E210 KAREY
E210 KAREY Doug Karey

The following table describes the hierarchy tables that are added automatically when you create a model.

30 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 4: Types of hierarchy tables
Table Description
Payee This table is used to store data about individuals who are being compensated by, or
who are approving, variable compensation payments.
It contains many of the fields that are typically needed to organize payee information.
You do not need to use columns that do not suit your organization, and you can add
more columns to the table as required.
The primary key column is the Payee ID column. The Parent column identifies the
groups that your payees are organized into. For example, because payees are often
grouped into territories, the Parent column is often used to store payee territories.

Accounts This table is used to store loaded values from your source system and output values.
The accounts are typically a subset of the general ledger chart of accounts and are
associated with commissions and other variable compensation payments. By default,
the table contains AccountID, Name, Parent, and DrCr fields.
In this table, the account ID column is the primary key field. The Parent column is
used to organize your account IDs into groups. For example, GL accounts are typically
grouped by account type, so the account type is stored in the Parent column.

Time This table is used to store the payroll periods calendar.

This table is the only hierarchy that is not displayed as a table in Composer.

Data tables
®
In IBM Incentive Compensation Management, create data tables to store transactional data, such as lists
of sales or orders.
A data table contains a date field, but you can add other fields as needed. When periods are locked, all
data tables that are associated with the locked calendar are locked by the Date field in the table (other
table types are not locked). If more than one Date field exists in the data table, you must select a Lock by
Date when the table is created to specify which field to use to lock the table.

Structural tables
®
Structural tables help to define the structure of your model in IBM Incentive Compensation Management.
Structural tables are customizable.
Because you can add only one primary key column in a structural table, pick lists can pick from structural
tables.

Custom tables
®
Custom tables are used to help define the structure of your model in IBM Incentive Compensation
Management. Custom tables are customizable.
Because you can add multiple primary key columns to a custom table, pick lists cannot pick from custom
tables.
Custom tables can be created for multiple purposes. One common use of a custom table is to contain data
for reference values that vary by one or more key members, or that exist in the form of a lookup. As a
reference for compensation calculations, you can add a custom table to hold compensation rates that
vary by product and by quarter, or multipliers that define benefits based on a percent of quota attainment.
For example, a custom table might contain the format displayed in the following table.

Tables 31
Table 5: Data for a custom table
Product Quarter Compensation Rate
100 Quarter 1 8.00%
100 Quarter 2 7.95%
100 Quarter 3 7.75%

View tables
®
In IBM Incentive Compensation Management, you can use a View table to display results that are
contained in two different sources.
Views do not contain their own unique data sets. Use a view to join tables together to create a view of two
tables.
With Views, joins can contain tables and the results of calculations. When you add calculations, you
cannot use Views as data sources. Instead, add columns to the original data source during the calculation
creation process. Because Views cannot be used as data sources, they also cannot be made into global
tables. Views are not accessible from the web client.
When you add a View, you join two or more tables based on a point of commonality. For example, consider
a situation where you join a Product table to a Payee table to display the products that were sold by each
payee. If you restrict your results based on the payee ID, you receive the following results:

Table 6: Payee table

PayeeID Name
001 John Smith
002 Sue Jacob
003 Marc Frederick
004 Mary Scott

Table 7: Product table

ProductID ProductName PayeeID
123 Printer 001
234 Cable 001
345 Monitor 003

Table 8: Payee table and Product table joined in a view table

PayeeID Name ProductID ProductName
001 John Smith 123 Printer
001 John Smith 234 Cable
003 Marc Frederick 345 Monitor

Important: In the preceding example, no data is displayed for Sue Jacob or Mary Scott because there are
no corresponding product sales for those payees.

32 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table structure
®
In IBM Incentive Compensation Management, when you add Data, Structural, Custom, and View tables
in Composer, you must add columns to the table to create the structure of the table.

Table column types

®
In IBM Incentive Compensation Management, you can define the structure of tables using several
different column types.
The following types of columns can be used to create your table schema.

Table 9: Table column types

Column Type Description
Text Can contain any numeric, alpha, or symbol, but cannot be used in a formula. Text
fields have a limit of 100 characters.
Date Can contain any data in a date format (mm/dd/yyyy, dd/mm/yyyy, Jan. 1, 2011).
Numeric Can contain only figures and can be used in formulas. A numeric column can contain
up to 28 integers and 14 decimal places.
Pick List A link to another table. Values that are loaded into this field must be contained in the
linked table or they will be rejected during an import. Pick lists are ideal for
situations where the data that you need exists. For example, you can add a pick list
for the payee ID. If you want to add a Data table that contains accounts, dates,
payees, values, and customers, you can define pick lists for accounts and payees.
Important: Pick lists can pick only from Hierarchy and Structural tables.

Email A column similar to Text but with extra validation to restrict the input to email
addresses.
Comment A column that is designed for longer text input. Comment fields have a limit of 1000
characters.
URL Restricts input to valid URLs.

Table columns between components

®
The table schema for all tables is globally available throughout a model in IBM Incentive Compensation
Management, regardless of the component that contains the table.
You can add a table in a component that requires a column from another component. For example, your
Payee table is in one component and you add a custom table in another component. Your custom table
contains a payee ID column that pick lists from the Payee table. Because the table schema is universally
accessible, tables can pick from other tables that are in different components.

Primary keys
®
In IBM Incentive Compensation Management, a primary key uniquely identifies each row in a table.
If your primary key is the payee ID, no two rows of data in your table can contain the same payee ID. You
can identify more than one primary key in some tables. If you add a custom table that identifies both the
payee ID column and the date column as primary keys, no two rows of data can contain the same
combination of date and payee ID.

Tables 33
Table creation
®
In IBM Incentive Compensation Management, you can create tables to store data required for
compensation calculations.

Adding tables
®
In IBM Incentive Compensation Management, add tables in Composer to contain data that is required for
your model.

Procedure
1. In Composer, open the component that you want to add the new table to.
2. From the Palette tab, drag the Table object into the component.
3. From the Table type drop-down list, select the type of table that you want to create and click Next.
4. Type a name and description for the table and click Save. The table name cannot contain spaces.
5. If you want this table to contain effective dates, select the Effective dated check box.
6. Type a name for the primary key field and select the column type from the Type drop-down list.
Important: Each field in the table must have a unique name. Field names can contain spaces. Field
names cannot be changed after the table is added.
7. Click Add a column to add more fields to the table.
8. For each field that you add, perform the following steps:
a) If the field is a primary key field, select the ID check box.
b) Type a name for the new field.
c) From the Type drop-down list, select the column type.
d) If you select Pick List as the column type, define the pick list field.
9. When you are finished adding fields, click Create.

Defining pick list field types

®
If you selected pick list as a field type in a table in IBM Incentive Compensation Management, you must
define the source to populate the pick list.

Procedure
1. In Composer, add or edit the table.
2. From the drop-down list, select the table and column to populate the pick list.
For example, if you link to the Payee table, you might want the description column to be the Name
column.

34 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 3. Click Add filter to restrict the rows available for the pick list.
a) Add any data sources to filter your data.
b) Click Next.
c) Define any restrictions and then click Ceate.
For example, you can add a table with a Payee column that contains transaction information for
Regional Sales Managers. After you add this filter, only payees with the job title Regional Sales
Manager can be added to the new table.

What to do next
All linked fields are attached to a source table. Review the structure of all source tables before you exit.

Adding Data tables

®
In IBM Incentive Compensation Management, you can add a data table that can be used to hold
transactional data.

Procedure
1. In Composer, open the component that you want to add the new table to.
2. From the Palette tab, drag the Table object into the component.
3. From the Table type drop-down list, select Data and click Next.
4. Type a name and description for the data table and click Save.
5. To define the primary key, select the ID check box next to the field.
Important: Although data tables can contain multiple primary key columns, to simplify the partitioning
process during calculation creation, use only one column, such as a transaction ID column.
6. Click Add a column to add more fields.
7. Type a name for the field and, from the Type drop-down list, select a field type.
8. Define any pick list columns.
9. If your data table contains more than one date field, from the Select lock date drop-down list, indicate
which date field to lock by when a period is locked.
10.Click Create.

Adding View tables

®
You can add a View table to display results from two different sources in IBM Incentive Compensation
Management.

Procedure
1. Open the component that you want to add the View table to.

Tables 35
 2. From the Palette tab, drag the Table object into the component.
3. From the Table type drop-down list, select View and click Next.
4. Type a name and description for the View table and click Save. The name cannot be edited after it is
created.
5. From the Data Sources tab, define the data sources for the View.
6. On the Restrictions tab, define any restrictions for the joined sources and View table.
7. On the Display Columns tab, select the columns that you want to display in the View table. Each
column must be unique.
8. Click Create.

Defining global tables

®
In IBM Incentive Compensation Management, global tables are visible as source from any component in
your model.

About this task

A table cannot be made global if it has the same name as a connection or if it is a View table.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Global from the menu.
An image of a globe is displayed on the table object.

Globalizing and replacing connections

®
In IBM Incentive Compensation Management, tables that are already being used in connections can be
made into global tables.

About this task

When you make a table global, you automatically remove all connection lines. Any objects (for example,
calculations, web forms, and Presenter reports) that use connections with the table as a source, now use
the global table instead.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Globalize and Replace Connections from the menu.

Viewing and editing table structure

®
In IBM Incentive Compensation Management, you can view, add, or remove columns from a table in
Composer.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Edit.
3. You can perform the following actions on the table:

36 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Action Description
Delete columns Click the Delete icon next to the column.
Add columns Click Add a column.
4. When you are done making your changes, click Save.
Important: Account tables and tables that are used by inbound or outbound connections are
displayed in read-only mode and cannot be edited.

Editing View tables

®
In IBM Incentive Compensation Management, you can edit the sources, detail columns, restrictions, and
column names of a View table in Composer.

Procedure
1. In Composer, click the View table.
A menu for the table displays on the right side of the window.
2. Click Edit.
3. Edit the source, joins, columns, restrictions, or column names. You cannot edit the name of the View
table.
Important: If you change the View table, an entry is made to the Audit log indicating that the View
table was edited.

Deleting tables
®
In IBM Incentive Compensation Management, you can delete a table from Composer as long as it does
not have any dependencies.

Procedure
1. In Composer, select the table.
2. In the toolbar, click the Delete icon.

Copying tables
®
In IBM Incentive Compensation Management, you can duplicate tables in Composer and rename them
by adding a suffix.

Procedure
1. In Composer, select the table that you want to copy.
2. In the toolbar, click the Copy icon.
Important: You cannot copy System or Hierarchy tables.
3. In the component where you want to paste the table, in the toolbar, click the Paste icon.
4. Type a suffix for the new table name.
5. Click Save.

Viewing table dependencies

You can view a list of all calculations, web forms, input forms, or other tables that use the selected table
®
as a source in the IBM Incentive Compensation Management model.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.

Tables 37
 2. Click Show More.
3. Select Used By from the menu.
The objects that use the selected table are listed on the Used By tab in the sidebar.

What to do next
You can export the dependency list to a CSV file.

Table data edits

®
In IBM Incentive Compensation Management, you can edit data in a table.
For example, if an organization wants to add a commission rate for each payee, the model administrator
can add a commission rate field to the Payee table. Then, each payee in the system has a commission
rate attribute that can be imported (or manually entered) and then used in calculations.
When you open a table for viewing or editing, any columns that contain a key icon in the header are the
primary key columns. If you do not have access to edit certain columns, those columns are not available.
The following options are available when you open a table for editing.

Table 10: Table editing options

Option Description
Add Add a row of data to the table in an unlocked period.
Edit Make changes to the row data if the row is in an unlocked period.
Primary key fields cannot be changed.

History View details of every change that is made to that row.

History includes edits that are made in both locked and unlocked periods.

Delete Delete a row in an unlocked period.

Version View versions of rows in effective dated tables.

Import Import data into the table from a file.

Publish Send the contents of the selected rows to Microsoft Excel, Microsoft Dynamics
CRM, PDF, Salesforce.com, or text file.

Adding table data

®
In IBM Incentive Compensation Management, you can add data to a table manually.

Procedure
1. In Composer, click the Edit icon on the table.
2. Click the Add icon to open the Add new row tab.
3. Enter the data in the appropriate fields.
4. Click Create.

38 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Editing table data
®
In IBM Incentive Compensation Management, you can edit existing data in a table in Composer.

Procedure
1. In Composer, click the Edit icon on the table.
2. Select the row that contains the data that you want to edit.
3. Click the Edit icon to open the Row Editor tab.
4. On the Row Editor tab, enter the new data in the appropriate fields.
5. Click Submit.

What to do next
Click Next or Previous to edit the row after or before the selected row.

Changing the default edit date for a table

You can change the default edit date that is displayed when you add a record to a table that contains a
®
date field in IBM Incentive Compensation Management. The default edit date can be either today's date
or the first day of the fiscal year.

Procedure
1. Click Admin > More Options.
2. On the General tab, from the Default Edit Date drop-down list, select the date that you want to use.
3. Click Save.

Editing multiple rows in tables

®
In IBM Incentive Compensation Management, you can make a change to more than one row of data in
table at a time.

Procedure
1. In Composer, click the Edit icon on the table.
2. Select the rows that you want to edit.
Tip: Use Shift and click or Ctrl and click to select the rows.
3. Click the Edit icon to open the Multi row editor tab.
4. On the Multi row editor tab, make changes to the data.
5. Click Submit.

Copying multiple rows in tables

®
In IBM Incentive Compensation Management, you can copy and paste existing data in a table in
Composer.

Procedure
1. In Composer, click the Edit icon on the table.
2. Select the row that you want to copy.
3. Click the Edit icon.
4. On the Copy & paste tab, make changes to the data.
5. Click Submit.

Tables 39
Deleting multiple rows in a table
®
In IBM Incentive Compensation Management, you can filter and delete multiple rows from a table at one
time if the rows are not locked, and if the table is not a View table.

About this task

When you delete rows from a table or clear an entire table, all child table records that have pick listed
columns that are linked to the table are also deleted.
When you try to delete rows that are pick listed by other tables, a warning message is displayed that
identifies the tables whose records are deleted. You can view the dependent tables that are affected by
clearing the table.
The Audit log records the start and finish time of the row deletion operation.
This operation deletes the selected rows in the table as well as all
referencing rows from other tables. This action cannot be undone.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Data > Delete Rows.
4. Define the restrictions to filter the rows that you want to delete.
Important: If no restrictions are defined, the entire table is cleared.
5. Click OK.

Turning off the warning message when deleting rows in tables that are pick listed by
other tables
You can turn off the warning message that is normally received when rows are deleted from a table with a
®
pick list column in IBM Incentive Compensation Management.

Procedure
1. Click Admin > More Options > User Settings.
2. Clear the Warn before deleting rows in a table that may affect one or more other tables check box.

Purging table and calculation data

®
In IBM Incentive Compensation Management, you can clear the data from calculations and data type
tables that are associated with a period in a specific calendar. Data in data tables and calculations is
removed up to and including the selected period.

About this task

You can purge periods on both data tables and calculations or on calculations only. In data tables, rows
with dates in the Locked by date field that are at or before the last date in the selected period are
removed. In calculations, rows that have a partition at or before the selected period are removed. The
periods must be locked before you purge calculation data or the purged records will be added the next
time that the model is calculated. This action includes any locked data but does not include data in history
tables.
Attention: Purging periods is a global action that cannot be undone. You must have the
appropriate permission to complete this action. This action is irreversible.

40 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Procedure
1. In Composer, from the toolbar, click Purge Periods.
2. Select the calendar.
3. Select the level of the calendar.
4. Select the period. Data that is associated with all periods up to and including the selected period will
be cleared.
5. From the Mode menu, select Tables and Calculations.
6. Click Purge Periods.

Clearing tables
®
In IBM Incentive Compensation Management, you can delete the entire contents of a table without
deleting the table itself.

About this task

You receive a warning message when you try to clear a table that contains a key column that is pick listed
by other tables. You can choose to continue with the deletion or cancel the action. You can click the
Details button to view the dependent tables that are affected by the table clearing. The warning message
can be turned off in the Admin options.
To use the clearing tables feature, you must have view and edit permissions for Composer as well as the
component in which the table resides. If the table is in the top level of Composer, then you must have Top
> Edit permission. You must also have view and edit permissions for the structure of the table that you
want to clear.
Table clearing can be scheduled by using the Scheduler module.
Table clearing cannot be undone.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Data > Clear Table.

Displaying a description field in tables

®
In IBM Incentive Compensation Management, you can view the description for a pick list field while you
are viewing table data.

About this task

This option is available only if the Description column is set for the pick list column. If the Show
Description feature is enabled when you publish the table, the published results display the description.
After you enable the Show Description feature, it remains enabled until the table is closed.

Procedure
1. In Composer, view the data in a table that has a pick list column to another table.
2. Click the ellipsis in the pick list column and select Show Description.

Tables 41
 Results
The ID and description are displayed for each row in the column.

Navigating between tables

®
In IBM Incentive Compensation Management, from within any table in Composer, you can easily
navigate to any related table by using the Jump To feature. The Jump To feature is not available in View
tables.

About this task

You can use the Jump To feature only if the table is saved.

Procedure
1. In Composer, view the data in a table that has a pick list column to another table.
2. Click the ellipsis next to a row of data in a pick list column.
The results in the table to which you navigate are filtered by the row of data you select.
3. Next to Jump To, click the expand icon.
4. Select a table to navigate to. You can navigate directly to the tables that the selected column picks
from.

Results
The table opens in the current tab.

Filtering table data

®
When you are viewing table data in IBM Incentive Compensation Management, you can filter the results.

Procedure
1. In Composer, click the Edit icon on the table.
2. Click the Filter icon in the header of the column that you want to filter.
3. Set filter parameters. You can filter results based on a range of values or by a specific value.
4. Click Apply filter. You can choose multiple columns to filter data by.

42 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Finding and replacing data in a table
®
Use the data transformation feature to find and replace data in any table in IBM Incentive Compensation
Management.

About this task

This procedure is useful when there is an error in source data that affects multiple rows of data in a table.
Rather than manually adjusting each row, you can make the change simultaneously across multiple rows.

Procedure
1. In Composer, click the table.
2. Click Show More.
3. Select Data > Transform.
4. In the Find field, type the original value that you want to be replaced.
Important: In the Find field, asterisks (*) act as wild cards and underscores ( _ ) act as placeholders.
If the Find field is blank, the engine searches for empty cells in the specified column.
5. In the Look in field, select the table where the data transformation will occur.
6. In the Make change in field, select the column that contains the value that you want to replace.
Important: The search engine completes the find and replace operation only in the specified column.
7. In the Change to field, type the new value that you want to replace the original value.
8. If you want to save the transformation, select the Save transformation check box and type a name for
the transformation.
After a data transformation is saved, it can be accessed for editing or deletion. Saved data
transformations can also be scheduled to run at predefined times through the Scheduler module.
9. Click OK.

Results
For each row where the Look in column cell value equals the Find value, the corresponding cell in the
Make change in column contains the Change to value.

Managing saved transformations

®
In the IBM Incentive Compensation Management, you can view, edit, or delete any saved data
transformations. Data transformations are created in Composer and can be scheduled in the Scheduler
module.

Procedure
1. Click Admin > Manage > Saved Transformations.
2. Select the transformation.
3. Click Edit or Delete.

Tables 43
Table data export
®
In IBM Incentive Compensation Management, after adding data to your table, you can export selected
rows of data to a separate file.

Exporting table data to a .csv file

®
In IBM Incentive Compensation Management, after adding data to your table, you can export selected
rows of data to a .csv file.

About this task

You can select and export a maximum of 1000 rows of data.

Procedure
1. In Composer, click the Edit icon on the table.
2. Press Shift and select the rows that you want to export.
3. Click Export to CSV.

Copying table data to the clipboard

®
In IBM Incentive Compensation Management, after adding data to your table, you can copy selected
rows of data to the clipboard.

About this task

You can copy a maximum of 300 rows of data to the clipboard.

Procedure
1. In Composer, click the Edit icon on the table.
2. Press Shift and select the rows that you want to copy to the clipboard.
3. In the toolbar, click the Copy to clipboard icon.
Tip: You can also use Ctrl + C to copy the selected rows to the clipboard.

What to do next
You can then press Ctrl + V to paste the rows into a file.

Effective dates in tables

®
In IBM Incentive Compensation Management, you can create hierarchy, custom, and structural tables
that include effective start and end dates.
Here's a quick demonstration to give you an introduction to tables with effective dates:

https://youtu.be/VFBW_vXCcQs
Multiple versions of the same record can be added to a date effective table by setting different effective
start and end dates for each record. Incentive Compensation Management maintains the start and end
dates for all records as changes occur to the data over time. For example, you can change the job code for
an employee on February 1, 2015 and both job codes for the employee can exist in the table with
different start and end dates.
Records are viewed as of a defined date that is known as the effective date. A user's selected effective
date must fall between a record's start and end dates.

44 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 If a table with effective dates contains a column that pick lists to another table with effective dates, the
records that are available to pick from in the list are based on the selected effective date. If a value in the
pick listed table does not exist for the selected effective date, it is not displayed in the list.
Tables with effective dates cannot be modified through the web client.

Adding tables with effective dates

®
In IBM Incentive Compensation Management, you can add effective dates to records in Hierarchy,
Custom, and Structural tables.

About this task

The effective start date is automatically added with the user-identified columns as part of the table's
primary key.
Here's a quick demonstration to show you how to add a table with effective dates:

https://youtu.be/OIiLmp92ZZY

Procedure
1. In Composer, add a hierarchy, custom, or structural table.
2. Type a name for the table and click Save.
3. Select the Effective dated check box.

Results
An Effective start column and an Effective end column are automatically added to the table.

Converting tables to effective dated tables

®
In IBM Incentive Compensation Management, you can convert any hierarchy, custom, or structural table
to a table with effective dates.

About this task

Two effective date columns, Effective_Start and Effective_End, are added to a table when it is converted.
You can convert a table by using existing date columns as the effective start and effective end dates. The
values in the start date column must be earlier than the values in the end date column. The process of
converting a table to an effective dated table cannot be reversed. If a table pick lists from a parent table,
the table must be converted before the parent table can be converted.
Tables cannot be converted if they are used in the following ways:
• Row form source in Presenter reports
• Data source for data grids with editable columns in Presenter
• Row forms or admin forms in web forms
• Web form sources with editable columns
• Editable through the web client
• Saved transformations
• Main sources in unions in data stores and calculations

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Make Effective Dated.

Tables 45
 4. For existing tables that have manually created Start and End dates, you must map the existing
effective dated column names of the newly created Effective_Start and Effective_End dates.
Complete the following steps:
Note: For existing tables that do not have manually created Start and End dates (for example, all
structural tables), skip to the next step.
a) Select the date column that you want to use as the Effective_Start date for the table.
b) Select the date column that you want to use as the Effective_End date for the table.
c) Verify that the Remove Mapped Columns check box is selected. This check box must be selected
for all tables that have existing dates that are being mapped to newly created Effective_Start and
Effective_End dates.
5. Click Finish.

Results
The Audit log displays an event record that indicates that the table was successfully converted to a table
with effective dates. If a column is removed during the conversion, an event is displayed in the Audit log.

Viewing data in tables with effective dates

®
In IBM Incentive Compensation Management, you can view data in an effective dated table as of a
defined date.

About this task

When you first open a table, the effective date that is selected is based on the Locked Through date in the
calendar. The effective date defaults to the first calendar day after the latest Locked Through date. When
you open a table and set a new effective date, the application saves the effective date to be used across
all tables for your individual session.
Here's a quick demonstration on viewing data in tables with effective dates:

https://youtu.be/sikVzkHn3Z8

Procedure
1. In Composer, click the Edit icon on the effective dated table.
2. In the toolbar, click the View All icon to activate the date selection field.
3. In the date selection field, select an effective date by which to filter data.

Results
Data that is valid on the selected date is displayed.

Viewing multiple versions of data in tables with effective dates

®
In IBM Incentive Compensation Management, you can view all versions of a record in an effective dated
table.

Procedure
1. In Composer, click the Edit icon on the effective dated table.
2. Select the effective date.
3. Select the record for which you want to view all versions.
4. In the toolbar, click the Version icon.

46 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Adding versions of records to tables with effective dates
®
In IBM Incentive Compensation Management, you can add multiple records that are the same but have
different start and end dates. The application ensures that each version does not overlap with another
version of the same record.

About this task

When a record is added, Incentive Compensation Management matches the start date of the record with
the effective date that you selected. The application also checks to see if future versions of the same
record exist. If so, the application displays those records for you.
If you click View All, all the records in the table are displayed.

Procedure
1. In Composer, click the Edit icon on the effective dated table.
2. In the toolbar, click the View All icon to activate the date selection field.
3. In the date selection field, select the new effective start date for the record.
4. Select the record in the table that you want to edit.
5. Click the Edit icon.
6. Make the necessary changes to the available columns.
These values must be different from previous values or no changes are made to the record and no
records are added.
7. Click Submit.
The application automatically adds the new version of the record and updates the previous version's
effective end date.
8. If you change a record in which edits to that record occur with a future effective date, in the Manage
Future Versions window, you must select one of the following options:
Option Description

Overwrite Overwrites all future versions of the record that exists.

Keep Adds this version to existing future versions of the record.

9. You can continue to add new versions of the record by selecting a new effective start date, entering
new values on the Row editor tab, and clicking Submit.

Adding end dates to records in tables with effective dates

®
In IBM Incentive Compensation Management, you can select a date on which the record is no longer
effective.

About this task

The effective end date is the date on which you want the record to no longer be effective. The effective
end date is set to one day before the date that is selected in the Effective Date field.

Procedure
1. In Composer, click the Edit icon on the effective dated table.
2. Select the effective date.
3. Click the effective end date field of the record to which you want to add an effective end date.
4. Click Yes.

Tables 47
 Results
The application refreshes the window and displays that the record's effective end date was updated.

Deleting multiple versions of records in tables with effective dates

®
In IBM Incentive Compensation Management, you can remove one or more versions of a record in a table
with effective dates.

About this task

If you remove a single version of a record, a gap in time for the record might occur. If a gap occurs, the
effective dates of other records can be adjusted to fill the gap.

Procedure
1. In Composer, click the Edit icon on the effective dated table.
2. Select the effective date.
3. Select the record for which you want to view all versions.
4. In the toolbar, click the Version icon.
5. Select the version of the record that you want to remove and click Delete.
6. If a gap in time occurs because of the record deletion, you must choose one of the following options to
fill the gap:
Option Description
From Past The previous version is effective for the deleted time frame.
From Future The future version is effective for the deleted time frame.
None No changes are made to the effective dates of the existing versions.

Table history
®
You can choose to enable or disable the recording of history for tables in IBM Incentive Compensation
Management. You can also clear the history that is collected for tables to improve the performance of your
model.
When you add a data, custom, or structural table, a corresponding history table is also added. The
purpose of history tables is to track any insertions, updates, and deletions of data into the tables.
Administrators can grant users permission to purge the history of tables, and they can also enable or
disable the recording of history for tables. If tables are recording history in Incentive Compensation
Management, and you have the appropriate permission, you can clear the history for tables from the
Composer module or schedule the clearing of history for tables in the Scheduler module.

Disabling table history collection

®
By default, changes to tables are logged in IBM Incentive Compensation Management, and history for all
tables is recorded. You can choose to disable the collection of history for tables in the Composer module.

Procedure
1. Click Admin > Manage > History Tracking.
2. Clear the check boxes next to the tables for which you want to disable history tracking.
3. Click Save.

48 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Disabling table history collection for all future tables
®
By default, changes to tables are logged in IBM Incentive Compensation Management, and history for all
tables is recorded. Administrators can enable or disable the logging of changes to tables.

Procedure
1. Click Admin > Manage > History Tracking.
2. To disable the collection of history for all future tables that are created in Composer, clear the Trace
history for new tables check box.
3. Click Save.

Purging history for multiple tables

®
In IBM Incentive Compensation Management, you can clear the history for specified tables, including
data from any locked periods.

Procedure
1. In Composer, from the toolbar, click Purge History.
2. Select the table or tables whose history you want to remove.
3. Select a date range for the history that you want to purge.
4. Click OK.

Purging history for a single table

®
You can delete the recorded history of a table in IBM Incentive Compensation Management.

About this task

If you want to purge the history of a data table, you must specify a date range. Only items that fall in the
data range selected are removed. Administrators must grant users permission to purge history.

Procedure
1. In Composer, click the table whose history you want to purge.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Data > Purge History.
4. If you selected a data table, select a date range for which to purge history.

Web data
®
In IBM Incentive Compensation Management, you can enable specified tables for review and edit
through the web client.
Tables with effective dates cannot be modified through the web client.
Imagine an instance where data imported from a source system is incomplete or contains errors. To
correct missing or incorrect data, tables can be enabled for web review and certain columns can be made
editable. Specified users can then log in to the web client and edit the erroneous table data.
For example, a compensation plan might require managers to supply weekly performance ratings for their
subordinates. Managers can submit these metrics through the Data Edit tab on the web client. For more
information on the web client, see the IBM Incentive Compensation Management Web Client User Guide.

Tables 49
Defining accessible information for the web client
®
In IBM Incentive Compensation Management, you can define the table columns that are accessible to
specified users through the web client.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Web data edit > Edit column permissions.
4. Next to each web user, select the columns that you want to make editable for that user.
Important: After a table is enabled for web review, you cannot restrict which columns are available for
review. All columns are displayed.
5. To enable an entire group of payees to be able to edit a particular column, perform the following steps:
For example, you might want all payees with the job title Sales Manager to be able to edit the Quota
column of the selected table.
a) Click Enable Group.
b) Select a source or sources that can be used to define the payee group.
c) On the Restrictions tab, define your restrictions based on that source.
For example, if you want only account executives to be able to edit certain columns, then drag Title
to the pane and make it equal to Account Executive.
d) On the Select Columns tab, define the columns that you want to make editable.
After you set your restrictions, every payee in your defined group can edit the specified columns.
6. Click Finish.

Restricting visible rows for tables on the web client

®
In IBM Incentive Compensation Management, you can restrict the table rows that are displayed on the
web client.

About this task

For example, you might want to make sure that payees can view and edit only their own information. In
this case, you can restrict results to a subset of all data in a particular table.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Web data edit > View Restrictions.
4. Define the parameters of your restrictions.
5. Click OK.

50 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Enabling direct editing on the web client
®
In IBM Incentive Compensation Management, if you enable direct editing for a table, users can make
changes to the table through the web client without administrator approval.

About this task

All users with web access to the selected table can edit column information without requiring approval.
Typically, all edits that are made in the web client must be approved by an administrator before the
change can be stored permanently in the database.
Enable direct editing with caution. If it is not enabled, administrators can approve each edit individually,
or approve all edits at once.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Web data edit > Direct Edit.

Approving web data edits

®
In IBM Incentive Compensation Management, after web users have submitted changes to tables,
administrators can approve or reject those changes through Composer. If the table name is in bold
letters, edits must be reviewed by an administrator.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Web data edit > Approve /Reject Edits to see a list of changes that have been made.
4. Click Approve to commit those changes to the table.
Important: Period locking will not be permitted if there are pending edits that affect the period. This
prevents any changes from being made to data in locked periods. If you must lock Month 1, all pending
data edits for Month 1 must first be approved.

Tables 51
52 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 8. Input forms
®
Use input forms in IBM Incentive Compensation Management to control the tables and table fields that
are viewable and editable by particular administrators.
Often there are situations when someone must be able to edit specific information in a certain table, but it
would not be prudent to grant that person complete access to every table. To ensure data integrity, it is
important that data changes can only be made by authorized users. By adding an input form, you can not
only define what table is editable, you can also select which table fields to display and what type of data
can be entered in editable fields.
Important: After changes are made through an input form, they are applied directly and immediately to
the table.

Adding input forms

®
In IBM Incentive Compensation Management, you can define what tables and table fields are viewable
and editable to users by adding an input form to the table in Composer.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Input forms > Add Input Form from the menu.
4. Type a name for the input form and click Save.
5. Select the check boxes next to the columns that you want to be viewable and editable to users.
Tip: The primary key fields must be selected.
6. Select the Default values check box to set the default value that you want to use in the displayed field.
7. Select the Read only check box next to the column to mark individual columns as read-only.
8. Click the Options icon to configure reference column options by completing the following steps:
a) To add a tab in the input form based on a reference column in the table, select the Tab check box,
click the Edit icon, and type a name for the tab. A tab cannot have an empty name.
b) Leave the Jump to check box selected to enable the Jump To feature for reference columns.
c) Click OK.
9. To change the display name of a column, click the Edit icon next to the column and type a new name.
10.Click Next.
11.Define any restrictions.
Important: Restrictions can be used as static filters.
12.Click Save.

Viewing input forms

®
After an input form is added in IBM Incentive Compensation Management, the administrators with
appropriate access can view the input form.

Procedure
1. In Composer, click the table.

© Copyright IBM Corp. 2005, 2018 53

 A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select View/Edit Data from the menu.
4. Select the input form you want to view.

Input form security

®
In IBM Incentive Compensation Management, you can give specific users permission to view input forms
and create validation rules for data submitted through input forms.

Assigning users to the input form role

®
After you add a role for an input form in IBM Incentive Compensation Management, you must assign
specific users to that role so that they can have input form permissions.

Before you begin

Before you can assign a user to an input form role, you must first create the user and role.

Procedure
1. Click Admin > User and Permissions > Change Roles.
2. Place your cursor over the name of the user whom you want to assign the input form role and click the
Edit icon.
3. From the Role drop-down list, select the input form role that you created previously.
4. Click OK.

Adding input form validation rules

®
After you add an input form in IBM Incentive Compensation Management, you can define validation rules
to make sure that data in a particular field is valid. These rules are applied to specified columns and can
be number or text-based.

Procedure
1. In Composer, click the table that contains the input form.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Input forms > Edit Validation Rules.
4. Click Add Numeric Formula or Add Text Formula for the validation rule type.
Important: Additional sources cannot be joined to the table to add a validation rule.
5. If you selected Add Numeric Formula, complete the following steps:
a) In the Rule Name field, type a rule name.
b) Drag the column into the formula box.
c) Add your formula.
For example, drag the Product Quota column into the formula box, click > = and type 0.
d) In the Error Message field, type an invalid input message that is displayed to the user when the
rule is violated.
For example, if you selected a numeric rule type, then the rule might be called Greater than or
equal to zero and the invalid input message would be Value must be greater than or
equal to zero.
e) Click Save.

54 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 6. If you selected Add Text Formula, complete the following steps:
a) In the Rule Name field, type a rule name.
b) In the Error Message field, type an invalid input message that is displayed to the user when the
rule is violated.
c) From the Column drop-down list, select the column that you want to add a regular expression for.
d) Type a regular expression.
Important: Regular expressions are used for text-based rule validation to make sure that data that
is entered a particular field is valid.
e) Type sample text.
f) Click Test to test your regular expression.
A message that states: The sample is a match to your regular expression indicates
that you used the correct expression.
g) Click Save.

Submission change through an input form

®
IBM Incentive Compensation Management administrators with appropriate access can add data or make
changes to the specified fields in input forms. When a change is made through the input form, it is applied
directly to the table.

Adding new rows to input forms

®
In IBM Incentive Compensation Management, you can add a new row to an input form.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select View/Edit Data, and select the input form.
4. Click the Add icon.
5. Enter the data in the fields.
6. Click Create.

Importing data into input forms

®
In IBM Incentive Compensation Management, you can import data from a file into an input form while
viewing table data.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select View/Edit Data, and select the input form.
4. In the toolbar, click Import.
5. Follow the steps to import data from a file.

Input forms 55
Editing rows in input forms
®
In IBM Incentive Compensation Management, you can edit a row in an input form by selecting the cell
containing the data and making the changes directly in the table, or you can use the Row editor.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select View/Edit Data, and select the input form.
4. Select the row that you want to edit.
5. Click the Edit icon.
6. Edit the data in the fields and click Submit.

What to do next
Click Next or Previous to edit the row after or before the selected row.

56 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 9. Data imports
®
In IBM Incentive Compensation Management, you can import data into any hierarchy, system, data,
custom, or structural table from a file or third party application.
Data can be imported from your computer or from ICM on cloud storage. Files that are imported from your
computer with the Save this import as check box selected are saved to ICM on cloud storage. You can
also use the CLI import tool to save import files to ICM on cloud storage.

Data import types

®
In IBM Incentive Compensation Management, you can import data into any hierarchy, system, data,
custom, or structural table from files stored on your computer, from files stored on the Incentive
Compensation Management cloud, or from third-party applications like Salesforce.com.
The following types of files can be imported from your computer to Incentive Compensation Management:
• text files
• Microsoft Excel files
• XML files
The following types of files can be imported from the Incentive Compensation Management cloud or third
party applications:
• text files
• Microsoft Excel files
• database import
• Salesforce.com
• XML files
®
The IBM Incentive Compensation Management CLI import tool is used to import or overwrite saved
import files that are stored on the cloud.
Text or Microsoft Excel files are the easiest sources to use when you build your model. A direct link to
existing databases saves time after you define the layout of your model.

Importing data from text files

®
In IBM Incentive Compensation Management, you can import data into tables from text files.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Import.
3. Select one of the following import types:
Import type Description
Import data from external Select this option if your import file is located on your computer.
source
Import data from ICM Select this option to import a file that is stored on ICM cloud or from
storage another application, such as Salesforce.com.
4. Select Text File and click Next.
5. Click Browse and select the file that you want to import.

© Copyright IBM Corp. 2005, 2018 57

 6. Select the language of the file that you are importing.
The date and numeric format of the values in the imported file are based on the language selected.
7. Select the The first record is a header check box if the first row of your text file contains labels for
each column.
This indicates that the first row should not be processed as data, as it is a label for each column.
8. Select the delimiter from the Delimiter drop-down list.
When importing from a text file, you can choose a special character to import fields that contain a
delimiter. You can choose from the following five delimiters: comma, tab, vertical pipe (|), semicolon,
and period. This is useful if you have data that contains a comma but is importing from a comma
delimited file. Without some sort of special character, there would be no way to import a field
containing a comma from that kind of file.
9. To save the import to ICM storage, select the Save this import as check box and name the import.
Saving the import allows you to run the import at a later time using Scheduler. If this option is not
selected, the file is not saved to ICM storage.
10.Click Next.
11.From the Columns drop-down lists, select the columns in the import file that match the table columns.
Tip: Click Automatch to have the application map identical column names automatically.
12.Click Next.
13.Select any or all of the following run options:
Run option Description
Add new members as Indicates that new members should be added.
needed
Update existing rows Indicates that existing rows of data should be updated with data
contained in the imported rows.
Run this import now Indicates that the import should be run immediately. Clear this check box
if you want to save the current import and process it at a later date.
Use incremental import Indicates that rows should be imported into the database in smaller
batches instead of committing the entire import in one batch. Use this
option to process database calls, such as report generation in the web
client, during a large data import.
14.Click Done.

Importing data from Microsoft Excel files

®
In IBM Incentive Compensation Management, you can import data into tables from Microsoft Excel files.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Import.
3. Select one of the following import types:
Import type Description

Import data from Select this option if your import file is located on your computer.
external source
Note: The Excel file can be no larger than 2MB. To import Excel files larger
than 2MB, use the CLI import tool.

Import data from ICM Select this option to import a file that is stored on ICM cloud or from another
storage application, such as Salesforce.com.

58 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 4. Select Microsoft Excel and click Next.
5. Select the file to import and click Next.
6. Select the language of the file that you are importing.
The date and numeric format of the values in the imported file are based on the language selected.
7. If the first row of your Microsoft Excel file contains labels for each column, select the The first record
is a header check box.
8. Select the worksheet you want to import.
9. To save the import to ICM storage, select the Save this import as check box and name the import.
Saving the import allows you to run the import at a later time using Scheduler. If this option is not
selected, the file is not saved to ICM storage.
10.Click Next.
11.From the Columns drop-down lists, select the columns in the import file that match the table columns.
Tip: Click Automatch to have the application map identical column names automatically.
12.Click Next.
13.Select any or all of the following run options:
Run option Description
Add new members as Indicates that new members should be added.
needed
Update existing rows Indicates that existing rows of data should be updated with data
contained in the imported rows.
Run this import now Indicates that the import should be run immediately. Clear this check box
if you want to save the current import and process it at a later date.
Use incremental import Indicates that rows should be imported into the database in smaller
batches instead of committing the entire import in one batch. Use this
option to process database calls, such as report generation in the web
client, during a large data import.
14.Click Done.

Importing data from XML files

®
In IBM Incentive Compensation Management, data stored in XML format can be imported into tables in
Composer.

About this task

The XML file should contain nodes that represent rows. These nodes should be nested at the same level
for each row. The columns of the row are expected to be the children of the row node. If a row does not
have a child that another row has, the value for it will be empty.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Import.
3. Select one of the following import types:
Import type Description
Import data from external Select this option if your import file is located on your computer.
source
Import data from ICM Select this option to duplicate a file that has already been imported or
storage from another application, such as Salesforce.com.

Data imports 59
 4. Select XML File and click Next.
5. Click Browse to select the file to import.
6. Select the language of the file that you are importing.
The date and numeric format of the values in the imported file are based on the language selected.
7. Select the row node to import data from.
8. Click Preview to make sure the data you have selected is correct.
9. To save the import to ICM storage, select the Save this import as check box and name the import.
Saving the import allows you to run the import at a later time using Scheduler. If this option is not
selected, the file is not saved to ICM storage.
10.Click Next.
11.Select any or all of the following run options:
Run option Description
Add new members as Indicates that new members should be added.
needed
Update existing rows Indicates that existing rows of data should be updated with data
contained in the imported rows.
Run this import now Indicates that the import should be run immediately. Clear this check box
if you want to save the current import and process it at a later date.
Use Incremental Import Indicates that rows should be imported into the database in smaller
batches instead of committing the entire import in one batch. Use this
option to process database calls, such as report generation in the web
client, during a large data import.
12.Click Done.

Importing data from database files

®
In IBM Incentive Compensation Management, you can import data into tables from database files.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Import.
3. Select Import data from ICM storage.
4. Select Database Import and click Next.
5. To use a Microsoft Text Driver, select the Use Microsoft Text Driver check box and select a file to
import.
6. Click Configure.
7. Type a SQL statement.
8. If the first row of your file contains labels for each column, select the The first record is a header
check box.
9. To save the import to ICM storage, select the Save this import as check box and name the import.
Saving the import allows you to run the import at a later time using Scheduler. If this option is not
selected, the file is not saved to ICM storage.
10.Click Next.
11.Click Preview to display the first 1000 rows of your selected data.

60 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Importing data from Salesforce.com
®
In IBM Incentive Compensation Management, you can import data from Salesforce.com into your tables.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Import.
3. Select Import data from ICM storage.
4. Select Salesforce.com and click Next.
5. Type your Salesforce.com user name, password, and security token.
Important: You must be set up with an administrator profile in Salesforce.com to import data.
6. Select the table and columns that you want to import.
The menu lists all of the Salesforce.com tables that you have access to. The tables include all the
default Salesforce.com columns, as well as any custom fields you have added.
7. To add custom columns to import from the selected table, complete the following steps:
a) Select the Enable Custom Columns check box.
b) Click Add.
c) Type the name of the column from the table you want to import and click OK.
8. Click Preview to view the contents of the Salesforce.com table prior to running the import.
Use the Preview feature to see exactly what your Salesforce.com data looks like before you import.
Previewing data also eliminates guesswork if you are unsure of the name of the Salesforce.com table
that contains the import data you need.
9. Click Next.
10.Drag the table fields in the Data Fields column to the Mapping column next to the matching import
column name.
Tip: Click Automatch to have the application map identical column names automatically.
11.Click Next.
12.Select any or all of the following run options:
Run option Description
Update existing rows Indicates that existing rows of data should be updated with data contained
in the imported rows.
Run this import now Indicates that the import should be run immediately. Clear this check box if
you want to save the current import and process it at a later date.
Use Incremental Indicates that rows should be imported into the database in smaller batches
Import instead of committing the entire import in one batch. Use this option to
process database calls, such as report generation in the web client, during a
large data import.
13.Click Done.

Adding sub-items
®
In IBM Incentive Compensation Management, when importing data from a file, you can create new fields
from existing columns. Sub-items are a segment of the data in an existing column.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.

Data imports 61
 2. Click Import.
3. Import data from a file.
4. When mapping the import file columns to the table columns, from the Data Fields drop-down list,
select Create Field.
5. From the Selected Field drop-down list, select the column that you want to create sub-items from.
6. In the New Field Name field, type a name for the sub-item.
7. To add a sub-item, select one of the following options:
Option Description
Create a sub-item by Select this option to type the number of characters in the field to include.
selecting characters to For example, type 1-5 if you want to include the first five characters of the
include field.
Use the following Select this option to type a delimiter and select the index to create a sub-
delimiter to create a item. For example, if you have a Name field that contains first and last
sub-item for this field names separated by a space (for example, Dan Huddle) and you want to
add a First Name field, you would type a space as the delimiter and select
an Index of 1 since the first name is the first item before the delimiter.

Tip: You can confirm if your selection is correct by looking at the example.

8. Click Add.

62 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Merging fields
®
In IBM Incentive Compensation Management, when importing data from a file, you can combine two
columns in your data source into one column. For example, if you have a month and a year field, you can
merge the two and create one date field.

Procedure
1. In Composer, click the table.
A menu for the table displays on the right side of the window.
2. Click Import.
3. Import data from a file.
4. When mapping the import file columns to the table columns, from the Data Fields drop-down list,
select Create Field.
5. Click the Merge Fields tab.
6. Type a name for the new column.
7. Select at least two data fields to merge.
8. Type a delimiter. The delimiter is placed between the merged fields.
Tip: You can confirm if your selection is correct by looking at the example.

9. Click Add.

Data imports 63
Changing the import escape character
®
In IBM Incentive Compensation Management, update the import escape character for import files that
contain a delimiter before running imports.

About this task

The following import escape characters are available: (/ \ * " ^ '). For example, if you choose a quotation
mark as the import escape character, Payee, Date, Value from a comma delimited file would import
as "First Name, Last Name", 1/1/2009, 50.
Important: By default, the import escape character is a quotation mark. This setting is a global setting for
all imports. Make sure that your data does not contain the import escape character that you specify;
otherwise, your import will fail.

Procedure
1. Click Admin > More Options.
2. On the General tab, in the Import Escape Character field, type the import escape character in your
files.
3. Click Save.

Effective date table imports

®
When you import data into tables with effective dates in IBM Incentive Compensation Management, you
must map the effective date columns to the appropriate date columns in the import.
Optionally, you can click Defaults to select a default effective start date and a default effective end date
to use for all imported records.
The effective start date is a key column so it must be mapped to a date field in the import file or set to a
default date. The values cannot be empty or null.
The effective end date is not a key column so it does not have to be mapped. If the effective end date is
unmapped, imported records have a date of 12/31/9998.
Imported effective start and effective end values must follow the rules of effective dating. That is, the
dates must be between 1/1/1753 and 12/31/9998 and the effective start date must be the same day or
earlier than the effective end date. The import file cannot contain multiple records with matching keys and
overlapping effective dates.
The effective start date and effective end date mapping can be modified when editing a saved import.

Importing files containing replacement characters

®
You can choose to import files containing replacement characters into IBM Incentive Compensation
Management.

About this task

If you cannot resolve the replacement characters in your import file, then you can enable the Import
Block Bad Characters option in Incentive Compensation Management. The replacement characters,

which are usually indicated by a question mark inside a black diamond , are replaced with a regular
question mark after they are imported into Incentive Compensation Management.

Procedure
1. Click Admin > More Options.
2. On the General tab, select the Import Block Bad Characters check box.

64 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 3. Click Save.

Track import progress in the Activity module

®
After you finish importing data in IBM Incentive Compensation Management, the Activity module opens
and tracks the progress of the data import into the table.
If the import ran successfully, you can see a message indicating that the data import was successful in the
Activity module. You can then review the imported data in Composer by viewing the table data.
After a successful import, the selected table contains records that correspond to the source file. If the
import was unsuccessful, an error message is displayed in the Activity module and also in the Audit log.

Refreshing table data

®
In IBM Incentive Compensation Management, in Composer, you can refresh the table after importing
data.

Procedure
1. In Composer, click the table.
2. In the context menu that displays on the right, click Refresh.

Data from IBM Cognos Territory and Quota Management

® ®
Assignment detail reports created in IBM Cognos Territory and Quota Management can be imported and
®
used as sources in calculations and reports in IBM Incentive Compensation Management.
After you create the Cognos Territory and Quota Management object in the Incentive Compensation
Management client, you can synchronize data manually or at predetermined intervals with the Scheduler
module.

Adding IBM Cognos Territory and Quota Management objects

® ®
Add a Territory Management object to Composer to pull details of credit assignments from IBM Cognos
®
Territory and Quota Management into IBM Incentive Compensation Management.

Procedure
1. In Composer, drag the Territory Management object from the Palette tab onto the Composer
window.
2. In the Sync with Territory Management window, type valid Cognos Territory and Quota Management
login credentials and click OK.
3. Select the detail report that you want to link to Incentive Compensation Management and type a name.

Data imports 65
 Option Description
Name of Territory This is the display name for the Cognos Territory and Quota Management
Management table object in Incentive Compensation Management. The name cannot contain
any spaces.
Choose a report This is the assignment detail report that you are importing.
Column Name Preview You can change the column types of the report that you are importing. A
text column can be changed to a date or numeric column. A date column
can be changed to a text column. A numeric column can be changed to a
text column.

Results
The Incentive Compensation Management application creates a table with columns that are identical to
the assignment report.

IBM Cognos Territory and Quota Management data synchronization

After you add the Territory Management object to your model, you can synchronize data from Cognos
®
Territory and Quota Management with the data in the IBM Incentive Compensation Management client at
any time.
You can synchronize data manually through Composer or schedule synchronizations to occur at specific
times through Scheduler.
When data is synchronized, all the data in the Territory Management object is deleted and replaced with
the current data in the Cognos Territory and Quota Management assignment report.

Loading data manually into IBM Cognos Territory and Quota Management objects
®
In IBM Incentive Compensation Management, you can load data into the Territory Management object
in Composer.

Procedure
1. In Composer, click the Territory Management object into which you want to load data.
2. Select Synchronize from the menu.

Results
The Activity module opens to display the progress of the synchronization.

Switching reports associated with IBM Cognos Territory and Quota Management objects
®
You can change the report that is associated with your Territory Management object in IBM Incentive
Compensation Management.

About this task

The original report and target report must have matching schemas.

Procedure
1. In Composer, click the Territory Management object.
2. Select Edit Territory Management Source from the menu.
3. Select the report that you want to switch to.
4. Click Import.

66 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Data from IBM Producer Lifecycle and Credential Management
®
You can import tables from IBM Producer Lifecycle and Credential Management into IBM Incentive
Compensation Management. You can then use them as sources in tables, calculations, and reports.
After a PLCM object is added to Composer, data can be synced manually or at predetermined intervals by
using the Scheduler module. Producer Lifecycle and Credential Management can be synchronized only
with Unicode Incentive Compensation Management models. When empty effective dates are imported
into Incentive Compensation Management, the date is transformed to 12/31/9998 and numeric IDs are
converted to text.
Calculations and reports cannot be made inside the PLCM object. The Producer Lifecycle and Credential
Management tables are imported as global tables. Global tables can be used as sources from within any
component in Composer.
Data and custom tables can pick list to Producer Lifecycle and Credential Management tables that have
exactly one string-type key column after synchronization.

Adding IBM Producer Lifecycle and Credential Management objects

® ®
In IBM Incentive Compensation Management, you can add IBM Producer Lifecycle and Credential
Management tables to Composer.

About this task

You can add only one PLCM object in Composer.

Procedure
1. In Composer, from the Palette tab, drag the PLCM object onto the Composer window.
2. Type the password that you use to log in to Producer Lifecycle and Credential Management.
3. Click Login.

IBM Producer Lifecycle and Credential Management data synchronization

After you add a PLCM object to your model, you can synchronize data from Producer Lifecycle and
®
Credential Management with the data in the IBM Incentive Compensation Management client at any
time.
You can synchronize data manually through Composer or schedule synchronizations to occur at specific
times through Scheduler.
When you run a data synchronization, the tables from Producer Lifecycle and Credential Management are
imported into the PLCM object as global tables. Global tables can be used as sources within any
component in Composer.
Data can be synchronized with Unicode Incentive Compensation Management models only. When data is
synchronized, all the data in the PLCM object is deleted and replaced with the current data in the
Producer Lifecycle and Credential Management application.

Loading IBM Producer Lifecycle and Credential Management data into an object manually
®
In IBM Incentive Compensation Management, you can load data into a PLCM object through Composer.

Procedure
1. In Composer, click the PLCM object.
2. Select Synchronize PLCM from the menu.

Results
The Activity module displays the progress of the synchronization.

Data imports 67
Managing saved imports
®
In IBM Incentive Compensation Management, you can delete saved or local imports or edit details of the
import. For example, you can delete the name of the import, the data source, the destination table, or
column mapping.

Procedure
1. Click Admin > Manage > Saved Imports.
2. Place your cursor over the import and click the ellipsis.
3. Click Edit, Delete, or Run.

68 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 10. Calculation creation
®
In IBM Incentive Compensation Management, the process of transforming your company's data into
compensation results begins with calculations.
Calculations enable the model administrator to select records from the source data, complete operations
on the data, segment the results, and begin another calculations based on those results.
When the Calculation Wizard is first launched, you are prompted to select a calculation type. Incentive
Compensation Management offers a selection of many different types of calculations. User-defined
calculations are the most common because they offer complete flexibility when you select data sources,
define mathematical formulas, and partition results.
The calculation engine can create highly complex, multi-step calculations that can accommodate any
compensation plan or analytical calculation requirements. Calculation templates make it easier to set up
certain common calculations.

Calculation types
®
You can use several kinds of calculations in IBM Incentive Compensation Management to create
compensation results.

Table 11: Calculation types

Calculation Type Description
User-Defined If the standard templates do not address the complexity of your compensation
calculations in a single step, select this type of calculation. Administrators can use
multiple data sources and custom formulas in user-defined calculations.
Sort This is a custom-defined sort calculation. You can use this more flexible and
powerful interface to select top performers or to identify areas for improvement.
Time Shift This calculation type is used to shift results across time periods. It is useful for
examining results from previous periods.
Category This calculation type is used to evaluate each row of a source against an unlimited
series of restrictions. Category values are added to the rows, depending on the
restriction that applies to it. This calculation type can be used to organize records in
tables or calculations into different categories.

In the first step of the Calculation Wizard, you must select the calculation type.

Adding user-defined calculations

®
In IBM Incentive Compensation Management, you can add a user-defined calculation to perform
mathematical operations on data.

Before you begin

Before you add a calculation, analyze the business requirement to determine the data that you need to
perform the calculation, the formula that you need to apply to the data, how you need to group the
results, and whether you need to exclude any data.

Procedure
1. In Composer, from the Palette tab, drag the Calculation object onto the Composer window.
2. Select User-Defined as the calculation type.
3. Type a name and description for the calculation and click Save.

© Copyright IBM Corp. 2005, 2018 69

 4. On the Data Sources tab, define the data sources for your calculation.
Tip: You can use the Search field to find a specific source.
5. On the Restrictions tab, you can perform the following actions:
• In the Restrictions pane, define any restrictions for joined sources.
• In the Global Restrictions pane, define any global restrictions for the calculation.
• Click Preview to check the calculation results with the restrictions you created.
6. On the Display Columns tab, define the partitions for the calculation.
7. On the Formulas tab, create the formula for the calculation.
8. Click Create.

Adding sort calculations

®
In IBM Incentive Compensation Management, data can be organized from lowest to highest or highest to
lowest using a sort calculation. You can also limit the number of results that are returned after the sort is
applied to produce, for example, a list of top performers.

Procedure
1. In Composer, from the Palette tab, drag the Calculation object onto the Composer window.
2. Select Sort as the calculation type.
3. Type a name and description for the calculation and click Save.
4. On the Data Sources tab, define the data sources for your calculation.
Tip: You can use the Search field to find a specific source.
5. On the Restrictions tab, you can perform the following actions:
• In the Restrictions pane, define any restrictions for joined sources.
• In the Global Restrictions pane, define any global restrictions for the calculation.
• Click Preview to check the calculation results with the restrictions you created.
6. On Sort Data tab, perform the following steps:
a) Drag a column to sort by from the Data Source pane to the Sort columns pane.
b) From the Sort drop-down list, select either Ascending or Descending.
c) In the Records per partition field, type the number of records that you want displayed per
partition.
d) From the Rank drop-down list, select the ranking option that you want.
Dense
Ranks ties in the following way: 1,2,2,3.
Sequential (default)
Does not rank ties.
Standard
Ranks any ties in the following way: 1,2,2,4.
7. On the Display Columns tab, define the partitions for the calculation.
For example, if you want to sort the list for each payee, drag the Payee column to the Add columns
pane.
8. Click Create.

70 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Adding time shift calculations
®
In IBM Incentive Compensation Management, you can add a calculation that offsets the results of
another calculation by a specified number of time periods. This approach is helpful to compare results
from a previous period with the results from a current period.

Procedure
1. In Composer, from the Palette tab, drag the Calculation object onto the Composer window.
2. Select Time Shift as the calculation type.
3. Type a name and description for the calculation then click Save.
4. Drag the calculation that you want to time shift onto the Main Data Sources pane.
5. In the Number of time periods to shift field, select the number of time periods to shift the calculation.
6. To specify a starting date for the calculation, select the Start Date check box and specify the date.

7. To specify an ending date for the calculation, select the End Date check box and specify the date.
8. Click Create.

Adding a category calculation

®
In IBM Incentive Compensation Management, you can use the Category calculation type to separate
large volumes of transactional data into different groups.

Procedure
1. In Composer, from the Palette tab, drag the Calculation object onto the Composer window.
2. Select Category as the calculation type.
3. Type a name and description for the calculation and click Save.
4. On the Data Sources tab, define the data sources for your calculation.
Tip: You can use the Search field to find a specific source.

Calculation creation 71
 5. On the Restrictions tab, you can perform the following actions:
• In the Restrictions pane, define any restrictions for joined sources.
• In the Global Restrictions pane, define any global restrictions for the calculation.
• Click Preview to check the calculation results with the restrictions you created.
6. If you selected a calculation with a time partition as the source, on the Period tab, you must define the
start and end dates of the calculation.
7. On the Categories tab, click Add a category.
8. Click the Edit icon and type a name for the new category.
9. You can define a set of restrictions for the category.
Important: If a category has no restrictions, every row that does not fall into a higher ordered category
is placed in the category with no restrictions.
10.Categories and their restrictions can be imported from Microsoft Excel or imported from a text file by
clicking Import.
11.To change the order of the categories, select a category and drag it to the position you want on the list.
Note: The order of the categories is important. If a row falls into two categories, it is categorized by
whichever category is higher on the list.
12.You can export all categories and their restrictions to a Microsoft Excel or text file by clicking Export
and completing the following steps:
a) Select Microsoft Excel or Text as the file type that you want to export.
b) If you selected Text, click Next, and select the delimiter.
c) Click Export.

Results
When you view current values or preview the category calculation, rows that do not fall into any category
are not displayed in the results.

Importing categories from text files

®
In IBM Incentive Compensation Management, you can import categories from a text file into your
category calculation.

About this task

Before you use a text file to import or export, you must change the default Import Escape Character from
a quotation mark to another symbol that is not used in your category restrictions, such as a tilde (~).

Procedure
1. In Composer, create or edit a category calculation.
2. On the Categories tab, click Import.
3. On the Text tab, click Browse and select the text file to import.
4. Select the language of the file that you are importing.
The date and numeric format of the values in the imported file are based on the language selected.
5. If the first row of the file contains a header, select The first record is a header check box.
6. From the Delimiter drop-down list, select the import escape character used in the file.
7. If you want the selected categories to replace existing ones, select the Overwrite existing categories
check box.
8. Click Import.

72 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Importing categories from Microsoft Excel files
®
In IBM Incentive Compensation Management, you can import categories from a Microsoft Excel file into
your category calculation.

About this task

If you are using Microsoft Excel 2003, you cannot import from a Microsoft Excel file with a cell that
contains more than 255 characters.

Procedure
1. In Composer, create or edit a category calculation.
2. On the Categories tab, click Import.
3. On the Excel tab, click Browse and select the Excel file to import.
4. Select the language of the file that you are importing.
The date and numeric format of the values in the imported file are based on the language selected.
5. If the first row of the file contains a header, select The first record is a header check box.
6. Select the worksheet from the menu.
7. If you want the selected categories to replace existing ones, select the Overwrite existing categories
check box.
8. Click Import.

Creating a calculation with a left outer join

®
When you join sources by columns in IBM Incentive Compensation Management, you can use the Anchor
feature to display rows for all records for the first data source even if the join does not find matching
records in the second data source.

About this task

Here's a quick demonstration on creating an outer join in a calculation:

https://youtu.be/Hhng9aMhv1A

Procedure
1. Add a user-defined, sort, or category calculation.
2. On the Data Sources tab, add an initial source.
3. Add a second source.
Important: If you have many joined sources, at least one join restriction is required to add a left outer
join.

4. Click the anchor next to the first source.

5. On the Restrictions tab, create restrictions for the join.
Important: If you have many joined sources, at least one join restriction is required to add a left join.
6. On the Display Columns tab, drag columns from the Data Source pane to the Define Partitions pane
of the window to define the partitions.
7. On the Formulas tab, create the formula for the calculation.
Tip: As the application does not know what value to use in a left outer join if a null value is present, you
must use a function similar to the following example when stating which value to aggregate:
If(IsEmpty(Value2),0,Value2)
This formula forces null values to have a value of zero instead, which makes it possible to use the null
value in a formula.

Calculation creation 73
Calculation results export
®
In IBM Incentive Compensation Management, after calculating results, you can export selected rows of
calculation results to a separate file.

Exporting calculation results to a .csv file

®
In IBM Incentive Compensation Management, after calculating results, you can export selected
calculation results to a .csv file.

About this task

You can select and export a maximum of 1000 rows of data.

Procedure
1. In Composer, select the calculation.
2. Click View Current Values.
3. Press Shift and select the rows that you want to export.
4. Click Export to CSV.

Copying calculation results to the clipboard

®
In IBM Incentive Compensation Management, after calculating results, you can copy selected rows of
data to the clipboard.

About this task

You can copy a maximum of 300 rows of data to the clipboard.

Procedure
1. In Composer, select the calculation.
2. Click View Current Values.
3. Press Shift and select the rows that you want to copy to the clipboard.
4. In the toolbar, click the Copy to clipboard icon.
Tip: You can also use Ctrl + C to copy the selected rows to the clipboard.

What to do next
You can then press Ctrl + V to paste the rows into a file.

Working with calculations

®
In IBM Incentive Compensation Management, you can preview calculations, view the current values,
view history, see a list of objects that use the calculation as a source, and make changes to calculations.

Editing calculations
®
In IBM Incentive Compensation Management, you can edit a calculation after it is created.

About this task

You can edit most details of a calculation, but you cannot edit the calculation type.

74 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Procedure
1. In Composer, click the Edit icon on the calculation.
2. Make the necessary changes.
3. Click Finish to save the changes.

Refreshing calculation data

®
In IBM Incentive Compensation Management, in Composer, you can refresh the calculation data after
making any changes.

Procedure
1. In Composer, click the calculation.
2. In the context menu that displays on the right, click Refresh.

Copying calculations
®
In IBM Incentive Compensation Management, you can copy a selected calculation along with the
calculations and tables that it uses or depends upon. The copied group of calculations then appears in the
new object.

Procedure
1. In Composer, select the calculation that you want to copy.
2. From the toolbar, click Copy.
3. In the component where you want to place the copied calculation, from the toolbar, click Paste.
4. In the Suffix field, type some text to add to the end of the calculation name to ensure that you do not
have two calculations with the same name and you can distinguish copied calculations from the
originals.
5. In the New Sources drop-down lists, map the old sources to the new sources.
Tip: Click Automatch to have the application map identical sources automatically.
6. Click Save.

Results
All connections (if any) stay intact. If any calculations in the selected group are locked, you can generate
new calculations, beginning with the first unlocked period and continuing until the end of the calendar.

Calculation creation 75
Previewing calculations
®
In IBM Incentive Compensation Management, you can generate results for a calculation that include any
edits that were made since the last time it was saved. You can examine the results that are generated by
your changes before you run a calculation.

About this task

Preview results are based on the current calculated results of the selected calculation's dependencies.
Upstream calculations will not be calculated as part of the preview. Therefore, results from a calculation
preview may not match actual calculation results. If a global action is running, you will not be able to
preview the results of a calculation until the global action has finished.

Procedure
1. In Composer, click the calculation.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Preview from the menu.

Running calculations from Composer

®
In IBM Incentive Compensation Management, you can run a full model calculation from Composer.

Procedure
In Composer, from the toolbar, click Calculate.

Viewing current calculation values

®
In IBM Incentive Compensation Management, you can view calculation values as of the last calculation.
This option shows results of any changes that were made since the last time the calculation was
calculated.

Procedure
1. In Composer, click the calculation.
A menu for the table displays on the right side of the window.
2. Click View Current Values.
3. You can publish the results.

Filtering calculation data

®
In IBM Incentive Compensation Management, you can filter the results of calculations while you are
previewing or viewing them.

About this task

When you preview a calculation, only the first 1000 rows are displayed. If you filter the results, only the
first 1000 rows that are displayed are filtered. To filter all the calculation results, use the View Current
Values feature.

Procedure
1. While you are previewing or viewing calculation results, click the Filter icon in the column header.
2. Set filter parameters.
You can filter results based on a range of values or by a specific value. You can choose multiple
columns to filter results by.
3. Click Apply filter.

76 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Purging calculation data
®
In IBM Incentive Compensation Management, you can clear the data from calculations that are
associated with a period in a specific calendar. Data in calculations is removed up to and including the
selected period.

About this task

Rows that have a partition at or before the selected period are removed. The periods must be locked
before you purge calculation data or the purged records will be added the next time that the model is
calculated. This action includes any locked data but does not include data in history tables.
Attention: Purging periods is a global action that cannot be undone. You must have the
appropriate permission to complete this action. This action is irreversible.

Procedure
1. In Composer, from the toolbar, click Purge Periods.
2. Select the calendar.
3. Select the level of the calendar.
4. Select the period. Data that is associated with all periods up to and including the selected period will
be cleared.
5. From the Mode menu, select Calculations Only.
6. Click Purge Periods.

Viewing calculation history

®
Each time that a calculation is edited, IBM Incentive Compensation Management records the name of the
user who changed the calculation, the date and time that the calculation was edited, and the type of
change that was made.

About this task

The data is recorded in the calculation history viewer. Calculation history changes are recorded regardless
of whether the calculation is locked.

Procedure
1. In Composer, click the calculation.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select View History.
4. To view the details of the calculation at the time the change was made, select the row entry of a
version of the calculation and click the View Details icon.

Viewing sources that use the calculation

®
In IBM Incentive Compensation Management, you can view the objects that use the calculation as a
source.

Procedure
1. In Composer, click the calculation.
A menu for the table displays on the right side of the window.
2. Click Show More.
3. Select Used By from the menu.

Calculation creation 77
Viewing sources that the calculation uses
®
In IBM Incentive Compensation Management, you can view the sources that the calculation uses.

Procedure
1. In Composer, select the calculation.

2. In the toolbar, click the Uses icon.

Locked calculations
®
When a calculation uses a source that is associated with a locked calendar in IBM Incentive
Compensation Management, you can edit the calculation source, unions, joins, restrictions, and formula.
You cannot, however, edit the type of calculation and the partitions of the calculation, or add or delete
partitions.
If you changed your calculation source, you might need to change your partitions to reference the new
source. In this case, you can change the partitions if the partition columns are the same in both sources.
For example, you can delete a payee partition that references your old source and add a payee partition
that references your new source. You cannot delete a payee partition that references your old source and
add a product partition that references your new source.
You can never change the calendar accumulation or start date of the time partition of a locked calculation.
If you delete a date partition and add a date partition to reference a new source, the starting date is in the
first unlocked period for the associated calendar.
Formulas for locked calculations can be changed, unless the calculation uses accumulating partitioning. If
the Accumulating Partitions option is selected, you can make changes only to arguments of aggregate
functions and make changes to the structure of the formulas.
Locked calculation results do not change. Calculation results for any unlocked periods change to reflect
any edits that were made to the calculation.

78 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 11. Data sources
®
In IBM Incentive Compensation Management, data sources are any calculation, table, or data store that
can be used to create another data source or to display results in reports and web forms.
Initially, any non-system table is available as a calculation source. After you create one or more
calculations, you can select any other calculation result as a source for a new calculation.

Adding a data source

®
In IBM Incentive Compensation Management, you must add a data source when creating calculations,
data stores, Presenter components, and web form objects.

Procedure
1. Create an object that requires data sources.
2. On the Data Sources tab, drag your main data source and place it in the Added Data Sources field.

What to do next
If adding one data source does not give you the results you need, you can join multiple data sources
instead.

© Copyright IBM Corp. 2005, 2018 79

Replacing a data source with another source
®
In IBM Incentive Compensation Management, a data source can be replaced with another source.

Procedure
1. Create an object that requires data sources.
2. On the Data Sources tab, drag the source that you want to replace with the current data source to the

Added Data Sources pane and place it over the Replace icon .

3. Click OK.

Multiple sources
®
In IBM Incentive Compensation Management, data from multiple sources can be combined by adding
columns or adding rows.
For example, one table might contain all of the sales data that is required to calculate total sales, and
another might contain quotas and compensation rates that must be applied. Multiple sources are required
for this calculation.
The Incentive Compensation Management model administrator can add multiple additional sources to the
current source.
Important: Adding columns produces the same result as creating a View in Composer. However, Views
cannot be used as sources in calculations.

Add sources by columns

®
In IBM Incentive Compensation Management, you can join two or more tables or calculations together to
define the data sources for your calculation by adding columns. This is referred to as a join.
Joining data sources by adding columns is typically used when the data from two or more sources will be
compared against each other, or used in a formula.
Normally, you join data sources together based on a point of commonality by defining restrictions for the
join. By default, columns with the same name and of the same type are joined automatically. You can
choose to disable the automatic creation of joins.
For example, consider a situation where you join a product table to a payee table to display the products
that were sold by each payee. If you restrict, or join, your results based on the payee ID, you can get the
results shown in the following tables.

80 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 12: Payee table
PayeeID Name
001 John Smith
002 Sue Jacobs
003 Marc Frederick
004 Mary Scott

Table 13: Product table

ProductID ProductName PayeeID
123 Printer 001
234 Cable 001
345 Monitor 003

Table 14: Result of joining the Payee table and Product table by columns
PayeeID Name ProductID ProductName
001 John Smith 123 Printer
001 John Smith 234 Cable
003 Marc Frederick 345 Monitor

Important: No data is displayed for Sue Jacob (002) or Mary Scott (004) because there are no
corresponding rows in the Product table for those payees.
You can use restrictions to join each new source to an existing source based on a point of commonality.
For example, if the initial source contains transactional data for each payee, and the second source
contains compensation rates to be applied to sales, you must specify how to associate the two types of
payee data. If the compensation rates vary based on job title, and Title ID is contained in both tables,
they can be joined on that basis, for example, ERP.TitleID = Rates.TitleID.
Adding restrictions is an important part of adding a data source. If you do not create restrictions, each row
in the new source is added to each row in the existing source. This action creates many more rows than
either source would have individually.
For example, if the first source had 100 rows and the second had 50 rows, the result of a join with no
matches would be 100 x 50 = 5000 rows, or a row for each possible combination of rows in the two
sources.
While restrictions are normally necessary, there might occasionally be instances where you want to
display all the possible row combinations when you join two sources. Imagine that you have a product
table and a payee table, and you want a table that shows each product that might potentially be sold by
each payee.

Table 15: Payee table

PayeeID Name
001 John Smith
002 Sue Jacob
003 Marc Frederick
004 Mary Scott

Data sources 81
Table 16: Product table
ProductID ProductName PayeeID
123 Printer 001
234 Cable 001
345 Monitor 003

Imagine that you complete the following steps:

1. Define the payee table as your first source.
2. Add columns to the payee table from the product table.
3. Decline to add restrictions.
Your join produces the results in the following table.

Table 17: Imposing no restrictions example

PayeeID Name ProductID ProductName
001 John Smith 123 Printer
001 John Smith 234 Cable
001 John Smith 345 Monitor
002 Sue Jacob 123 Printer
002 Sue Jacob 234 Cable
002 Sue Jacob 345 Monitor
003 Marc Frederick 123 Printer
003 Marc Frederick 234 Cable
003 Marc Frederick 345 Monitor
004 Mary Scott 123 Printer
004 Mary Scott 234 Cable
004 Mary Scott 345 Monitor

Important: This example represents an unrestricted join, where every row on the first table is matched to
every row on the second table. It is import to carefully define joins to make sure that your information is
returned as intended.

Adding additional sources by columns

®
In IBM Incentive Compensation Management, you can join two or more data sources together by
columns to compare the data sources or use the data in a formula.

Procedure
1. On the Data Sources tab, drag the first source and place it in the Added Data Sources pane.
2. Drag the second source and place it in the field below the first source.

82 IBM Incentive Compensation Management Version 10.0.0 : User Guide

3. To add additional sources, drag the source that you want to add and place it above or below a source in
the Added Data Sources pane.

Data sources 83
 What to do next
Define restrictions for the join.

Renaming a joined source

®
You can give an alias to sources that are joined by columns in IBM Incentive Compensation Management.

About this task

After renaming a source, the name of the source is also updated on the Restrictions, Formulas, and
Display Columns tabs.

Procedure
1. On the Data Sources tab, click the Edit icon next to the joined source.
2. Type the new name.

Moving data sources

®
In IBM Incentive Compensation Management, you can change the order of the data sources that you
added on the Data Sources tab.

About this task

If you move sources in calculations that already have defined restrictions, the restrictions on the
Restrictions tab might change. The order of the sources remains the same throughout all tabs. Tables can
be reordered as the main sources as long as the table is not anchored or renamed. Restrictions can only
be built if the matching source is listed in the Data Sources tab.

Procedure
1. On the Data Sources tab, select the source that you want to move.
2. Drag the source to a new location on the list.

Anchor feature
®
In IBM Incentive Compensation Management, use the Anchor feature when joining sources in data
stores, calculations, and Presenter report data sources.

Enabling the Anchor feature allows you to display rows for all records for the first data source even if
the join does not find matching records in the second data source. Only matched records from the second
data source are returned. If the second data source returns one row and the first data source returns
more than one matching row for it, the values in the second source are repeated for each distinct row in
the first data source.
Consider a situation where you have the following two data sources:

Table 18: Source 1

Name DepartmentID
Dan Huddell 004
Brain Acton 001
Jill Avery 002
John March 003
Chris Ackles

84 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 19: Source 2
DepartmentID Department Name
001 Sales
002 Development
003 Services
004 Marketing
005 Training

If you preview from Data Sources tab when the Anchor feature is used, records from the first data source
are returned even when there is no matching record in the second source.

Table 20: Results from joining the sources and using the anchor feature
Name DepartmentID Department Name
Dan Huddell 004 Marketing
Brain Acton 001 Sales
Jill Avery 002 Development
John March 003 Services
Chris Ackles

When you partition an anchored source in calculations, any partitions that have null results are removed.
When you preview from the Formulas tab with Name, Department ID, and Department Name as
partitions, Chris Ackles is removed from the data set. However, if you partition by Name only, Chris Ackles
is included.

Add sources by rows

®
In IBM Incentive Compensation Management, you can create a union between data sources by adding
data from one source to the bottom of another source. This creates one data source.
You might find that joining sources (adding columns) does not organize your data in a way that creates the
results that you want. If so, you can append sources by adding rows. This feature is similar to adding
columns in that both options are used to relate information from multiple sources.
Consider a plan that pays compensation to employees based on their total sales minus any returns that
are made by month. Look at the information for employee 001.

Table 21: Sales data table

Employee Total Sales Date
001 1500 Month 1
001 250 Month 1
001 700 Month 2
001 500 Month 3

Table 22: Return data table

Employee Returns Date
001 -100 Month 1
001 -50 Month 2

Data sources 85
 If you follow these steps to add rows from the return data table to the sales data table, the results match
the Results of adding rows table.
1. Add rows from the return data table to the sales data table.
2. Look for a sum of the total sales.
3. Partition the results by months.

Table 23: Results of adding rows

Total Sales Months
1650 Month 1
650 Month 2
500 Month 3

A result is shown for Month 3, even though there is no record for that month in the return data table. If
you link these tables by adding columns, the row containing March would not be displayed.
All columns in the source table must be mapped to a column in the union table. For this reason, the
columns in the source table must be similar to the columns in the union table. For example, both the
Sales data table and the Return data table had employee ID, amount, and date columns.

Adding additional data sources by rows

®
In IBM Incentive Compensation Management, join two or more data sources together by rows to create
one source.

Procedure
1. On the Data Sources tab, drag the first source and place it in the Added Data Sources pane.
2. Drag the second source and place it over the source in the Added Data Sources pane.

3. Make sure all the columns are mapped.

Tip: Click Automatch to have the application map identical column names automatically.

86 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 4. Click the Edit icon next to the second source to view the column mapping section.

Data sources preview

®
In IBM Incentive Compensation Management, after you select your data sources, you can use the
Preview button to display the rows of data that you want to use.
You can examine the results that are generated by adding columns or rows to your data source before you
move on to the next step. Only the top 100 rows are displayed.

Data sources 87
88 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 12. Restrictions
®
In IBM Incentive Compensation Management, you can use restrictions to exclude certain records from
data sources.
For example, you might not want your calculation results to include every record in the source data table
or all of the results from a prior calculation. By defining a restriction, you can limit the records included in
the calculation by specifying conditions for their selection. To define the records that are included in your
calculated results, you might impose restrictions on sales that include product 2 or transactions that
exceed $50,000 and are sold to a customer in New York.
For each restriction, you must define a data source, an operator, and a value to determine whether the
restriction must be applied. The following operators are available:
• = (equals)
• <> (does not equal)
• < (is less than)
• > (is greater than)
• <= (is less than or equal to)
• >= (is greater than or equal to)
• is empty
• is not empty
Restrictions can be defined based on both individual values and sources. For example:
Value: PayeeID = 1234
Source: Payee ID in source 1 = Payee ID in source 2
Restrictions can be added to the main source but can only be constant values, such as Data.Value=10.
Main source restrictions cannot involve any attribute from other tables.

Defining restrictions for joined sources

®
In IBM Incentive Compensation Management, you can define restrictions to join sources based on a point
of commonality.

About this task

Restrictions for data sources are defined on the Restrictions tab. All sources and restrictions are
displayed. By default, restrictions between sources are created automatically. Any text, date, email, or
pick list columns that have the same name and column type in the two sources are joined. You can choose
to disable the automatic creation of joins.

Procedure
1. On the Restrictions tab, expand the source for which you want to define restrictions.
2. Hover your mouse over the area next to AND and click Restriction.

© Copyright IBM Corp. 2005, 2018 89

 Tip: If you need to create many restrictions at once, it is faster to click Restriction multiple times and
then drag the source columns into the empty fields. For example, if you know you need to create five
restrictions, click Restriction five times in a row.
3. Drag the column from the source that you want to restrict and place it in the first field.
4. Select an operator for the restriction from the drop-down list.
5. Drag a column from the joined source to the second restriction field to define the restriction.

Disabling automatic joins in calculations

®
In IBM Incentive Compensation Management, you can prevent joins between sources from occurring
automatically.

About this task

When this feature is disabled, when you join sources, columns with the same name and of the same type
are not joined automatically.

Procedure
1. Click Admin > More Options.
2. On the Calculation tab, clear the Enable auto join in Calculation Wizard check box.

90 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Defining global restrictions
®
In IBM Incentive Compensation Management, you can identify the data that should be included in your
final result. For example, you can restrict a calculation to show only the sales of a specific product for
each month.

About this task

A Global Restrictions dynamic panel is displayed at the bottom of the Restrictions tab. You can define
the restrictions in this pane that are global and would be applied after all other restrictions in the normal
pane or for filters related to anchoring the base data source.

Procedure
1. On the Restrictions tab, expand the Global Restriction pane.
2. Hover your mouse over the area next to AND and click Restriction.
3. Drag a column on which you want to restrict from the data source to the first field on the Global
Restriction pane.
For example, drag the ProductID column to the Product table source.
4. Select an operator from the drop-down list.
For example, select the equal operator.
5. In the second field of the restriction, perform one of the following actions:
• To select a value from the selected column to define the restriction, click in the second restriction
field and select the value.
• Drag a column on which you want to restrict from the data source to the first field on the Global
Restriction pane.

Multiple restrictions that use AND or OR groups

®
In IBM Incentive Compensation Management, if you need to get two sets of results in one object, you can
use OR within AND restrictions.
For example, you can show all data that is either Product ID 001 and Payee ID Huddle or all data that is
Payee ID 001 and Payee ID Young.
AND Groups
When multiple restrictions are defined, they are separated with an AND operator by default. For
example, if you define the following restrictions, you get results for payee 1234 in January:
Payee ID = 1234
Month = January
OR Groups
You can use OR groups to define the following type of restriction: Payee ID = 1234 or Payee ID = 3456.

Adding AND or OR groups in restrictions

®
In IBM Incentive Compensation Management, you can define multiple restrictions for your results by
adding AND or OR groups.

Procedure
1. On the Restrictions tab, expand the data source that you want to create an AND or OR group for.
2. Hover your mouse over the area next to AND, and select one of the following options:

Restrictions 91
 Option Description
AND group Both or all defined restrictions in the group are applied to the data.
OR group Data where any restrictions in the group are true is retrieved.
3. Define the restrictions.

Moving sources for restrictions

®
In IBM Incentive Compensation Management, you can change the order of the sources on the
Restrictions tab.

About this task

Restrictions are sorted by source. The sources are listed in the order they are added, but can be dragged
and dropped to a new location. A source can be moved above the main source under the following
conditions:
• When moving a source up, the new join source is not renamed
• When moving the main source down, the top join source is not renamed
• The main source is not anchored
Restrictions can be created under any source, but they are automatically placed under the source where it
makes the most sense. The restriction is moved automatically even if it is created somewhere else. When
you reorder sources, all the restrictions are automatically moved to where they make the most sense
under the new order.

Procedure
1. On the Restrictions tab, select the source that you want to move.
2. Drag the source to a new location on the list.

Deleting restrictions
®
In IBM Incentive Compensation Management, you can remove restrictions if necessary.

Procedure
1. On the Restrictions tab, expand the source that contains the restriction that you want to delete.
2. Click the restriction.
3. Click the Delete icon.

92 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 13. Display columns
®
Display columns define how the results are displayed in IBM Incentive Compensation Management by
offering the option of dividing a single set of results into sub-results.
All column types except comment and numeric columns can be used as display columns in calculations.
For example, your formula might be: Sum(Data.Value) * 0.01 (or 1% of the sum of the amounts in
the value column of the data table). If the result of this formula is 1,000,000 and no display columns are
defined, the following data is displayed:

Table 24: No display columns

Amount
1,000,000

If you choose PayeeID as the display column for the calculation, you have results similar to the following
table:

Table 25: PayeeID display column added

PayeeID Amount
10001 150,000
10002 275,000
10003 312,000
10004 363,000

A display column replaces a single calculated result with multiple results, equal in total to the original
single number. Multiple display columns are also possible, and are frequently required. In the example,
imagine using both PayeeID and Date as display columns, instead of simply PayeeID. The result might
look something like the following table.

Table 26: Multiple display columns

PayeeID Period Amount
10001 Period 1, 2013 90,000
10001 Period 2, 2013 50,000
10001 Period 3, 2013 10,000
10002 Period 1, 2013 85,000
10002 Period 2, 2013 95,000
10002 Period 3, 2013 60,000
10002 Period 4, 2013 35,000

© Copyright IBM Corp. 2005, 2018 93

Defining display columns
®
In IBM Incentive Compensation Management, you can divide your results into sub-results based on
columns that are selected from the data sources.

Procedure
1. On the Display Columns tab, drag the columns from the data sources to the Add columns pane.
2. If you select a date column as a display column, complete the following steps:
a) Select the calendar to use for the column.
b) From the Calculation Level drop-down list, select the time interval to group by.
c) From the Accumulatation Level drop-down list, select when to reset the accumulated values to
zero.
d) You can also select a start and end date for the column.

3. To change the order of the columns, drag the columns in the Add columns pane and place them in the
order that you want.
4. To set accumulating partitions for a calculation, from the Normal Partitions drop-down list, select
Accumulating Partitions.
5. To include empty partitions in the results of a calculation, from the Normal Partitions drop-down list,
select Include Empty Partitions.

Empty partitions
®
In IBM Incentive Compensation Management, you can choose to display a result of zero in all empty
partitions.
Sometimes a calculated result partition is empty. For example, payee 10001 generated sales results for
only periods one, two, and three in 2007. In this case, no result is generated for periods four and later,
and typically this result is fine.
However, you might want to calculate a result for each payee and period within a plan, even if that result
is zero. For example, consider a situation in which you want to calculate compensation for each payee in
the following situations:
• Totaling their sales for a period
• Subtracting their discounts
• Paying 5% commission on the net value

94 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Imagine that you calculated the following results for payee 10001:

Table 27: Sales by period

PayeeID Period Amount
10001 Period 1, 2009 90,000
10001 Period 2, 2009 50,000
10001 Period 3, 2009 10,000

Table 28: Discounts by period

PayeeID Period Amount
10001 Period 1, 2009 7,000
10001 Period 2, 2009 2,000
10001 Period 3, 2009 1,500
10001 Period 4, 2009 1,950

To complete this calculation, Incentive Compensation Management requires results for each period. The
net results for period four cannot be calculated since there are no values in the first calculation that
corresponds to this period.
You can select Include Empty Partitions on the Display Columns tab. If you do so, Incentive
Compensation Management adds a prompt and indicates that zeros must be added to any empty results.
In this example, payees and periods are extended to include zeros in columns that would otherwise be
empty.

Including empty partitions

®
In IBM Incentive Compensation Management, when adding display columns, you can choose to display a
result of zero in all empty partitions.

Procedure
1. On the Display Columns tab, from the Normal Partitions drop-down list, select Include Empty
Partitions.

2. Drag the columns from the data sources to the Add columns pane.

Display columns 95
Accumulating partitions
®
You can use the Accumulating Partitions option to display an accumulated total of results in IBM
Incentive Compensation Management. For example, you might choose to display the year-to-date value
of transactions for each payee rather than the individual value of each transaction.
With regular display columns, the results reset at every column. If you want each result to show an
accumulated value, select the Accumulating Partitions option on the Display Columns tab.

Table 29: Results with accumulating value

Time PayeeID ProductID Partition Value Accumulating
Partitioning Value
Month 1 A250 Product A 175 175
Month 2 A250 Product D 150 325
Month 3 A250 Product C 125 450
Month 4 A250 Product F 175 625
Month 5 A250 Product B 119 735
Month 6 A250 Product A 250 985
Month 7 A250 Product B 500 1,485
Month 8 A250 Product C 135 1,620
Month 9 A250 Product A 125 1,745
Month 10 A250 Product E 100 1,845

Adding accumulating partitions

®
In IBM Incentive Compensation Management, when adding display columns, you can choose to display
an accumulated total of results in a display column.

Procedure
1. On the Display Columns tab, from the Normal Partitions drop-down list, select Accumulating
Partitions.
2. Drag the column from the data source that you want to accumulate total results for and place it in the
Add accumulating columns pane.

96 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 14. Formulas
®
In IBM Incentive Compensation Management, you can create multipliers (or more complex formulas) for
calculations and many Presenter components.
Any numeric value can be pulled directly from the sources tree into the formula window.
You can use various formulas (for example, SUM, MIN, MAX, IF, AND, OR, and NOT) to set up the calculation
that you want.
In addition, you can click the Preview button to examine the results of each formula before you proceed.
Important: Each formula must satisfy only a portion of the requirements of the entire compensation
calculation. For example, consider a compensation plan that requires the following calculations: totaling
product sales for the month, determining the appropriate compensation rate based on the sales amount,
and then calculating the compensation payout. This plan might be conceptually understood more easily in
three calculations than in a single step. You can create three separate calculations that build on each
other to obtain the final result.

Formula functions
®
You can use several formula functions to set up the calculations that you want to create in IBM Incentive
Compensation Management.

Table 30: Formula functions

Function Description Example Syntax Notes
SUM() This operator To calculate 5% of the value of each sale as Sum(Value) The use of SUM is
takes the commission: recommended for
aggregate of most calculations as
whatever is Sum(SourceTable.ValueColumn)
it will provide you
within the *0.05
with the proper
brackets and summed amount for
provides a your calculation.
total.
COUNT() This operator To calculate the total number of deals in a Count(Value If the data is
gives a value of period: ) partitioned by
1+ for each PayeeID and Month,
record that has COUNT(SourceTable.ValueColumn) the count will reset
a value. The back to zero after
value of each each month and
record is one start again.
more than the
previous
amount.

© Copyright IBM Corp. 2005, 2018 97

Table 30: Formula functions (continued)
Function Description Example Syntax Notes
MAX() This operator If, for each deal, you receive a 5% MAX(Value1, If you have an if
takes the commission but there is a minimum of $5 Value2, statement similar to
maximum per deal you earn, you can use the Value3, the following
value of a set following formula to determine whether etc.) example:
of results. the 5% commission is higher than the $5 IF(A>B,A,B), you
minimum: may want to use the
MAX operator.
MAX(Data.Value*0.05, $5)
MAX can also be used on a single value to
be used as an aggregate function (like SUM,
AVG, COUNT). For example,
MAX(Data.Value)

MIN() This operator If 5% commission is paid on each deal to a MIN(Value1,

takes the maximum of $100, the following formula Value2,
minimum pays either 5% commission or $100, Value3,
value of a set whichever is less: etc.)
of results.
MIN(Data.Value*0.05 , 100)
MIN() can also be used on a single value
to be used as an aggregate function (like
SUM, AVG, COUNT):
MIN(Data.Value)

AVG() This operator If a product has a set price, but sales reps AVG(Value)
takes the can sell above or below this price, the
average of the following formula compares their average
value within monthly sale value to the set price and
the brackets. pays commission based on their gross
margin:
(AVG Sale - Set Price)/ Set
Price

IF() You can use If the sale amount is greater than $100, IF(Logical To include text
this operator you receive a 5% commission. Otherwise, Test, True columns in IF
to perform a you receive a 2% commission. Result, functions, you must
logical test and False disable the Enforce
provide a true IF(Data.Value > 100, Data.Value Result) best practices for
and false * 0.05, Data.Value * 0.02) formulas option.
result. Nested IF() example:
If your sale amount is greater than $100,
you receive 5% commission. If your sale is
greater than $50, you receive 3%;
otherwise, you receive 2%.
IF(Data.Value > 100, Data.Value
* 0.05, IF(Data.Value > 50,
Data.Value * 0.03, Data.Value *
0.02))

98 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 30: Formula functions (continued)
Function Description Example Syntax Notes
ISEMPT This operator If(IsEmpty(Payee.DateOfHire), ISEMPTY
Y() takes a date or DefaultDate, Payee.DateOfHire) (Value)
numeric field
and provides a
true result if
the field does
not have a
value (the
equivalent of
NULL in the
database).
AND() This operator If you want to show results for transactions AND(Logical
returns results that are bigger than $1,000 and less than Test 1,
if all conditions $10,000, use a formula similar to the Logical
are true. If you following example: Test 2)
use the AND
operator to AND(SourceTable.ValueColumn >
return results 1000, SourceTable.ValueColumn <
for Logical Test 10000)
1 and Logical
Test 2, results
that include
both Value 1
and Value 2
are returned.
OR() This operator If you want to show a result of 1 for values OR(Logical
returns results that fall between 10,000 and 20,000 and a Test 1,
if one or more result of zero for all other values, use a Logical
conditions are formula similar to the following example: Test 2)
true. If you use
the OR IF(OR(SourceTable.ValueColumn <
operator to 10,000, SourceTable.ValueColumn
return results > 20,000),0,1)
for Logical Test
1 or Logical
Test 2, any
records with
either value
are returned.
NOT() This operator If you want to apply a 5% commission to NOT(Logical
returns results all transactions, except when the Test)
when a transaction value is less than $1,000, use a
condition is formula similar to the following example:
not met. You
can use this SUM((SourceTable.ValueColumn)
function to *0.05,
exclude NOT(SourceTable.ValueColumn <
records from 1000))
your results.

Formulas 99
Table 30: Formula functions (continued)
Function Description Example Syntax Notes
ABS() You can use If you want to show the difference between ABS(Value)
this operator this month's sales and last month's sales
to take the as a percentage, but you do not want the
value within percent change to be a negative value, use
the brackets a formula similar to the following example:
and show the
number as a ABS(Current - Prior)/Prior
positive,
regardless of
whether the
value within
the brackets is
positive or
negative.
ROUND() This operator If you want to round your results to the ROUND You must specify the
uses Banker's nearest cent, use a formula similar to the (Value, value you want to
Rounding to following example: Decimal round, then the
round the Places) amount of decimal
results in the ROUND(Result, 2) places you want to
brackets. For round to. Type 0 for
example, 0.5 a whole number, 1
rounds to 0, for one decimal
but 0.51 place, 2 for two
rounds to 1. decimal places, etc.
ROUND This operator If you want to round your results down to ROUND DOWN num_digits in the
DOWN() rounds any two decimal places, use a formula similar (Source number of digits to
number down to the following example: Table. which you want to
towards zero ValueColumn round the number.
by the number ROUNDDOWN(Result, 2) ,
of decimal num_digits) If num_digits > 0,
places that you then the number is
define in the rounded down to the
formula. specified number of
decimal places.
If num_digits = 0,
then the number is
rounded down to the
nearest integer.
If num_digits < 0,
then the number is
rounded down after
the decimal point.

MULT() This is used to If you wanted to multiply all the values in MULT(Value)
multiply your data table together, use a formula
numerous similar to the following example:
numbers
together. MULT(Data.Value)

100 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 30: Formula functions (continued)
Function Description Example Syntax Notes
PREV () The PREV() If a minimum of $500 is to be paid each PREV() PREV does not have
operator month to each rep but if commissions fall any values inserted
references to short, they have to be clawed back in in the brackets.
the previous subsequent months, use a formula similar
value of the This function will
to the following example:
calculation you only work properly if
are editing MAX(0,PREV() + Monthly your data only has
along its Minimum.Value - Monthly one row per
accumulating Sales.Value) partition in the
partition. This calculation table.
is important
any time you
have a
situation
where you
must have
explicit access
to the previous
iteration of the
calculation you
are editing to
come up with
the required
current period
results.
POW() This is used to If you want to calculate the value of a deal POW(Value,
create an which is sold today but paid upon Exponent)
exponent. completion in 5 years, use a formula
Instead of similar to the following example:
using A^B for
A to the power Present Value = Future Value /
of B, Incentive (1+Interest Rate)^Term
Compensation If you will be paid 20,000 in 5 years where
Management the interest rate is 5% the formula would
will use the look like this:
formula
POW(A,B). 20,000 / POW((1+.05),5)

Creating formulas in calculations

®
In IBM Incentive Compensation Management, you can create one or more formulas for a calculation.

About this task

You can create and name up to twelve formulas in an individual calculation. If a formula is not required,
you can remove the value column. A calculation with no value column must contain partitions. When a
value column is not created, space is saved in the database. A calculation without a value column is
similar to a View table; however, calculations can be used as sources while Views cannot.

Procedure
1. On the Formulas tab, click Add a metric.
2. Click the Edit icon to rename the metric.

Formulas 101
 Each value column name must be unique.
3. From the Add a function drop-down list, select a formula function.
4. From the Data Source pane, drag the column required for the formula and place it next to the function.
5. Select any operators.
6. Define the rest of the formula.

Formatting formulas
®
In IBM Incentive Compensation Management, you can format formulas in the Calculation Wizard.

About this task

After you type a formula and click Format formula, the formula is separated into new lines and becomes
indented. Functions in the formula are blue in color, variables are teal, and numbers are purple.
Formatting a formula cannot be undone. Formatting a formula counts as a change to the calculation;
therefore, you must re-calculate the calculation to view the results.

Procedure
1. On the Formulas tab, create a formula.
2. Click Format formula.

102 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 15. Calculate
®
In IBM Incentive Compensation Management, you can run the calculate engine, view the summary of the
last calculations that were run in the model, and view the Computation log.
Use Scheduler, to specify the timing of a calculation or update. After you load data or make structural
changes to your model, you must run a calculation to view updated results. Users cannot complete any
global actions while the calculation is running.
You can run several different types of calculations.

Table 31: Calculate options

Calculation Option
All Active Plans and All
Reports
Individual Calculation
Results for a Specific Payee
Web Forms
Presenter Reports
Scenarios Workspace
Description
Use this option to calculate all plans and reports.
Use this option to only calculate a selected calculation.
Use this option to select a payee and calculate all plans and reports that the
specified payee is a member of.
Use this option to calculate results for all web forms or for a specific one.
Use this option to calculate results for all Presenter reports or for a specific
one. This includes any Composer calculations that were used as sources in
the report.
Use this option to calculate results for all Scenario workspaces or for a
specific one.

Calculating results
After you create a calculation, report, web form, or Scenarios workspace, you can calculate the results in
®
IBM Incentive Compensation Management.

Procedure
1. In Composer, click the Calculate icon.
2. From the Calculation Type drop-down list, select the items that you want to calculate.
3. Click Calculate to begin the calculation process.

Results
The Status Update icon in the application header turns yellow. You can view the progress of the
calculation by clicking the Status Update icon. After the calculation is complete, a message that
describes successful completion or errors is displayed in the Activity module.

Canceling a calculation that is in progress

®
You can cancel a calculation that is in progress on the Activity page in IBM Incentive Compensation
Management.

Procedure
1. On the Activity page, view the activities in progress.

© Copyright IBM Corp. 2005, 2018 103

 2. Click the Delete icon next to the running calculation that you want to cancel.

Results
When the Delete icon is clicked, anything that was calculated up to that point remains calculated, and
calculations do not revert to their previous state. The cancellation occurs as soon as you confirm your
intent to cancel.

Viewing calculation details

®
In IBM Incentive Compensation Management, you can view the details of active or completed
calculations such as, the length of the full calculation, the length of individual calculations in the full
calculation, and the last time a calculation was run in the model.

Procedure
1. In Composer, click the Status Update icon in the application header.
Note: If the Status Update icon is yellow, a calculation is in progress. If the Status Update icon is
green, all calculations are complete.
2. Click View Details.
The Activity page opens.

Calculation performance
You can view reports on calculation performance and choose to enable features that can improve the
®
performance of calculations in IBM Incentive Compensation Management.
Calculation performance can be viewed and compared in the Performance log.

Using incremental calculation to increase calculation speed

You can specify whether to use existing results that are still current (for example, nothing was changed to
®
potentially change the result) during the calculation to speed up the overall calculation time in IBM
Incentive Compensation Management.

About this task

By default, the Enable incremental calculation option is selected so that when you run a calculation on a
model, the calculation engine recalculates only the changes that were made since the last calculation was
run.

Procedure
1. Click Admin > More Options.
2. On the Calculation tab, ensure the Enable incremental calculation check box is selected.
3. Click Save.

Enforcing single row formulas

®
In IBM Incentive Compensation Management, when you create a calculation, you can prevent users from
creating a formula that is not aggregated.

About this task

If you use Incentive Compensation Management Premium, this option is not enabled. When you create a
new model, this option is enabled. When you upgrade an existing model, this option is not enabled. Users

104 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 can enable this feature after an upgrade. When you migrate to a model where the Enforce best practice
formulas is enabled, calculations that have invalid formulas are displayed as invalid during Migration.

Procedure
1. Click Admin > More Options.
2. On the Calculation tab, select the Enforce best practices for formulas check box.
3. Click Save.

Enabling Data Tier Performance Optimization

®
The Data Tier Performance Optimization feature in IBM Incentive Compensation Management can
improve calculation performance, especially in models that contain many multiplication and division
calculations.

Procedure
1. Click Admin > More Options.
2. Click the Calculation tab.
3. Select the Enable data tier performance optimization check box.

Troubleshooting calculations
®
If a calculation run in IBM Incentive Compensation Management does not finish, there are a few steps
you can take to correct the issue.

Symptoms
You might need to take some corrective steps if you notice one of the following symptoms:
• the calculation is hanging or stuck
• the calculation progress bar is taking a longer than usual time to advance, even though you imported
very little data

Causes
Calculations can hang for the following reasons:
• the calculations need to be tuned for performance after a recent upgrade
• the calculation definitions are too complex. For example, you are trying to do too much at once in one
individual calculation.
• non-optimal database query plans

Resolving the problem

You can resolve the issue by completing the following steps:
1. Run Model Optimize. For Premium Performance models, run Quick Optimize as well.
2. If the calculation continues to hang, identify the calculation that is stuck and perform the following
steps:
• Change the calculation method
• Aggregate the formula of the calculation if it is not already aggregated. For example, use
SUM(formula).
• Break down the calculation into multiple sub-calculations that join fewer sources
• Break down the calculation into multiple sub-calculations that calculate different parts of the
formula

Calculate 105
 • If the calculation has an accumulating partition, change the partition to non-accumulating and create
a second calculation that accumulates the partition
• Create copies of the calculation that each calculate a portion of the data. One common approach is
to calculate periods independently. For example, calculate 2015, 2016, 2017 separately.
3. If the calculation still continues to hang, add database indexes to a transactional table that the
hanging calculation uses.
You can add database indexes to data, structural, or custom tables. Do not add database indexes to
any other tables.
Note: You must create a new database index anytime you edit the structure of the table. Prior to
upgrading to a new version of ICM, remove all the database indexes that you added.
4. After resolving one hanging calculation, you may find that another downstream calculation is hanging.
Continue repeating the steps above for any downstream calculations that hang. Continue progressing
through the calculation stream until it succeeds.

106 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 16. Data stores
®
Data stores are Composer objects in IBM Incentive Compensation Management that you can use to join
sources, such as tables, calculations, and draw results, into one large repository.
For example, a data store can be used to pull together results that are required for reporting purposes into
one object. The data store can then be used as a source in Presenter to build reports. Reporting users can
then easily create reports as all the sources that they require are available in one place. All tables and
calculations within the model can be used as sources in the data store, regardless of the component
where the data store is located.
At a high level, the following steps describe how to create a data store:
1. Add a data store object in Composer.
2. Join the data sources that you want in the data store.
3. Select the detail columns from the added sources that are available to users from the data store.
4. Define any restrictions to the data.
5. Rename the detail columns with meaningful names.
Here's a short video that shows you create data stores:

https://www.youtube.com/watch?v=DRAb8W1krOE
Data stores can be wrapped into components within Composer but they are globally visible. Users can
select the data store as a source from anywhere in Composer. Security can also be applied to any data
store to give users permission to view, edit, and delete the object.
Data stores can be created to be used as sources in Presenter or Watson Analytics.

Adding data stores

®
In IBM Incentive Compensation Management, create data stores to join multiple data sources together.

Procedure
1. In Composer, from the Palette tab, drag the Data Store object onto the Composer window.
2. Type a unique name for the data store and click Save.
3. Define the data sources for the data store.
4. On the Restrictions tab, define any restrictions to limit the records displayed in the data store.
5. On the Display Columns tab, drag the columns that you want to display in the data store from the data
sources to the Add columns pane.
a) In the Add columns pane, click the column name to rename it.
b) Click the Edit icon when you are finished renaming the column.
6. Click Create.

© Copyright IBM Corp. 2005, 2018 107

Data store export
®
In IBM Incentive Compensation Management, after adding data to your data store, you can export
selected rows of data to a separate file.

Exporting data store rows to a .csv file

®
In IBM Incentive Compensation Management, after adding data to your data store, you can export
selected rows of data to a .csv file.

About this task

You can select and export a maximum of 1000 rows of data.

Procedure
1. In Composer, click the Edit icon on the data store.
2. Press Shift and select the rows that you want to export.
3. Click Export to CSV.

Copying data store rows to the clipboard

®
In IBM Incentive Compensation Management, after adding data to your data store, you can copy selected
rows of data to the clipboard.

About this task

You can copy a maximum of 300 rows of data to the clipboard.

Procedure
1. In Composer, click the Edit icon on the data store.
2. Press Shift and select the rows that you want to copy to the clipboard.
3. In the toolbar, click the Copy to clipboard icon.
Tip: You can also use Ctrl + C to copy the selected rows to the clipboard.

What to do next
You can then press Ctrl + V to paste the rows into a file.

Data stores and IBM Watson Analytics

®
Business users can use Watson Analytics™ as a single place where data can be taken from IBM Incentive
Compensation Management or other parts of your business to find trends or patterns in data. You can also
use Watson Analytics to predict future results based on the current data that you have.
Here's a short video that shows you how to export data stores from Incentive Compensation Management
to Watson Analytics:

https://www.youtube.com/watch?v=O9be444JWZs

Related Links
Watson Analytics
https://www.ibm.com/watson-analytics
Watson Analytics API

108 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 https://developer.ibm.com/watson-analytics/#getstarted
Migration WA1 to WA2
https://www.ibm.com/support/knowledgecenter/en/SS4QC9/
com.ibm.solutions.wa_an_overview.2.0.0.doc/wa_migration_overview.html

IBM Watson Analytics registration

®
To use IBM Watson Analytics with IBM Incentive Compensation Management (ICM), you must first
register to have an account with Watson Analytics.

Watson Analytics Trial Registration

You can create a trial account for use with Watson Analytics. You can start with a trial account but
eventually you must have a professional account provided by IBM. If you already have a professional
account, use that account and do not create a trial account.
Sign up for a Watson Analytics trial account using the following URL:
https://www.ibm.com/watson-analytics
Click Try it for free and enter the registration information. Check your email and acknowledge the
confirmation message.

Watson Analytics API Registration

Use the following URL for instructions on registering for the Watson Analytics API:
https://developer.ibm.com/watson-analytics/#getstarted
Follow the instructions under Sign up for the Watson Analytics API and get your OAuth 2.0 credentials.
Use your email account for credentials. Setup a key, record the client-id and client-secret values. These
are used when registering ICM 10 with the Watson Analytics API and in the ICM 10 configuration.

ICM Registration with the Watson Analytics API

With Watson Analytics and Watson Analytics API configured, the ICM application now needs to be
registered as a Watson Analytics client application. For registering the application, use Curl with the
following parameters:
curl -X PUT \
https://api.ibm.com/watsonanalytics/run/oauth2/v1/config \
-H 'content-type: application/json' \
-H 'x-ibm-client-id: client-id' \
-H 'x-ibm-client-secret: client-secret' \
-d '{
"enabled": true,
"ownerName": "owner name",
"redirectURIs": "redirect url”,
"ownerCompany": "owner company",
"source": "source",
"clientName": "client name",
"ownerPhone": "owner phone",
"ownerEmail": "owner email"
}'
The important parameters are client id, client secret, redirect URL and client name.
The client id and client secret parameters are generated in the Watson Analytics setup steps.
The client name parameter must be unique and not used by anyone else using the Watson API. For
example, you can use the following format: IBM <owneremailname> <number>.
The redirect url parameter must match the URL of the application. The URL consists of the server site
followed by the path in the application. The path is different for ICM versions. For ICM10, the path is
hardcoded, but the site must match the location that ICM10 is running. The path is watson/oauth2/

Data stores 109

 code. An example of a valid server site is https://<your ICM address>:3000. An example of a valid
redirect URL for a development local deployment of ICM 10 is http://localhost:3000/watson/
oauth2/code.
You can confirm a successful registration by using the following Curl command:
curl -X GET https://api.ibm.com/watsonanalytics/run/oauth2/v1/config -H
'cache-control: no-cache'
-H 'postman-token: 1a4478c2-941a-65c8-11ab-f9ecd63573d0' -H 'x-ibm-client-
id: YOUR_CLIENT_ID'
-H 'x-ibm-client-secret: YOUR_CLIENT_SECRET '

Connecting to Watson Analytics

®
Before you can export data stores created in IBM Incentive Compensation Management to Watson
Analytics, you must first configure the connection to the Watson Analytics API.

About this task

For information on obtaining access to the Watson Analytics API, visit the following link: https://
developer.ibm.com/watson-analytics/#getstarted

Procedure
1. In the Incentive Compensation Management admin web application, click Admin > More Options.
2. Click the Watson Analytics tab.
3. In the Client ID field, type the IBM client ID that you obtained through API Explorer.
4. In the Secret field, type the client secret that you obtained through API Explorer.

Exporting data from data stores to Watson Analytics

®
Data stores created in IBM Incentive Compensation Management can be exported to Watson™ Analytics
to explore trends and relationships in the data.

Before you begin

Make sure you have configured access to the Watson Analytics API.

Procedure
1. In Composer, click the data store.
A menu for the table displays on the right side of the window.
2. Click Explore in Watson Analytics.
3. On the Options tab, you can complete the following actions:
• In the Data Set Name field, type the name of the data set as you want it to be displayed in Watson
Analytics.
• If you want Watson Analytics to overwrite the data set with the same name if it exists, select the
Overwrite data set if exists check box.
4. Click Explore.
5. You are prompted to login to IBM. Enter the email address that you used to register with Watson
Analytics and click Sign in.
Note: The login prompt for Watson Analytics is only displayed the first time you log in from a single
ICM10 session.
6. In ICM, the Activities page is displayed and a new activity is shown.
7. Click the View Details link of the activity after it has completed running.
8. Click the here link.
9. A new tab opens displaying the Analysis page of the Watson Analytics user interface.

110 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Using Postman for development and testing
®
Postman is useful for developing or testing IBM Incentive Compensation Management against the IBM
Watson Analytics API and useful as a replacement to the Curl commands.

Before you begin

Install the Postman extension for Google Chrome.

Procedure
1. In Postman, click Import.
2. Click the Import From Link tab.
3. Paste the following link into the field: https://www.getpostman.com/collections/
7014105102792b58853f
4. Click the Collections tab to see the newly imported collection.
This includes all of the API end points including the application registration POST and GET calls.
5. Click the Environment Options icon in the application header and click Manage Environments.
6. Click Add and type a name, such as WAAPI.
7. Click Bulk Edit.
8. Paste the following text into the text area.
APImURL:api.ibm.com/watsonanalytics/run
client-id:<replace_with_your_value>
client-secret: :<replace_with_your_value>
idpName:blueid-prod
token: :<replace_with_your_value>
accountId: :<replace_with_your_value>
tenantId: :<replace_with_your_value>
userId: :<replace_with_your_value>
username: :<replace_with_your_value>
password: :<replace_with_your_value>
refresh_token:
datasetId:
folderId:
storybookId:
outputId:
9. Click Update and close the dialog box.
10.Set the drop-down menu in the top-right corner to this collection.

Troubleshooting the Watson Analytics connection

®
If you are experiencing issues exporting data stores from IBM Incentive Compensation Management to
IBM Watson Analytics, there are several actions you can take to resolve the problem.

Watson Analytics login fails with a blue error screen

The following issues may be causing this error:
• The application registration with the client id value is incorrect. Make sure the redirect URL value is
exactly https://<your ICM address>/watson/oauth2/code. Make sure the full client-id value
and client-secret value are copied from the API registration page and match in the curl request that you
made and in the ICM 10 configuration. Run the following curl GET request to verify the registration was
applied as expected.
curl -X GET https://api.ibm.com/watsonanalytics/run/oauth2/v1/config -H
'cache-control: no-cache'
-H 'postman-token: 1a4478c2-941a-65c8-11ab-f9ecd63573d0' -H 'x-ibm-client-
id: YOUR_CLIENT_ID'
-H 'x-ibm-client-secret: YOUR_CLIENT_SECRET '

Data stores 111

 • The client-id, client-secret, tenant-id, or account-id values have been incorrectly configured.
• You are already logged in from another session. Only one session is allowed at a time with Watson
Analytics.

client id - Application registration fails

The most common reason for a failure is that the client name is not unique. Make sure the client name is a
unique name.

112 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 17. Presenter report data components
®
In IBM Incentive Compensation Management, use Presenter to create reports to display your data. In
the Presenter module, you can create and compose Presenter reports to post on the web client for
review.
Presenter reports are configurable in terms of both design and content. Presenter reports can also be
configured for data submission. Report administrators can create editable fields so that web users can
edit or add data through data grids to tables in Composer.
Presenter reports consist of the following main components that are the building blocks for report
creation:
• Data components
– Parameters
– Values
– Sources
– Row form sources
• Presentation components
– Layout tables
– Value displays
– Grids
– Images, charts, maps, and gauges
– Controls and submit buttons
At a high level, the following steps describe how to create a Presenter report:
1. Create parameters that restrict the results that are displayed.
2. Create values that are based on tables, calculations, and constant values, or computed from existing
values.
3. Create a source.
4. Pull calculations, tables, parameters, and values into the Presenter report source.
5. Define the report layout tables for all of the report components.
6. Add report components to the layout tables.

How the pieces fit together

At a high level, calculations, tables, values, and parameters provide the information that is needed to
create a report. These pieces then get compiled into a Presenter report source. After a source is created,
it can be displayed visually on a report.
Presenter report sources can be used as building blocks for other sources. The steps of gathering and
compiling information into sources can be repeated several times before a source is displayed in a grid on
a report, as shown in the following example:
• Create source 1
• Source 1 feeds source 2
• Source 2 feeds source 3
• Source 3 is displayed in a grid on a report

© Copyright IBM Corp. 2005, 2018 113

Presenter naming conventions
®
Before you start to build a report in IBM Incentive Compensation Management, develop standard naming
conventions for your report components.
To save time in the future, it is a good idea to set up your naming conventions in advance. Your naming
conventions must apply to all parameters, values, and sources for each report.
Important: The following naming convention rules are suggestions only. You can edit them to suit the
needs of your organization.
For example, your naming conventions might consist of component type and component purpose.
The first part of the name might specify the type of component. For example:
• Pa = parameter
• Va = value
• So = source
You might also add additional letters to indicate types of values and sources, such as table values. For
example:
• SoCc = source with a computed column
• VaTa = table value
The last part of the name must clearly state the purpose of the component. For example, a parameter that
is used to filter results by months might be called PaMonthlyDateFilter2013.

Presenter report creation

®
In IBM Incentive Compensation Management, before you can start adding sources and displaying data in
a report, you must first add the Presenter object to Composer.
Here's a short video that gives you a look at how to add a Presenter report to Composer:

https://www.youtube.com/watch?v=FXbcfzI9gO8

Adding Presenter reports

®
To create a Presenter report in IBM Incentive Compensation Management, you must first add a
Presenter report object to Composer.

Procedure
1. In Composer, navigate to the component where you want to add the Presenter report.
2. From the Palette tab, drag the Presenter Report object into the component.
3. Type a name for the Presenter report.
The Presenter report object is added to the component.
4. Click the Edit icon on the Presenter report to begin creating the report.

Renaming Presenter reports

®
You can rename a Presenter report in IBM Incentive Compensation Management.

Procedure
1. In Composer, select the Presenter report that you want to rename.
A menu for the report displays on the right side of the window.
2. Click the Rename icon.

114 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 3. Type a new name for the report.

Presenter parameters
®
In IBM Incentive Compensation Management, use parameters to place restrictions or rules on the results
that are displayed in your Presenter report.
Here's a short video that gives you a look at how to add a parameter that filters results in a report by a
specified date:

https://www.youtube.com/watch?v=PdIMh9W8TD8
Parameters are often used to make sure that report results are displayed only if the parameter is true.
Multiple parameters can be included in sources, so you can compose the results in any way that you like.
You can combine parameters to access the records that are useful and omit parameters that are
irrelevant. The following parameters are examples that you can create in Presenter reports:
Payee filter
Used to filter the report to include only results for a selected payee.
Date filter
Used to filter the report to include only results for a particular date or time period.
Threshold filter
Used to show results that exceed or fall below certain thresholds, for example, payees who surpassed
their quota by more than 10 percent.
The default value of a parameter can be set to another parameter or a Value (stored, calculated, or
constant) when the Value option is selected as the Value Type. The items that are displayed in the
Default list include only the items that match the selected parameter type. When User Entered is
selected as the Value Type, a user-determined value can be typed into the Default field.
Important: Null values can be default values, but keep in mind that if the parameter is a Required
Parameter, the report cannot render with a null value. If a non-null value is the default for a required
parameter and the user submits a blank value, the default value is used instead to render the report.

Adding parameters
®
In IBM Incentive Compensation Management, you can add text, date, or numeric parameters to your
Presenter report to restrict and filter the results that are displayed in the report.

Procedure
1. In Presenter, on the Data tab, place your cursor over Parameters and click the ellipsis.
2. Select Add a Parameter.
3. Type a name for the parameter.
4. From the Type drop-down list, select the kind of parameter that you want to create.
5. From the Value Type drop-down list, select one of the following options:
Value type Description
User Entered Select this option if you want to set a static value as the default value.
Value Select this option if you want to choose another parameter or a stored, calculated, or
constant value as the default value.
6. In the Default field, type a default value that populates the parameter when a web user opens the
report.

Presenter report data components 115

 7. Select the Required Parameter check box, to prevent the data in the report from rendering until the
user enters a parameter.
Important: If you select the Required Parameter option, type a default value for a Value parameter.
8. Select the Use Current Web User check box, to populate any payee parameter with the Payee ID of
the user who is logged in to the web client.
9. Click Create.

What to do next
Parameters cannot function on their own. They must be joined into a Presenter report source to function
as intended. In the Presenter report Source wizard, you can set restrictions on source fields or values to
identify the data that must be restricted by the parameter.

Report parameter links

®
Parameters that are used in one Presenter report in IBM Incentive Compensation Management can be
carried over into a linked report.
The following example explains how a linked report with linked parameters might work:
• Filter Report 1 by payee and month
• Create a link from Report 1 to Report 2
• Display records in Report 1 for John Smith in Month 1
• Select link to Report 2
• Report 2 shows only records for John Smith in Month 1
When you link to another report, you do not need to carry over the parameters. If you choose to carry over
parameters, you must map them from the current report to corresponding parameters in the report that
you are linking to.

Presenter report link with parameters example

®
When you are planning links from your Presenter report in IBM Incentive Compensation Management,
you might find it helpful to view an example.
In the following scenario, you have two Presenter reports. One report contains a summary of each
payee's total sales for each month, and the other contains detailed transactional information for each
payee's sales for each month.
You want users to be able to view the first report for specific payees in specific months. Then, you want
users to be able to link to the detailed report without having to reselect the appropriate payee and month.
At a high level, the following steps describe how to create the link:
1. Create Report 1, which contains a summary of each payee's total sales for each month.
2. Add two parameters to this report: a payee and a month filter.
3. Create Report 2, which contains detailed transactional information for each payee's sales for each
month.
4. Add two parameters to this report: a payee filter and a month filter.
5. Add the following text to a cell in the first report: Link to detailed report. Create a link from
that text.
6. Select Report 2 from the report selection menu.
7. Match the payee filter from Report 1 to the payee filter in Report 2, and match the month filter from
Report 1 to the month filter in Report 2.

116 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Presenter values
®
In IBM Incentive Compensation Management, values are variables that you can apply to your Presenter
report to display additional data. Use values to scale back the results of a report or table to a single cell.
There are three types of values; stored, calculated, and constant.
Often values are used to feed other values. For example, different types of values can act as building
blocks for other values to retrieve the information that must be displayed in a report cell or in a fixed grid.
Here's a short video that gives you a look at how to add a stored value:

https://www.youtube.com/watch?v=yUyKnQhDf08

Adding stored values

®
A stored value returns a single value from a table in IBM Incentive Compensation Management.

About this task

The value can be retrieved from any table, data store, or calculation in the model.

Procedure
1. In Presenter, on the Data tab, place your cursor over Values and click the ellipsis.
2. Select Add Value.
3. Type a name for the value.
4. On the Stored tab, select a source for the stored value.
5. From the Value Column drop-down list, select the column to pull data from.
6. Click each ID column that contains the primary keys of the table and choose one of the following
options:
The ID value is the value that must be inputted by the user to determine which row to pull data from.

Option Description
Selected Sets the ID value as a parameter. You must select the parameter from the drop-down
list.
User Defined Sets the ID value as a constant. You must type the value in the field.
7. Click Create.

Stored value examples

®
In IBM Incentive Compensation Management, a stored value can be used to pull specific information
from Composer and display it in a report.
If you have a table that contains payees and their commission rates, you might create a stored value that
pulls a payee's commission rate from the table and displays it in the report.
Imagine that the following information is contained in your commission rate table:

Table 32: Commission Rate Table

PayeeID Job Title Commission Rate
001 Account Executive 2%
002 Sales representative 4%
003 Account Executive 3%

You might create a stored value using the commission rate table as your source.

Presenter report data components 117

 Because the commission rate field contains the data that you want to display, the commission rate field is
selected as the Value Column. The payee ID is the primary key in the table, so you might use a payee
restricting parameter to pull the appropriate rate for the payee into the report. This value can then be
pulled into a report. If payee 001 is selected on the report, the resulting value is displayed on the report.

Adding calculated values

®
In IBM Incentive Compensation Management, you can use calculated values to perform calculations on
other numeric values in a Presenter report.

About this task

For example, if you have a numeric value that shows a payee's total sales and another value that displays
monthly quota, you might pull these two values into a calculated value that shows the percentage of
quota that was achieved.

Procedure
1. In Presenter, on the Data tab, place your cursor over Values and click the ellipsis.
2. Select Add Value.
3. Type a name for the value.
4. On the Calculated tab, add a formula by using the available sources.
5. Click Create.

What to do next
The result of the computed value can now be displayed on the report.

Adding constant values

®
In IBM Incentive Compensation Management, a constant value is a single value that is added to your
Presenter report. A constant value can be a date, text, or numeric value.

About this task

Constant values can be used as sources in calculated values. If you must calculate a numeric value that is
based on a value that does not change, you can use a constant value.

Procedure
1. In Presenter, on the Data tab, place your cursor over Values and click the ellipsis.
2. Select Add Value.
3. Type a name for the value.
4. On the Constant tab, from the Type drop-down list, select the type of constant value that you want to
create.
5. In the Value field, type the constant value.
6. Click Create.

Presenter report sources

®
You can use a source in IBM Incentive Compensation Management to pull relevant information together
into a single object that is well-structured for inclusion in a Presenter report. Sources can include any
combination of calculations, tables, parameters, and values.
Here's a short video that gives you a look at how to add data sources:

https://www.youtube.com/watch?v=FqKeYtgEKdk

118 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Imagine that you have the following pieces:
• A calculation that calculates total sales for each payee that is partitioned by payee, product, and month
• A calculation that calculates total commission paid to each payee that is partitioned by payee, product,
and month
• A calculated value that will show the total commission paid for the year
• A parameter that restricts by payee
• A parameter that restricts by product
You can pull all these items together into a Presenter report source. You can then add this source to a
data grid on the layout tab to show a report that contains value columns from each calculation, filters for
payee and product, and a computed cell that displays the sum of the values displayed.

Available data sources for Presenter sources

®
In IBM Incentive Compensation Management, in addition to tables, calculations, and data stores,
Presenter report sources can be created from Workflow Manager IDs, Portal Access inquiries, and
Presenter parameters.

Portal Access Inquiries source

®
In IBM Incentive Compensation Management, the Portal Access Inquiries source contains inquiry
information that can be reported on in a Presenter report.
You can use the Portal Access Inquiries source to create a custom report on inquiries. You can report on
the ID of the inquiry, the person who created the inquiry, the person who is assigned the inquiry, the date
the inquiry was created, updated, and closed, and the category of the inquiry. You can also use this source
to determine the age of an inquiry by using a computed column in a data grid and subtracting the Created
date column from the Updated date column.

Workflow Form ID
®
In IBM Incentive Compensation Management, in a Presenter report , the Workflow Form ID is an auto-
generated number that you can use to distinguish results that are submitted by a specific workflow.
The Workflow Form ID number can be used to restrict data submitted in a workflow that can be viewed
only by users who view the same workflow.
For example, if User A starts a workflow that submits Vacation Form 1 and User B starts a workflow that
submits Vacation Form 1, then the Workflow Form IDs can be used so that the manager of both User A
and B can view User A's vacation form without seeing User B's vacation form at the same time.
To build a report like this, you must enter the Workflow Form ID into a table when users are starting the
workflow. Then this table is used as the source of the data grid for the record approver and the source
must be restricted by the Workflow Form ID parameter.

Adding data sources

®
In IBM Incentive Compensation Management, any calculation, data store, or table from Composer as
well as Audit log information can be used as sources in your Presenter report.

Before you begin

You must be granted permission to access the Audit log in Presenter before you can add the Audit log as a
source.

Procedure
1. In Presenter, on the Data tab, place your cursor over Sources and click the ellipsis.
2. Select Add Source.
3. Click the Edit icon in the header to rename the data source.
4. On the Data sources tab, select the sources that you want to use to create this data source.

Presenter report data components 119

 Tip: You can use parameters that were created in Presenter as additional data sources.
5. On the Restrictions tab, define restrictions for the data sources.
Note: If you added a parameter as an additional source, you must define the parameter restriction. For
example, if you created a parameter that requires users to select a payee to generate the report, the
payee parameter must be linked to the payee ID in the source as follows: Payee Parameter ID =
Payee Source ID.
6. On the Select columns tab, complete the following steps:
a) From the Data Source pane, drag the columns that you want to display in the data source and place
them in the Edit columns pane.
b) In the Edit columns pane, click the column name to rename it.
This step is necessary if you have two columns with the same name. For example, if you joined two
calculations that both contain a value column, you must give one of your value columns a new
name.
Important: If you change the column name in this step, you do not change the display name of the
column on the actual report. To change the display name of the column on the actual report, use
the Data Grid wizard.
7. Click Create.

Transformations
®
In IBM Incentive Compensation Management, after you create an initial data source in a Presenter
report, you can use it to create transformations that transform the appearance of your source to present
the data in a different way.
The following transformations are available:
• Aggregate transformation
• Computed column
• Transpose
Important: When you create a transformation based on a data source, you create a brand new source.
The original source is not changed.

Adding aggregate transformations

®
In IBM Incentive Compensation Management, use aggregate transformations to create a new source that
performs a calculation on a set of data from the original source in a Presenter report.

Procedure
1. In Presenter, on the Data tab, expand Sources.
2. Place your cursor over the source that you want to use for the transformation and click the ellipsis.
3. Select Add Aggregate.
4. Select a numeric column within the source and apply a formula to it.
5. Click Next.
6. From the Data Source pane, drag the columns that you want to display as partitions to the Add
columns pane.
Tip: Use aggregate transformations to redefine the partitions of the original source to completely
change the rows and columns that are displayed. Values can then be applied to further refine the data.
7. Click Create.
8. Place your cursor over the new transformation and click the Edit icon to rename it.

Results
The result is a new source with an aggregated results column.

120 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Adding computed columns
®
In IBM Incentive Compensation Management, you can add a computed column to a source to append a
column to the source in a Presenter report. The data in the computed column is the result of applying a
formula to numeric columns in the original source. Numeric values can be pulled into the formula as well.

About this task

The following example shows a scenario for which you might use a computed column:
% Attainment Column
If your original source displays total sales for each payee, you might want to add a computed column
that displays their quota attainment percentage. In this case, your computed column displays the
results of a calculation that divides the sales amount by the quota amount.
Based on this example, your results might be comparable to the following computed column table:

Table 33: Original source

Payee Quota Sales
1 2000 1000
2 3000 2000
3 1000 1500

Table 34: Computed column

Payee Quota Sales % Quota Attainment
1 2000 1000 50%
2 3000 2000 67%
3 1000 1500 150%

Procedure
1. In Presenter, on the Data tab, expand Sources.
2. Place your cursor over the source that you want to use for the computed column and click the ellipsis.
3. Select Add Calculation.
4. In the New Column Name field, type a new column name.
5. Select a numeric column within the source and apply a formula to it.
6. Click Create.
7. Place your cursor over the new computed column and click the Edit icon to rename it.

Results
The result of a computed column transformation is a new source that displays the same information as
the original source, along with an additional column that displays results of your computation.

Adding transposes
®
In IBM Incentive Compensation Management, use a transpose to convert rows into columns to change
the way your data is displayed in a Presenter report.

About this task

Transposes can be helpful if the data that you want to present is displayed in a different format than the
final source results. Consider the following examples of table data:

Presenter report data components 121

Table 35: Original data
Payee Month Value
John Smith Month 1 10
John Smith Month 2 20
John Smith Month 3 30
John Smith Month 4 40
Jennifer Williams Month 1 15
Jennifer Williams Month 2 25
Jennifer Williams Month 3 35
Jennifer Williams Month 4 90

Table 36: Transpose original data

Payee Month 1 Month 2 Month 3 Month 4
John Smith 10 20 30 40
Jennifer Williams 15 25 35 90

Before the transpose functionality can be available, it needs an explicit key structure to work with. Create
an aggregated transformation of your source and partition by all of the columns. Then you can create a
transposed source from the original source.

Procedure
1. In Presenter, on the Data tab, expand Sources.
2. Place your cursor over the source that you want to use for the transpose and click the ellipsis.
3. Select Add Transpose.
4. From the Column to Transpose drop-down list, select the column that you want to convert.
5. In the New Column Name field, type the name for the new column.
6. From the Available Rows list, drag the rows that you want to transpose into columns and place them
in the New Columns pane.
7. Click Create.
8. Place your cursor over the new transpose and click the Edit icon to rename it.

Row form sources

®
In IBM Incentive Compensation Management, use a row form source to create an input row form that can
be used by web users to submit rows of data to a table from a Presenter report.
You can create a row form source from tables only. You can then use this source to create a data grid. The
data grid displays table data with an input row that is located before or after the data grid for web users to
submit data.
Optionally, report administrators can choose to display only the input row and not the table data.
Administrators can also choose whether to display this input row vertically or horizontally on the report.

122 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Adding row form sources
®
In IBM Incentive Compensation Management, add an input row form to a data grid to allow web users to
submit data through the Presenter report.

Procedure
1. In Presenter, on the Data tab, place your cursor over Editable Sources and click the ellipsis.
2. Select Add Row Form Source.
3. Click the Edit icon in the header to rename the row form source.
4. On the Data sources tab, select the sources that you want web users to be able to submit data to.
5. On the Restrictions tab, create restrictions to define the data that is visible to web users.
6. On the Select columns tab, complete the following steps :
a) From the Data Source pane, drag the columns that you want users to be able to view and use to
submit data and place them in the Add columns pane.
b) In the Add columns pane, click the column name to rename it.
Important: If you change the column name in this step, you do not change the display name of the
column on the actual report. To change the display name of the column on the actual report, use
the Data Grid wizard.
7. Click Create.

Presenter report data components 123

124 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 18. Presenter report layout and display
options
®
In IBM Incentive Compensation Management, after you create parameters, sources, and values for your
Presenter report, you can add layout tables and report components.

Layout tables
®
In IBM Incentive Compensation Management, after creating your Presenter report building blocks, you
are ready to start building the layout of your report. Layout tables help you to organize your report.
Although every report is different, you can use the following methodology as an example to lay out the
rows and columns in your Presenter report in a logical manner:
• Create a layout table with three rows and three columns. You use only the middle cell for the report, so
make the other cells as small as possible. The outside cells are used for padding.

• Add a nested table with five rows and one column in the center column.
• Add more nested tables to subdivide the rows as needed.

Adding layout tables

®
In IBM Incentive Compensation Management, you must create layout tables to contain the components
of your Presenter report.

Procedure
1. In Presenter, click the report canvas or a cell in the layout table that you want to add the layout table
to.
Important: You cannot merge cells and columns, but you can add nested tables into cells. You can
also resize cells by selecting the cell border and dragging the grid lines.
2. Expand the Layout Dimensions section in the sidebar and select the number of rows and columns for
your table.
3. Expand the Name section and type a name for the layout table.

© Copyright IBM Corp. 2005, 2018 125

 Tip: Naming the layout tables is useful when you create workflows in the Workflow Manager module.
As part of the workflow in Workflow Manager, you can select the layout tables in the report that you
want to be viewable and editable by web users.
4. Expand the Layout section and select the type of alignment that you want to use in the layout table.

Deleting layout tables

®
In IBM Incentive Compensation Management, you can remove a layout table from a Presenter report.

Procedure
1. In Presenter, from the breadcrumbs at the top of the screen, select the name of the layout table that
you want to delete.
If the layout table that you want to delete is not listed in the breadcrumbs, click a cell in the layout
table that you want to delete.
The layout table name is highlighted in the breadcrumbs and is outlined in red on the Presenter
canvas.
2. From the toolbar, click Delete.

Swapping two components in layout tables

®
You can swap two components in a layout table in a Presenter report in IBM Incentive Compensation
Management.

Procedure
1. Click one component that you want to swap.
2. Press Ctrl, and click the other component that you want to swap the first component with.
3. In the toolbar, click Swap.

Deleting layout table contents

®
In IBM Incentive Compensation Management, if you no longer want to display the contents of a cell in the
layout table in a Presenter report, you can delete the component.

Procedure
1. In Presenter, select the component in the layout table that you want to delete.
2. From the toolbar, click Delete.

Editing layout tables

®
In IBM Incentive Compensation Management, you can change the number of columns and rows in a
layout table in a Presenter report.

Procedure
1. In Presenter, from the breadcrumbs at the top of the screen, select the name of the layout table that
you want to edit.
If the layout table that you want to edit is not listed in the breadcrumbs, click a cell in the layout table
that you want to edit.
The layout table name is highlighted in the breadcrumbs and is outlined in red on the Presenter
canvas.
2. Use the sections in the left pane to make the required changes to the layout table.

126 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Resizing cells in layout tables
®
In IBM Incentive Compensation Management, you can resize the row heights and column widths of a
layout table in a Presenter report.

Procedure
In Presenter, drag the borders of the layout table cells to the size that you want.
A percentage of the layout table width or height is displayed.

Format Presenter components

®
In IBM Incentive Compensation Management, each component added to a Presenter report can be
formatted. The font, alignment, and padding can be changed and a border can be added around the
component.

Editing the font for components in layout tables

®
In IBM Incentive Compensation Management, you can edit the font, cell shading, and alignment of text
for each component in the layout table in your Presenter report.

Procedure
1. In Presenter, in the layout table, select a component to edit.
2. In the Font section in the left pane, set the format for the component.

Editing the alignment for components in layout tables

®
In IBM Incentive Compensation Management, you can set the alignment of a component within the cell
of the layout table in your Presenter report.

Procedure
1. In Presenter, in the layout table, select a component to edit.
2. In the Layout section on the left pane, set the alignment for the component.

Editing the border for components in layout tables

®
In IBM Incentive Compensation Management, you can add a border around components in your
Presenter report.

Procedure
1. In Presenter, in the layout table, select a component to edit.
2. In the Layout section on the left pane, under the Border heading, select the Custom check box.
3. From the numeric drop-down list, set the width of each border.
4. Use the color drop-down list to select a color for each border.

Editing the padding for components in layout tables

®
In IBM Incentive Compensation Management, you can specify the amount of space in pixels that you
want to display outside a component in your Presenter report.

Procedure
1. In Presenter, in the layout table, select a component to edit.
2. In the Layout section on the left pane, under the Padding heading, select Custom.
3. From the numeric drop-down list, set the padding in pixels.

Presenter report layout and display options 127

Presenter component links
®
In IBM Incentive Compensation Management, you can link a Presenter report to web forms, web pages,
or other Presenter reports by adding a link to a report component.
You can create a link from an image, text, or the contents of a report column. Links can be made to web
forms, web pages, Presenter reports, and parameters. You can set a link to a web form, web page, or
other report by using parameters. This functionality is available for text, numeric, and date values, both
directly in the layout and in a fixed grid.
When you link to another Presenter report or web form, you can select an associated web tab. On the
web client, when the user clicks the link to the web form or Presenter report, the associated web tab
opens. If no associated web tab is selected, then the Presenter report or web form is displayed on the
current web tab instead.

Linking a Presenter component to another Presenter report

®
In IBM Incentive Compensation Management, you can link an image, text, or the contents of a report
column to another Presenter report.

Procedure
1. In Presenter, in the layout table, select a component to add a link to.
2. In the sidebar, expand the section name of the component you are modifying.
For example, expand the Text section.
3. Under the Link heading, click the Edit Link icon.
4. Click the Report tab.
5. From the Report drop-down list, select the report that you want to link to.
6. From the Web Tab drop-down list, select the web tab that should open when a user clicks the report
link. Only web tabs that are associated with the selected report are displayed. If you want the report to
display in the current web tab, leave the Web Tab drop-down list blank.
7. From the Parameters list, select the parameters that you want to carry over from the linked report and
set the type of parameter and value for each parameter that you select.
8. Click Apply.

Linking a Presenter component to a web form

®
In IBM Incentive Compensation Management, you can link an image, text, or the contents of a column in
a Presenter report to a web form.

Procedure
1. In Presenter, in the layout table, select a component to add a link to.
2. In the sidebar, expand the section name of the component you are modifying.
For example, expand the Text section.
3. Under the Link heading, click the Edit Link icon.
4. Click the Web Form tab.
5. From the Web Form drop-down list, select the web form that you want to link to.
6. From the Web Tab drop-down list, select the web tab that should open when a user clicks the web
form link. Only web tabs that are associated with the selected report are displayed. If you want the
web form to display in the current web tab, leave the Web Tab drop-down list blank.
7. From the Parameters list, select the parameters that you want to carry over from the linked web form
and set the type of parameter and value for each parameter that you select.
When you link to a web form, you do not need to carry over the parameters. The filters that you created
in the web form are displayed in the Parameters list.

128 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 8. Click Apply.

Linking a Presenter component to a web page

®
In IBM Incentive Compensation Management, you can link an image, text, or the contents of a column in
a Presenter report to any HTTP, HTTPS, FTP, or MAILTO location.

Procedure
1. In Presenter, in the layout table, select a component to add a link to.
2. In the sidebar, expand the section name of the component you are modifying.
For example, expand the Text section.
3. Under the Link heading, click the Edit Link icon.
4. Click the Web Address tab.
5. Type the URL that you are linking to.
6. To add values to the URL, place your cursor over the value and click the Add icon.
7. Select the Open in a new window check box to open the web page in a new tab.
8. Click Apply.

Basic Presenter components

®
In IBM Incentive Compensation Management, you can add basic components to your Presenter report
such as, text, images, and document links.

Adding text
®
In IBM Incentive Compensation Management, you can add text to your Presenter report.

Procedure
1. In Presenter, on the Displays tab, expand Basics.
2. Drag the Text component and place it in a cell in a layout table.
3. Click the text component in the layout table.
4. Type the text that you want to add to the report.
5. Expand the Name section in the left pane and give the text component a name.
6. You can add a link to the text.
7. Set the format for the text component.

Setting the default font

®
In your Presenter report in IBM Incentive Compensation Management, you can set the default font and
size of the text.

About this task

The default font is applied automatically to any object with a configurable font that is added to the layout
table.

Procedure
1. In Presenter, in the toolbar, click Preferences.
2. Set the font, font size, style, and color that you want.
3. Click Save.

Presenter report layout and display options 129

Adding links to documents
®
In IBM Incentive Compensation Management, you can add a link to a document from a Presenter report.

About this task

The document must be added to the Manage Documents page.

Procedure
1. In Presenter, on the Displays tab, expand Basics.
2. Drag the Document Link component and place it in a cell in a layout table.
3. Click the document link component in the layout table.
4. Type the text for the document link. This field has a 1000 character limit.
5. Expand the Name section and give the document link component a name.
6. Expand the Document Link section in the left pane.
7. From the Available Documents drop-down list, select the document that you want to link to.
8. Set the format for the document link.

Adding images
®
In IBM Incentive Compensation Management, you can add a logo or other image to a Presenter report.

Procedure
1. In Presenter, on the Displays tab, expand Basics.
2. Drag the Image component and place it in a cell in a layout table.
3. Click the image component in the layout table.
4. Expand the Name section in the left pane and give the image component a name.
5. Expand the Image Display section.
6. Click Upload Image to locate the image on your computer.
7. You can add a link to the image.
8. Set the format for the image component.

Presenter data components

®
In IBM Incentive Compensation Management, after you create the structure of your Presenter report,
you can add data components such as text, numeric, and date values, and data grids and fixed grids.

Adding text value displays

®
In IBM Incentive Compensation Management, from any saved constant or stored value, you can add a
text value to a selected cell in your Presenter report.

Procedure
1. In Presenter, on the Displays tab, expand Data.
2. Drag the Text Value component and place it in a cell in a layout table.
3. Click the text value component in the layout table.
4. Expand the Name section in the left pane and give the text value component a name.
5. Expand Text Value.
6. From the Value Source drop-down list, select a source for the text value.
Any saved or constant values based on a text column can be selected.

130 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 7. Set the format for the text value.
8. You can add a link to the text value.

Adding numeric value displays

®
In IBM Incentive Compensation Management, you can add a numeric value display to add a numeric
value to a selected cell in your Presenter report.

Procedure
1. In Presenter, on the Displays tab, expand Data.
2. Drag the Numeric Value component and place it in a cell in a layout table.
3. Click the numeric value component in the layout table.
4. Expand the Name section in the left pane and give the numeric value component a name.
5. Expand the Numeric Value section.
6. From the Value Source drop-down list, select a source for the numeric value.
Any saved constant, calculated, or stored values based on a numeric column can be selected.
7. From the Type drop-down list, select the type of numeric value that you are creating.
8. From the Decimal Places drop-down list, select the number of decimal places that you want to display
in the numeric value.
9. Click the Conditional Formatting icon to set the format conditions for the numeric value display.
10.Set the format for the numeric value display.

Presenter report layout and display options 131

Adding date value displays
®
In IBM Incentive Compensation Management, you can add the current date to a selected cell in your
Presenter report.

Procedure
1. In Presenter, on the Displays tab, expand Data.
2. Drag the Date Value component and place it in a cell in a layout table.
3. Click the date value component in the layout table.
4. Expand the Name section in the left pane and give the date value display a name.
5. Expand the Date Value section.
6. From the Value Source drop-down list, select a source for the date value.
7. Select the date format.
Date Format Description
Long Date This displays the date in its entirety. For example, Monday, January 17, 2016.
Short Date This displays the date in numeric format. For example, 1/17/16.
8. Set the format for the date value.
9. You can add a link to the date value.

Adding data grids

®
In IBM Incentive Compensation Management, you can use data grids to display the results of a single
data source in a table in your Presenter report.

Before you begin

You must create sources on the Data tab before you can add data grids.

Procedure
1. In Presenter, on the Displays tab, expand Data.
2. Drag the Data Grid component and place it in a cell in a layout table.
3. Click the data grid component in the layout table.
4. Expand the Name section in the left pane and give the data grid a name.
5. Expand the Data Grid section.
6. From the Source drop-down list, select the Presenter report source that you want to display in the
data grid.
Tip: You can also drag the source from the Data tab and place it in the layout table to create the data
grid.
7. In the Add section in the left pane, you can perform the following actions:
• Add computed columns
• Add computed rows
• Manage templates
• Sort the data in the data grid and create section breaks
• Add validation rules for editable columns
8. In the Column Order section in the left pane, you can perform the following actions:
• reorder columns
• “Resetting the name of a data grid column” on page 146
• “Showing or hiding data grid columns” on page 143
9. In the Formatting Options section, you can perform the following actions:

132 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 • Format alternating rows
• Show grid lines
• Hide headers
10.In the Advanced Options section in the left pane, you can select the following options:
Advanced Option Description
Suppress Repeated Deletes any repeated group partitions.
Partitions
Show Section Headers Displays the headers for each section.
Enable Export to Enables web users to export the data grid to Microsoft Excel.
Microsoft Excel
Freeze Header Row Freezes the header row of the data grid so that it displays continuously
while a web user scrolls down the report.
Enable Inquiry Copy Enables web client users to copy a row of data from a data grid into an
inquiry.
Paginated Enables pagination for data grids on the web client. You can set the
default number of rows that are visible on each page on the web client.

Adding a data grid with an input row form

®
In your Presenter report in IBM Incentive Compensation Management, you can add a row with data
submission fields to a data grid. You can also display it alone so that web users can submit data to a table.

Before you begin

You must create row form sources on the Data tab before you can add this type of data grid.

Procedure
1. In Presenter, on the Displays tab, expand Data.
2. Drag the Data Grid component and place it in a cell in a layout table.
3. Click the data grid component in the layout table.
4. Expand the Name section in the left pane and give the data grid a name.
5. Expand the Data Grid section.
6. From the Source drop-down list, select the row form source that you want to display in the data grid.
Tip: You can also drag the row form source from the Data tab and place it in the layout table to create
the data grid.
7. In the Add section, click the Settings icon.
8. Select the Display only input row check box, to display only the input row and not the entire data grid.
9. If you select the Display only input row check box, you can choose to display the input row vertically
on the report by selecting the Show vertical check box.
10.Select the location of the input row.
11.Click the name of any column and from the Local drop-down list, select one of the following options:
Option Description
Blank The field is displayed as empty on the report. For each non-primary key column, you
can select Blank or an existing parameter to fill the input field.
Auto-Generate A new primary key is automatically created in the field.
Parameter An existing parameter can be used in the field. For each non-primary key column,
you can select Blank or an existing parameter to fill the input field.

Presenter report layout and display options 133

 12.If you have a pick list column, specify how a pick list input row is displayed by completing the following
steps:
a) Select the Configure Pick List check box.
b) From the Description drop-down list, select the field that you want to display as the description.
c) From the Sort drop-down lists, select to sort the pick list by the ID or by the Description and select
Ascending or Descending as the sort order.
d) Select the Hide ID Column if you do not want the ID to be displayed in the report.
e) Select the Hide Value for Export check box if you do not want the value to be displayed on a
published report.
13.Click Next.
14.Click Add a Validation Rule to add validation rules to the editable fields.
a) In the Column drop-down list, select the value column that you want to make the validation rule
for.
b) From the Operator drop-down list, select the operator for your validation rule.
c) To add the constraint, use the Value, Source, or Parameter tabs.
d) Click Save.
15.Continue to add validation rules or click Next.
16.To add filters to the pick list columns, complete the following steps:
a) Click Add a Pick List Filter.
b) From the Column to Filter drop-down list, select the pick list column that you want to filter.
c) Type a name for the filter.
d) Click Next.
e) Define the filter restrictions.
f) Click Add.
17.Click Save.

Adding fixed grids

®
In IBM Incentive Compensation Management, a fixed grid is a static number of rows and columns that is
used to display items in your Presenter report. You can use a fixed grid to display more than one value.

Procedure
1. In Presenter, on the Displays tab, expand Data.
2. Drag the Fixed Grid component and place it in a cell in a layout table.
3. Click the fixed grid component in the layout table.
4. Expand the Name section in the left pane and give the fixed grid a name.
5. In the Fixed Grid section in the left pane, you can perform the following actions:
• Set the number of rows and columns for the fixed grid.
• Select the Enable Export to Microsoft Excel check box, if you want payees to be able to export this
grid to Microsoft Excel through the web client.
6. Click a cell in the fixed grid.
7. In the Cell section in the left pane, select one of the following options from the Cell Content drop-
down list:
Cell content option Description
Empty Leaves the cell blank.
Pick List Adds a pick list control to the cell.
Source Adds a text value, numeric value, or date value to the cell.

134 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Cell content option Description
Submit Button Adds a submit button to the cell.
Text Use this option to add your own text to the cell.
Text Control Adds a text control to the cell.
8. Set the format for each cell.
9. Drag the border of any cell to resize the grid.
10.You can add a link to the fixed grid.

Adding a workflow dashboard

®
In IBM Incentive Compensation Management, you can include links to workflows that were created in the
Workflow Manager module to your Presenter report. When a web user clicks the workflow link in the
Presenter report, the workflow opens.

Procedure
1. In Presenter, on the Displays tab, expand Data.
2. Drag the Workflow Dashboard component and place it in a cell in a layout table.
3. Click the workflow dashboard in the layout table.
4. Expand the Name section in the left pane and give the workflow dashboard component a name.
5. Expand the Workflow Dashboard section and from the Status drop-down list, select the status of the
workflows that you want to display on the dashboard.
For example, if you want the dashboard to display links to pending workflows, select Pending from the
drop-down list.
6. Select the check boxes next to the column names that you want to add to the workflow dashboard.
7. Clear the Enable Headers check box, if you do not want to display headers on the workflow
dashboard.

Data grid display options

®
You can use configurable display options for data grids in a Presenter report in IBM Incentive
Compensation Management.
When you are adding a data grid, you can format the cells in the grid. Alternatively, you can select a
column or row and set other options.
You can specify report formatting, set conditional formatting, set alternating row fonts, or set links in your
data grid.

Expanding a data grid

®
In IBM Incentive Compensation Management, you can fit a data grid to the Presenter window to make it
easier to view all the columns.

Procedure
1. In Presenter, click the data grid that you want to expand.
2. In the right corner, click Fit Grid To Screen.

Presenter report layout and display options 135

Selecting columns in data grids
®
In IBM Incentive Compensation Management, when you set display options for a data grid in your
Presenter report, you can select one or more columns that you want to change.

Procedure
1. In Presenter, click the data grid in the layout table.
2. Place your cursor over the header of the column that you want to select and click the arrow.

The selected column is highlighted.

3. Repeat step 2 to select additional columns.

Adding computed columns to data grids

®
In IBM Incentive Compensation Management, you can add columns to a data grid to display the value of
simple math functions in your Presenter report. There is no limit to the number of computed columns that
you can add to a single data grid.

Procedure
1. In Presenter, click the data grid in the layout table.
2. Expand the Data Grid section in the left pane.
3. Under the Add heading, click the Add Computed Column icon.

4. In the data grid, place your cursor over the header of the new computed column and click the arrow to
select the column.
5. Expand the Computed Column section in the left pane.
6. Under the Add heading, click the Edit Formula icon.

136 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 7. In the Write a Formula pane, create the formula for the column using the available sources.
8. Click Save.

Adding computed rows to data grids

®
In IBM Incentive Compensation Management, you can add rows to a data grid to display the value of
simple math functions in your Presenter report.

Procedure
1. In Presenter, click the data grid in the layout table.
2. Expand the Data Grid section in the left pane.
3. Under the Add heading, click the Add Computed Row icon.

4. To add text to a cell in the computed row, click the cell and complete the following steps:
a) Expand the Computed Row section in the left pane.
b) Under the Add heading, click the Edit Formula icon.
c) In the User Defined Value pane, type the text that you want to display in the cell.
d) Click Save.
5. To add a formula to a cell in the computed row, click the cell and complete the following steps:
a) Expand the Computed Row section in the left pane.
b) Under the Add heading, click the Edit Formula icon.
c) Click the Formula tab.
d) In the Write a Formula pane, create the formula using the available sources.
e) Click Save.

Presenter report layout and display options 137

Setting the sort order for data grids
®
In IBM Incentive Compensation Management, after you add a data grid to your Presenter report, you can
select a source column to sort data by and set the sort type.

About this task

If a column is sorted at the time of data grid creation, it is not sortable in the web client. Columns must be
sorted separately for each section of the grid. Sorting does not extend beyond section breaks.

Procedure
1. In Presenter, click the data grid in the layout table.
2. Expand the Data Grid section in the left pane.
3. Under the Add heading, click Sort Selection.

4. Drag a column from the Available Sources pane to the Sort Order pane to sort the data.
You can select more than one column to sort by. Each column can only be used once.
5. In the Sort Order pane, change the order of the columns by dragging a column up or down the list.
The data is sorted by the column that is first in the list.
6. In the Sort Order pane, next to the column name, click the Edit icon.
7. From the Sort Order drop-down list, select either Ascending or Descending.
8. If you are sorting your data source by a date column from a table and you want to create section
breaks by time, select a calendar from the Calendar drop-down list to associate with the date column.
Important: You must select a calendar only if you are sorting your grid by a date column that does not
have a calendar that is associated with it. For example, you have a custom table with a date column
and you want to create a section break by time period. If you are not sorting your data grid by a date
column, you do not need to select a calendar. If you are sorting your data grid by a time partition, all
potential section breaks are associated with the calendar that is tied to the data grid source, and the
calendar menu is disabled.
9. Select the Add a Section Break check box to create a section break at the bottom of the data grid from
the sorted column.
10.Click Done.
11.Click Save.

Adding section breaks to data grids

®
In IBM Incentive Compensation Management, you can add a row based on a sorted column to the bottom
of a data grid in your Presenter report.

About this task

Section breaks can be made for any sorted column with these two exceptions:

138 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 • No column sorted after a numeric or date column will be eligible for a section break
• You cannot make a section break for a numeric type column

Procedure
1. In Presenter, click the data grid in the layout table.
2. Expand the Data Grid section in the left pane.
3. Under the Add heading, click Sort Selection.
4. Drag the column that you want to use as a section break from the Available Sources pane to the Sort
Order pane.
5. In the Sort Order pane, click the Edit icon next to the column name.
6. Select the Add a Section Break check box.
7. Select a cell in the section break and choose a source for the column from the No Source drop-down
list.

8. Repeat step 6 for each source you want to add to the section break.
9. Select a cell in the section break and use the toolbar to format, align, and select the shading for the
section break.
10.Click Done.
11.In the Sort Order pane, drag the section breaks to change their order.
Important: Section breaks display in the order that they appear in the window.
12.Click Save.

Adding editable columns to data grids

®
In IBM Incentive Compensation Management, you can allow web users to edit existing data in Composer
tables by adding editable columns in Presenter data grids.

Procedure
1. In Presenter, click the data grid in the layout table.
2. Place your cursor over the header of the column that you want to make editable and click the arrow to
select the column.

Presenter report layout and display options 139

 3. In the Column section in the left pane, under the Formatting Options heading, select the Toggle
Editable check box.

4. Add validation rules for the editable column.

What to do next
After you add an editable column to a data grid, you must add a submit button to the report.

Adding validation rules for editable data grid columns

®
In IBM Incentive Compensation Management, you can create a rule that validates the data that web
users submit through an editable column in a data grid or row form.

About this task

Validation rules are used to validate an aggregation of data for the whole data grid, such as a maximum or
minimum, average, or sum of all the data. If a web user enters data that does not follow the validation
rule, a user-defined error message displays when the user tries to submit the data.
For example, a regional sales manager might have a discretionary bonus of $1000 that he can distribute
among the members of his team as a reward for high performance. You can create a computed row in the
data grid to calculate the total amount of the bonuses that he distributes. Then, you can add a validation
rule to ensure that the total amount does not exceed $1000 before the regional sales manager can
submit the data.
The validation feature does not validate individual rows of data that a user enters into the data grid.

Procedure
1. In Presenter, click the data grid in the layout table.
2. In the data grid, place your cursor over the header of column that you want to add validation rules for
and click the arrow to select the column.
3. Expand the Column section in the left pane.
4. Under the Add heading, click the Validation Rules icon.

140 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 5. Click Add a Validation Rule.
6. In the Error Message field, type the message that you want web users to receive if they try to submit
invalid data.
7. Create a formula for the validation rule using the available sources.

8. Click Save.
9. Add any additional validation rules.
10.Click Save.

What to do next
You must add a submit button to reports with editable data grid columns.

Formatting data grid rows

®
In IBM Incentive Compensation Management, you can edit the format of the rows in the data grid of your
Presenter report.

Procedure
1. In Presenter, click the rows in the data grid in the layout table.
2. Expand the Data Grid section in the left pane.

Presenter report layout and display options 141

 3. Under the Formatting Options heading, clear the Alternating Rows check box.
4. Expand the Rows section in the left pane.
5. Under the Font heading, set the format for the rows.

Setting alternating row fonts in data grids

®
In IBM Incentive Compensation Management, you can define different formatting for odd and even rows
in your Presenter report. If you do not apply alternating row fonts, the same formatting is applied to all
rows.

Procedure
1. In Presenter, click the rows in the data grid in the layout table.
2. Expand the Data Grid section in the left pane.
3. Under the Formatting Options heading, select the Alternating Rows check box.
4. In the data grid, click the alternating rows.
5. Expand the Alternating Rows section in the left pane.
6. Set the format for the alternating rows.
7. In the data grid, click an unformatted row.
8. Set the format for the other set of alternating rows.

Showing grid lines

®
In IBM Incentive Compensation Management, by default, grid lines do not appear in data grids in your
Presenter report. You can set up your report to show grid lines.

Procedure
1. In Presenter, click the data grid in the layout table.
2. Expand the Data Grid section in the left pane.
3. Under the Formatting Options heading, select the Grid Lines check box.

Reordering data grid columns

®
In IBM Incentive Compensation Management, you can change the order that columns are displayed in
data grids in your Presenter report.

Procedure
1. In Presenter, click the data grid in the layout table.
2. Expand the Data Grid section in the left pane.
3. Expand the Column Order section.
4. Click the up or down arrows next to the column that you want to move to change the position of the
column in the data grid.

142 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Showing or hiding data grid columns
®
In IBM Incentive Compensation Management, you can enable a feature that allows web users to show or
hide data grid columns in Presenter reports. When web users export a data grid to a PDF file or Microsoft
Excel, only columns that are visible at the time of export are included.

About this task

Showing or hiding columns does not change the order of columns.

Procedure
1. In Presenter, click the data grid in the layout table.
2. Expand the Data Grid section in the left pane.
3. To hide the column so that it does not display in the data grid, in the Column Order section in the left
pane, click the ellipsis next to the column that you want to hide.
4. Click the Hide Column icon.

Presenter report layout and display options 143

 5. To initially hide the column when the user loads the report in the web client, but give the user the
option to show the column, perform the following steps:
a) Place your cursor over the header of the column and click the arrow to select the column.
b) Expand the Column section in the left pane, under the Formatting Options heading, select the
Initially Hide check box.

Hiding data grid headers

®
In IBM Incentive Compensation Management, you can choose not to display the headers of a data grid in
your Presenter report.

About this task

When you select this option, data grid headers are not displayed in the web client. This option applies to
the entire grid, not to specific columns.

Procedure
1. In Presenter, click the data grid in the layout table.
2. Expand the Data Grid section in the left pane.
3. Under the Formatting Options heading, select the Hide Headers check box.

Freezing the data grid header row

You can choose to lock the header row of a data grid so that it displays continuously as you scroll down
®
the Presenter report in the IBM Incentive Compensation Management web client.

About this task

You can set this feature independently for different data grids. The menu in the header remains frozen
along with the header if you select this feature. If you choose to suppress data grid headers, then the
freeze header row option is disabled.
This feature does not work when a user previews a Presenter report in the Incentive Compensation
Management client or when a user views the Incentive Compensation Management web client with
Internet Explorer 7 and 8.

Procedure
1. In Presenter, click the data grid in the layout table.
2. Expand the Data Grid section in the left pane.
3. Expand the Advanced Options section, and select the Freeze Header Row check box.

144 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Enabling data grid row copy into inquiries
®
In IBM Incentive Compensation Management, you can allow web client users to copy a row of data from
a data grid into an inquiry.

Procedure
1. In Presenter, click the data grid in the layout table.
2. Expand the Data Grid section in the left pane.
3. Expand the Advanced Options section, and select the Enable Inquiry Copy check box.

Results
When web users view the Presenter report in the web client, they can click the Copy icon next to a row in
the data grid to copy the data into the comment field of an inquiry.

Adding pagination to data grids

®
In IBM Incentive Compensation Management, you can enable pagination for data grids in your Presenter
report.

About this task

When you enable pagination for data grids, you can set the default number of rows that are visible on
each page on the web client. This feature is useful if you have a data grid with many rows.

Procedure
1. In Presenter, click the data grid in the layout table.
2. Expand the Data Grid section in the left pane.
3. Expand the Advanced Options section, and select the Paginated check box.
4. From the drop-down list, select the number of rows that you want to display on each page on the web
client.

Renaming a data grid column

®
In IBM Incentive Compensation Management, you can change the display name of a data grid column in
your Presenter report.

About this task

You can use special characters in the column header but the column name cannot end in an underscore.

Presenter report layout and display options 145

 Procedure
1. In Presenter, click the data grid in the layout table.
2. In the data grid, double-click the column name.
3. Type a new name for the column.

Resetting the name of a data grid column

®
In IBM Incentive Compensation Management, you can change the column name of a data grid back to its
original name in your Presenter report.

Procedure
1. In Presenter, click the data grid in the layout table.
2. Expand the Data Grid section in the left pane.
3. To reset the column name in the data grid, in the Column Order section, click the ellipsis next to the
column whose name you want to reset.
4. Click the Reset Column Name icon.

Results
The name of the column reverts to its original name.

Setting the width of a column

®
In IBM Incentive Compensation Management, you can change the width of data grid columns in your
Presenter report.

Procedure
1. In Presenter, click the data grid in the layout table.
2. In the data grid, click the header of the column that you want to format.
3. Drag the border of the column until you have reached the cell width that you want.

146 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Formatting data grid columns
®
In IBM Incentive Compensation Management, you can format headers and set the numeric format of
values in a data grid in your Presenter report.

Procedure
1. In Presenter, click the data grid in the layout table.
2. To format the header of a column, complete the following steps:
a) In the data grid, click the header of the column that you want to format.
b) In the Header section in the left pane, under the Font heading, set the format for the column
header.
c) Select the Apply to all headers check box to apply the format to the other column headers in the
data grid as well.
3. To edit a numeric column, complete the following steps:
a) In the data grid, place your cursor over the header of the numeric column and click the arrow to
select the column.
b) In the Column section in the left pane, from the Type drop-down list, select the type of numeric
column that you want to display.
c) In the Decimal Places field, set the number of decimal places that you want to display.

Setting conditional formatting

You can specify different text and numeric formatting for values in a data grid column of your Presenter
®
report in IBM Incentive Compensation Management when certain conditions are true. For example, when
a value in the results column is lower than a certain amount, you might want to display that value in red.

Procedure
1. In Presenter, click the data grid in the layout table.
2. In the data grid, place your cursor over the header of column that you want to add conditional
formatting and click the arrow to select the column.
Note: Conditional formatting can only be applied to numeric columns.
3. In the Column section in the left pane, under the Add heading, click the Conditional Formatting icon.
4. Click Add a Condition.
5. Create a condition by dragging available columns from the Available Sources pane.
Tip: To define multiple conditions, type AND(<condition1>,<condition2>). For example, type
AND(Source.YTDSales>= 0,Source.YTDCommission< 0).
6. Use the toolbar to indicate the formatting that you want to apply to values that meet the condition.
Tip: To make sure that the conditional formatting does not interfere with the alternate row formatting
of the data grid, set the cell shading color to transparent.

Presenter report layout and display options 147

 7. Click Add.
8. Repeat the preceding steps to add as many conditions as necessary. You can add multiple conditions
to a column.
9. Drag the conditions to arrange them in the order that you prefer. Formatting is applied in the order that
the conditions are listed.
10.When you finish adding conditional formatting, click Save.

Enabling text wrapping and alignment in columns

®
When you set display options for a data grid in your Presenter report in IBM Incentive Compensation
Management, you can enable text wrapping.

About this task

When enabling text wrapping in a data grid, you can set a maximum width for the column in pixels. If
there is space available for the entire table to be displayed on the page with out wrapping, then wrapping
is not used.

Procedure
1. In Presenter, click the data grid in the layout table.
2. In the data grid, place your cursor over the header of column that you want to enable text wrapping for
and click the arrow to select the column.
Tip: You can select more than one column at a time.
3. In the Column section in the left pane, select the Wrap check box.
4. In the numeric field, type the maximum width for the column.
5. From the drop-down list, select the type of alignment for the text in the column.

Showing the date and time in data grid columns

Users can display either date only or date and time for a date column in a data grid in your Presenter
®
report in IBM Incentive Compensation Management.

Procedure
1. In Presenter, click the data grid in the layout table.
2. In the data grid, place your cursor over the header of the date column and click the arrow to select the
column.
3. In the Column section in the left pane, from the Date drop-down list, select Date or Date Time.

148 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Results
When the date and time format is applied to the Audit.Time column, the recorded time is added to the
end of the date.
If the Date and Time option is selected for a date column that does not have a time, 12:00AM is
appended to each date.

Null numeric values in data grids

®
Null numeric values are displayed as empty in the data grid of your Presenter report in IBM Incentive
Compensation Management.
If a data grid contains an empty row (because it has null partitions or empty string partitions with null
numeric values), it is not displayed in the data grid.

How null values are handled in Presenter

®
The result of null values in your Presenter report in IBM Incentive Compensation Management might
vary, depending on the particular formula.

Table 37: Effects of using the null value

Formula Effect of using the null value
Add (x+y) If any argument is empty, the result is empty.
Divide (x/y) If any argument is empty, the result is empty. If the
denominator is 0, the result is 0.
Subtract (x-y) If any argument is empty, the result is empty.
Multiply (x*y) If any argument is empty, the result is empty.
Negation (-x) The negative of an empty value is empty.
Equal (x=y) If both operands are empty, then the result is True. If
only one operand is empty, then the result is False.
Not Equal (x!=y) If both operands are empty, the result is False. If
only one operand is empty, the result is True.
Greater (x>y) and (x>=y), Less(x<y) and If any operand is empty, then the result is False.
(x=<y)
AVG(x) The sum of non-empty items is divided by the count of
non-empty items.
COUNT(x) The count returns the number of rows.
MAX(x,y+) and MIN(x,y+) If all values are empty, it returns empty. Otherwise, it
returns the maximum or minimum of non-empty
values.
MAX(x) and MIN(x) These formulas get the aggregate maximum or
minimum. If all values are empty, they return empty.
Otherwise, they return the maximum or minimum of
all non-empty values.
MULT(x) If all values are empty, it returns empty. Otherwise, it
returns the result of multiplying all the non-empty
values.
SUM(x) This formula aggregates all the non-empty values and
returns their sum. If all values are empty, then the
result is empty.

Presenter report layout and display options 149

Table 37: Effects of using the null value (continued)
Formula Effect of using the null value
IF(x,y,z) This formula has the same behavior as version 7.1.0

AND(x,y+) and OR(x,y+) These formulas have the same behavior as version
7.1.0
NOT(x)

POW(x,y) If either value is empty, it returns empty.

PREV() If the previous value is empty, it returns empty.
For the first row, the PREV value is considered to be 0.

ROUND(x,y) and ROUNDDOWN(x,y) If either value is empty, it returns empty.

Data grid templates

®
In IBM Incentive Compensation Management, templates are used to apply formatting to selected data
grids in Presenter reports.
You can select a template as the default template for all data grids. When a data grid is created, it has the
same formatting as the default template. You can choose to apply a different template to a data grid after
it is created. The format that is set in the template does not affect any date, numeric, or conditional
formatting set in the data grid. If you have sections added in the data grid, you can edit styling of the
objects and display section headers for each record.

Adding data grid templates

®
In IBM Incentive Compensation Management, you can add a template that can be used to format data
grids in your Presenter report.

Procedure
1. In Presenter, click the data grid in the layout table.
2. In the Data Grid section in the left pane, under the Add heading, click the Manage Templates icon.

3. Click Create a New Template.

4. In the Name field, type a name for the template.
Template names must be unique, cannot contain more than 100 characters, cannot have leading or
trailing white space, and cannot contain special characters.
5. From the Style Properties drop-down list, select the row type that you want to format.
For example, select Header to set the format for the header row.
6. Use the toolbar to set the format for the selected rows.
7. From the Formatting Options list, select the options and type of formatting that you want to apply.

150 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 8. Click Create.

Editing data grid templates

®
In IBM Incentive Compensation Management, you can modify data grid templates in your Presenter
report.

About this task

When you make changes to a template, you can apply the changes to all data grids that use the template.
You must refresh Presenter to view the template changes.

Procedure
1. In Presenter, click the data grid in the layout table.
2. In the Data Grid section in the left pane, under the Add heading, click the Manage Templates icon.
3. From Templates list, place your cursor over the template that you want to modify and click the Edit
icon.
4. Make changes to the template.

Applying templates to data grids

®
In IBM Incentive Compensation Management, when you create a data grid in your Presenter report, you
can apply a template to the data grid.

Before you begin

You must create templates before they can be applied to the data grid.

Procedure
1. In Presenter, click the data grid in the layout table.
Tip: Use Ctrl and click to select more than one data gird to apply the template to.
2. In the Data Grid section in the left pane, under the Add heading, click the Manage Templates icon.
3. From the Templates list, select the template that you want to apply to the data grid.
4. Click Choose.

Presenter chart components

®
In IBM Incentive Compensation Management, you can add different types of charts to display data in
your Presenter reports.

Adding single series charts

®
In IBM Incentive Compensation Management, you can add a single series chart to display the results of
one source in a Presenter report.

Procedure
1. In Presenter, on the Displays tab, expand Charts.
2. Drag the Chart component and place it in a cell in a layout table.
3. Select Single Series.
4. Select a chart type and click Next.
5. Select the source that you want your chart to represent by completing the following steps:
a) From the Source drop-down list, select the Presenter source that you want to display in the chart.
b) In the Display Name field, type the name of the source.

Presenter report layout and display options 151

 c) From the Display Column drop-down list, select the column from the source that you want to
display on the x-axis.
d) From the Value Column drop-down list, select the column from the source that you want to display
on the y-axis.
e) Click Add.
6. If you want to create a link in the chart, place your cursor over the source and click the Edit Link icon.

7. Click Next.
8. Click Chart Title and complete the following steps:
a) Clear the Show Title check box if you do not want to display a title.
b) In the Chart Title field, type the title for the chart.
c) Set the format for the chart title.
9. Click Axis Title and complete the following steps:
a) Type the title for the x-axis.
b) Set the format for the x-axis title.
c) Click the Y-Axis tab.
d) Type the title for the y-axis.
e) Set the format for the y-axis title.
10.Click Axis Labels and complete the following steps:
a) Set the format for the x-axis values.
b) Select the Sort X-axis check check box to sort the X-axis and select either Ascending or
Descending as the sort order.
c) Click the Y-Axis tab.
d) Clear the Hide Value Labels check box to display values on the chart.
e) Select the Min/Max check box to set the minimum and maximum values for the y-axis.
f) Set the format for the y-axis.
g) If the single series chart you choose contains multiple colors, click the Colors tab and select the
Custom Color Scheme check box to add custom colors for the chart.
h) Click the Advanced tab.
i) In the Prefix and Suffix fields, type a character that you want to display before or after the value.
Typical examples include $ or %.
j) From the Decimal Separator drop-down list, select a decimal or comma for the displayed values.
k) From the Thousand Separator drop-down list, select a decimal or comma for the displayed results.
l) From the Decimal Places drop-down list, select the amount of numbers that you want to display
after the decimal in the results.
m) Select the Number Scaling check box to shorten larger values by adding K or M to the values (for
example, 50K instead of 50,013). If you do not select the Number Scaling check box, the full value
is displayed.
n) Select the Percentage check box to multiply the values by 100.
A percentage sign is not added to the value. If you want a percentage sign to be displayed, add the
sign to the Suffix field.

152 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 11.Click Next.
12.Click Create.
13.Expand the Chart section in the left pane to set the width and height in pixels for the chart.

Adding charts with no axes

®
In IBM Incentive Compensation Management, you can add and format a chart with no axes to display
results in a Presenter report.

Procedure
1. In Presenter, on the Displays tab, expand Charts.
2. Drag the Chart component and place it in a cell in a layout table.
3. Select a chart type with no axes and click Next.
4. Select the source that you want your chart to represent by completing the following steps:
a) From the Source drop-down list, select the Presenter source that you want to display in the chart.
b) In the Display Name field, type the name of the source.
c) From the Display Column drop-down list, select the column from the source that you want to
display on the x-axis.
d) From the Value Column drop-down list, select the column from the source that you want to display
on the y-axis.

Presenter report layout and display options 153

 e) Click Add.
5. If you want to create a link in the chart, place your cursor over the source and click the Edit Link icon.
6. Click Next.
7. Click Chart Title and complete the following steps:
a) Clear the Show Title check box if you do not want to display a title on the chart.
b) In the Chart Title field, type the title for the chart.
c) Set the format for the chart title.
8. Click Colors and complete the following steps:
a) Select the Custom Color Scheme check box.
b) Click Add a Color.
c) Click the Edit icon next to the color.
d) Choose a color or create a custom color.
e) Click Apply.
f) Click the Advanced tab.
g) In the Prefix and Suffix fields, type a character that you want to display before or after the value.
Typical examples include $ or %.
h) From the Decimal Separator drop-down list, select a decimal or comma for the displayed values.
i) From the Thousand Separator drop-down list, select a decimal or comma for the displayed results.
j) From the Decimal Places drop-down list, select the amount of numbers that you want to display
after the decimal in the results.
k) Select the Number Scaling check box to shorten larger values by adding K or M to the values (for
example, 50K instead of 50,013). If you do not select the Number Scaling check box, the full value
is displayed.
l) Select the Percentage check box to multiply the values by 100.
A percentage sign is not added to the value. If you want a percentage sign to be displayed, add the
sign to the Suffix field.
9. Click Legend and complete the following steps:
a) Select the Show Legend check box, to display a legend on the chart.
b) Set the format for the legend.
10.Click Next.
11.Click Create.
12.Expand the Chart section on the left to set the width and height in pixels for the chart.

Adding multi series charts

®
In IBM Incentive Compensation Management, you can add a multi series chart to display the results of
more than one source in a Presenter report.

Procedure
1. In Presenter, on the Displays tab, expand Charts.
2. Drag the Chart component and place it in a cell in a layout table.
3. Select Multi Series.
4. Select a chart type and click Next.
5. Select the sources that you want your chart to represent by completing the following steps:
a) From the Source drop-down list, select the Presenter source that you want to display in the chart.
b) In the Display Name field, type the name of the source.

154 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 c) From the Color drop-down menu, select the color that you want to represent this source in the
chart.
d) From the Display Column drop-down list, select the column from the source that you want to
display on the x-axis.
e) From the Value Column drop-down list, select the column from the source that you want to display
on the y-axis.
f) Click Add.
g) Click Add a Source to add an additional source for the chart and repeat steps 5a-e.
6. If you want to create a link in the chart, place your cursor over the source and click the Edit Link icon.

7. When you are done adding sources, click Next.

8. Click Chart Title and complete the following steps:
a) Clear the Show Title check box if you do not want to display a title.
b) In the Chart Title field, type the title for the chart.
c) Set the format for the chart title.
9. Click Axis Title and complete the following steps:
a) Type the title for the x-axis.
b) Set the format for the x-axis title.
c) Click the Y-Axis tab.
d) Type the title for the y-axis.
e) Set the format for the y-axis title.
10.Click Axis Lables and complete the following steps:
a) From the Orientation drop-down list, select the way in which you want the labels to display on the
x-axis.
b) Select the Sort X-axis check check box to sort the X-axis and select either Ascending or
Descending as the sort order.
c) Set the format for the x-axis values.
d) Click the Y-Axis tab.
e) Clear the Hide Value Labels check box to display values on the chart.
f) Select the Min/Max check box to set the minimum and maximum values for the y-axis.
g) Set the format for the y-axis.
h) Click the Advanced tab.
i) In the Prefix and Suffix fields type a character that you want to display before or after the value.

Presenter report layout and display options 155

 Typical examples include $ or %.
j) From the Decimal Separator drop-down list, select a decimal or comma for the displayed values.
k) From the Thousand Separator drop-down list, select a comma or period for the displayed results.
l) From the Decimal Places drop-down list, select the amount of numbers that you want to display
after the decimal in the results.
m) Select the Number Scaling check box to shorten larger values by adding K or M to the values (for
example, 50K instead of 50,013). If you do not select the Number Scaling check box, the full value
is displayed.
n) Select the Percentage check box to multiply the values by 100.
A percentage sign is not added to the value. If you want a percentage sign to be displayed, add the
sign to the Suffix field.
11.Click Legend and complete the following steps:
a) Select the Show Legend check box, to display a legend on the chart.
b) Set the format for the legend.
12.Click Next.
13.Click Create.
14.Expand the Chart section in the left pane to set the width and height in pixels for the chart.

Adding gauges
®
In IBM Incentive Compensation Management, you can create gauges to represent calculations that do
not contain partitions in a Presenter report. Gauges show the result of a calculation.

About this task

Gauges can be useful when you want to look at a total value. You need at least three numeric values to
create any gauge, including minimum, maximum, and current values.

Procedure
1. In Presenter, on the Displays tab, expand Charts.
2. Drag the Gauge component and place it in a cell in a layout table.
3. Select a gauge type.
4. Click Next.
5. From the Min Value Source drop-down list, select the source that contains the minimum values for the
gauge.
6. From the Max Value Source drop-down list, select the source that contains the maximum values for
the gauge.
7. From Current Value Source drop-down list, select the source that contains the current values for the
gauge.
8. Select the Show Trendpoint check box, and select a trend value source.
9. Click Next.
10.Click Ranges and complete the following steps:
Tip: Create three ranges such as weak, average, and strong. You must have a minimum of two ranges.
a) In the Label field, type a name for the range.
b) In the Minimum and Maximum fields, set the minimum and maximum number for the range.
c) From the Color drop-down list, select a color for the range.
d) Click the second color in the range to define its settings.

156 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 e) Click the Add icon to add an additional range.
11.Click Labels and complete the following steps:
a) Set the format for the ticks.
b) Click the Limits tab.
c) In the Lower Limit field type the minimum value for the gauge.
d) In the Upper Limit field type the maximum value for the gauge.
e) Set the format for the limits.
f) Click the Advanced tab.
g) In the Prefix and Suffix fields, type a character that you want to display before or after the value.
Typical examples include $ or %.
h) From the Decimal Separator drop-down list, select a decimal or comma for the displayed values.
i) From the Thousand Separator drop-down list, select a decimal or comma for the displayed results.
j) From the Decimal Places drop-down list, select the amount of numbers that you want to display
after the decimal in the results.
k) Select the Number Scaling check box to shorten larger values by adding K or M to the values (for
example, 50K instead of 50,013). If you do not select the Number Scaling check box, the full value
is displayed.
l) Select the Percentage check box to multiply the values by 100.
A percentage sign is not added to the value. If you want a percentage sign to be displayed, add the
sign to the Suffix field.
12.If you chose to add a trendpoint, click Trendpoint, and compete the following steps:
a) In the Label field, type a name for the trendpoint.
b) From the Color drop-down list, select a color for the trendpoint.
c) Set the format for the trendpoint.
13.Click Create.
14.Expand the Chart section in the left to set the width and height in pixels for the gauge.
15.Click the Link icon if you want the gauge to act as a link to another report, web form, or web page.

Presenter report layout and display options 157

Presenter control components
®
In IBM Incentive Compensation Management, you can add pick lists, text, and signature controls to filter
data displayed in your Presenter reports. You must add submit buttons to your report if you add one or
more of these control components.

Adding submit buttons

®
In IBM Incentive Compensation Management, you must add submit buttons for selecting parameters in a
Presenter report. Pick list and text controls require submit buttons for the selected or entered
parameters to populate.

Procedure
1. In Presenter, on the Displays tab, expand Controls.
2. Drag the Submit Button component and place it in a cell in a layout table.
3. Click the submit button in the layout table.
4. Type the text that you want to display on the button.
5. Expand the Submit Button section in the left pane.
6. Under the Font heading, set the format for the submit button.

Adding a pick list control

®
In IBM Incentive Compensation Management, you can create a pick list control to create a drop-down
menu in a Presenter report based on a source table. The item that the user selects from the list is used to
fill the selected parameter.

About this task

For example, if you add a pick list control based on the Payee table that fills a parameter based on payee
ID, the user selects the payee ID to render report information. You can configure pick lists to display ID,
description, or both in the drop-down menu. You can also set up the pick list to sort by either the
description or ID field in ascending or descending order.
You can filter pick list controls based on parameters selected in another pick list control.

Procedure
1. In Presenter, on the Displays tab, expand Controls.
2. Drag the Pick List component and place it in a cell in a layout table.
3. Click the pick list component in the layout table.
4. Expand the Pick List section in the left pane.
5. From the Source drop-down list, select the Presenter source that you want to use to populate the pick
list.
6. From the Description drop-down list, select the column from the source to display in the pick list.
7. From the Parameter drop-down list, select a parameter that this pick list fills.
8. From the Sort drop down lists, select either ID or Description to sort the data in the pick list by, and
select either Ascending or Descending for the sort order.
9. In the Font section, set the format for the pick list.
10.Select the Hide ID Column check box to show only the Description column in the pick list.
11.Select the Hide Value For Export check box to make sure that the pick list control is not displayed on
published reports.

158 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Adding signature controls
®
In IBM Incentive Compensation Management, you can add a signature control to add agreement text and
accept or reject options to a Presenter report.

About this task

Payees who access the report can either accept or reject the agreement text in the signature control.
Their responses are recorded in the Audit log. Each report can have many signature controls, which are
identified by their Signature ID. Reports with signature controls must also contain a submit button.

Procedure
1. In Presenter, on the Displays tab, expand Controls.
2. Drag the Signature component and place it in a cell in a layout table.
3. Click the signature component in the layout table.
4. Type the agreement text that you want to display on the report. There is a 4300 character limit to this
field.
5. Expand the Signature section in the left pane.
6. In the Font section in the left pane, set the format for the signature control.

Adding text controls

®
In IBM Incentive Compensation Management, you can add a text box in which a user can enter
information for a selected parameter in a Presenter report.

About this task

If you add a parameter to your Presenter report source, you must create a place on the report for the user
to select the parameter. You can do so by creating either a text control or a pick list control. For example,
if you add a text control that fills a parameter based on payee ID, the user can type the payee ID into the
box to render report information.
If you want web users to be able to perform a wildcard search of a data source for the value to enter in the
text control, you can set up the search in Presenter. To use a text control, you must have a submit button
on the form.

Procedure
1. In Presenter, on the Displays tab, expand Controls.
2. Drag the Text Control component and place it in a cell in a layout table.
3. Click the text control component in the layout table.
4. Expand the Text Control section in the left pane.
5. From the Fill Parameter drop-down list, select a parameter that is related to the text control.
6. Select the Hide Value For Export check box to make sure that the value is not displayed on a
published report.
7. To allow web users to type the exact value or use an asterisk to perform a wildcard search for a value
to enter in the text control, complete the following steps:
a) Select the Enable Wild Card Search check box.
b) Select the data source that contains the values that you want to search for in the text control.
c) Select the column of the data source that contains the values that you want to search for in the text
control.

Presenter report layout and display options 159

Preview Presenter reports
®
In in IBM Incentive Compensation Management, you can view how your Presenter report will be
displayed on the web client.
Here's a short video that gives you a look at how to preview a Presenter report:

https://www.youtube.com/watch?v=ocKj8_ZpprA

Previewing a Presenter report

®
In IBM Incentive Compensation Management, after you create a Presenter report, you can preview the
report to make sure that it will be displayed correctly in the web client.

Procedure
1. In Presenter, in the toolbar, click Preview.
2. Click the Set Parameters icon.
3. From the Current Web User drop-down menu, select the web user whose information you would like
to preview.
4. Select any parameters required for the report.
5. Click Save.

160 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 19. Web forms
®
Use web forms in IBM Incentive Compensation Management to create forms and enable them for web
review or data submission.
Web form creation begins with selecting the data sources that you want to use and the detail columns
that you want to display. Optionally, you can make any of the columns editable for the web user, or they
can be displayed for review only.
After you define the data that you want to display in the form, you can then create restrictions that limit
the information that is displayed to individual web users. For example, you might want to create a
restriction that allows web users to see only their own information.

Adding a web form

®
In IBM Incentive Compensation Management, a web form is a completely configurable grid. When you
create a web form, the content and design of the form is up to you.

Procedure
1. In Composer, navigate to the component where you want to add the web form.
2. From the Palette tab, drag the Web Form object into the component.
3. Type a name for the web form.
4. On the web form, click the Edit icon.

Web form filters

®
In IBM Incentive Compensation Management, you can define filters to restrict the web form data to a
certain subset of the results. For example, a web user might want to filter the data to display only rows for
a particular payee.
You can create and save as many filters as you like, and then apply them to specified web forms.

Defining simple filters

®
In IBM Incentive Compensation Management, simple filters in web forms provide web users control over
what is displayed on their screen, and users can filter data based on one column in one source table. For
example, you can create a simple filter that filters web form data based on job title.

Procedure
1. In your web form, from the toolbar, click Source Filters.
Important: You must define a filter for web forms with sources that have more than 1,000 rows of
data.
2. Click Add New.
3. Type a name for the filter.
4. From the Type drop-down list, select Simple.
5. From the Matching Operator drop-down list, select the operator that you want to use to define your
filter.
6. From the Display drop-down list, select the format for your filter. You can select a menu or an editable
field as the display for the filter.
7. Click Next.

© Copyright IBM Corp. 2005, 2018 161

 8. Select the table, the value column, and the name column that you want to use as the source for the
filter.

9. Click Add.

Defining Portal Access filters

®
In IBM Incentive Compensation Management, you can define a Portal Access filter in web forms to
display payee data based on a compensation plan's Portal Access hierarchy.

About this task

When you add a Portal Access filter, you must select a Portal Access plan hierarchy. The plan hierarchy is
determined by the access tree that is assigned to the plan in the Portal Access module.

Procedure
1. In your web form, from the toolbar, click Source Filters.
Important: You must define a filter for web forms with sources that have more than 1,000 rows of
data.
2. Click Add New.
3. Type a name for the filter.
4. From the Type drop-down list, select Portal Access.
5. From the Matching Operator drop-down list, select the operator that you want to use to define your
filter.
6. From the Display drop-down list, select the format for your filter. You can select a menu or an editable
field as the display for the filter.
7. Click Next.
8. Select a Portal Access hierarchy.

162 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 9. Click Add.

Defining custom filters

®
In IBM Incentive Compensation Management, the custom filter in web forms is a generic filter that is
completely customizable. Use custom filters to link a given set of sources to the web user to restrict result
rows without relying on the Portal Access hierarchy.

Procedure
1. In your web form, from the toolbar, click Source Filters.
Important: You must define a filter for web forms with sources that have more than 1,000 rows of
data.
2. Click Add New.
3. Type a name for the filter.
4. From the Type drop-down list, select Custom.
5. From the Matching Operator drop-down list, select the operator that you want to use to define your
filter.
6. From the Display drop-down list, select the format for your filter. You can select a menu or an editable
field as the display for the filter.
7. Click Next.
8. Select the source or sources for the filter.
9. Click Next.
10.Select the detailed columns by dragging one value column and one name column to the Add Columns
pane.
Important: The columns that you select determine the values that web form data can be sorted by.
11.Define any restrictions.
12.Click Add.

Web form sources

®
In IBM Incentive Compensation Management, you can use any calculated results or tables except the
Time table as data sources in your web forms.
When you add data sources, you can select the columns that are editable for the web user, or that are
displayed for review only. You can also create restrictions that limit the information that is displayed to
individual web users.

Adding sources to web forms

®
In IBM Incentive Compensation Management, you can add calculated results or tables as data sources in
your web forms.

Procedure
1. In your web form, drag the Source component onto your web form.
2. Add a data source or sources.
3. On the Restrictions tab, define any restrictions for the source.
For example, if you pulled in an ERP data table with a web user table, you can ensure that web users
can view only their own results by restricting on the payee ID: web user payee ID = source
data payee ID.
4. On the Select columns tab, drag columns that you want to display on your form to the Add columns
pane.
5. On the Validation rules tab, create any validation rules.

Web forms 163

 6. On the Filters tab, add any saved web form filters.
7. Click Create.

Adding validation rules to editable web form columns

®
In IBM Incentive Compensation Management, you can add and assign validation rules to put constraints
on the data that can be entered in editable web form columns.

About this task

Data can be restricted to a particular numeric, text or date value, or a web form source column.

Procedure
1. In your web form, add a source.
2. On the Validation rules tab, click Add New.
3. Select the table and column that is the source of the validation rule.
4. Select the Operator.
5. From the Value or Source tabs, complete the input rule.
6. Click Create.
Important: If calculation results are appended to a web form source, the joined calculated results can
be used to define the validation rule.

Adding a saved web form filter

®
In IBM Incentive Compensation Management, you can attach saved filters to your web form source.

Procedure
1. In your web form, add a source.
2. On the Filters tab, click Add Filter.
3. From the Available filters drop-down list, select a previously created filter.
4. Select the Source table and the Source column that the filter applies to.
5. Click Add.
Important: Before you can add filters to a web form, you must first define filters.

Web form row forms

®
In IBM Incentive Compensation Management, you can create row forms in web forms so that web users
can add rows to a table (as opposed to simply editing existing rows).
When you add rows to a row form, all fields are editable. If certain fields must be completed, you can add
a required flag to particular cells to let web users know that data must be entered in the field before they
can submit the row.

Adding row forms

®
In IBM Incentive Compensation Management, you can add row forms to web forms so that enabled users
can add records to a table.

Procedure
1. In the web form, drag the Row Form component onto the web form.
2. From the drop-down list, select the destination table. The destination table is the table that the rows
will be added to and can be a custom or structural table.
3. Create any validation rules.

164 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 4. Click Create.

Results
The rows are displayed in your web form.

Adding admin form columns

®
In IBM Incentive Compensation Management, you can add an admin form column to your web form.
After web users submit data through the web form, the admin form displays the data in a column where
an administrator can approve or reject the changes.

Before you begin

You must click Administrator approval required in the Web Form Options window. The admin form is
not displayed if results are submitted directly to the database.

Procedure
1. In Composer, enable the target table for web data edit.
2. In your web form, drag the Admin Forms component onto the web form.
3. Select the target table that you enabled for web data edit. Approval or rejection data of the changes on
this web form are sent to the table.
4. Click Create.

Adding JavaScript
®
In IBM Incentive Compensation Management, you can add JavaScript to a web form.

About this task

The JavaScript codes are displayed before the web form and are enclosed in the <script type="text/
javascript"> tag. You can also add JavaScript in web form cells.

Procedure
1. In the web form, from the toolbar, click the JavaScript icon.
2. Type or paste the JavaScript code into the JavaScript window. There is no limit of characters in the
JavaScript text box.
3. Click Done.

Adding web resources

®
In IBM Incentive Compensation Management, you can include company logos, other images, or links to
other websites in your web form.

Procedure
1. In your web form, drag the Web Resource component onto the web form.
2. Click the Image or Link tab.
3. Type the name of your web resource.
4. Type the URL for your image or link.
5. Click Create.

Web forms 165

Web form format
®
In IBM Incentive Compensation Management, you can customize the look and feel of your web forms.
You can edit the font, alignment, and shading of the cells in a web form. You can also change the width of
editable fields and set the cell span in web forms.

Setting the cell span

®
In IBM Incentive Compensation Management, you can configure the contents of a cell to cover a range of
cells in a web form.

Procedure
1. Click-and-drag your cursor to highlight the cells in the web form that you want the cell to span.
2. Drag the Cell Span component onto the highlighted cells.

Results
The cell span is outlined in red.

Formatting web forms

®
In IBM Incentive Compensation Management, you can edit the font, alignment, and shading of the cells
in a web form.

Procedure
1. In your web form, select the cells that you want to format.
2. In the toolbar, click the Format Cell icon.
Format the font, alignment, and shading of text in the selected cells.
3. Click Apply.

Copying and pasting web form cells

®
In IBM Incentive Compensation Management, you can move cells that contain text or data in web forms.

Procedure
1. Select the cells in the web form that you want to copy, from the toolbar, click the Copy icon.
2. Go to the paste location, from the toolbar, click the Paste icon.

Web form options

®
In IBM Incentive Compensation Management, you configure web form options and preferences such as
export filters and whether data submission requires administrator approval.
You can also specify whether the web form can be displayed on the web client before the options are set
and the number of rows and columns that are displayed to users.

Setting web form options

®
In IBM Incentive Compensation Management, you can specify web form options such as filters, export
filters, and whether data submission requires administrator approval. You can also specify whether the
web form can be displayed on the web client before the options are set.

Procedure
1. In the web form, from the toolbar, click Form Options.

166 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 2. Select the Do not show form until filter applied check box to display the filters after the web form is
chosen from the menu. The user then must select the filters and click Apply to produce the web form.
If you do not select the Do not show form until filter applied check box, the entire web form is
displayed as soon as the form is chosen.
3. In the Date Submission section, one of the following optios for data submission:
• If you select Administrator approval required, a model administrator must approve the changes
through Composer before the changes are committed to the database.
• If you select Direct to database, edits are made directly to the database. Because there is no
approval process, use caution when you select this option.
4. From the Export Filter drop-down list, select the filter that users must apply to view the web form.
5. Click Done.

Setting web form preferences

®
In IBM Incentive Compensation Management, you can specify the default number of rows and columns
that are displayed in the editor window of a web form.

Procedure
1. In the web form, from the toolbar, click Preferences.
2. Select the editor dimensions.
3. Select the Restrict payee selection when Portal Access Filter present check box, if you want the
payees available for selection in the web client to be determined by the Portal Access filter.
4. Click Done.

Web forms 167

168 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 20. Publisher
®
You can publish data from tables, calculations, Presenter reports, and web forms from IBM Incentive
Compensation Management to another application, such as Microsoft Excel.
You can schedule the following publications to run at predefined times in the Scheduler module:
• Tables in Composer that are published to Microsoft Excel, PDF file, Salesforce.com, or text delimited
files.
• Calculations in Composer that are published to Microsoft Excel, PDF file, Salesforce.com, or text
delimited files.
• Presenter reports published to PDF files, for example, batch exported PDF files for each payee or
exported PDF files for a selected payee.
• Web forms that are published to PDF files, for example, batch exported PDF files for each payee or
exported PDF files for a selected payee.

Defining the export tagline

You can define the tag line text that is displayed on a Microsoft Excel spreadsheet when the Send to
®
Microsoft Excel option is used in IBM Incentive Compensation Management.

Procedure
1. Click Admin > More Options.
2. On the General tab, in the Export Tagline field, type the text that you want displayed as the tag line.
3. Click Save.

Managing saved publications

You can view, edit, delete, or run any saved publication from the Manage Saved Publications window in
®
IBM Incentive Compensation Management.

Procedure
1. Click Admin > Manage > Saved Publications.
2. Place your cursor over the publication and click the ellipsis.
3. Click Edit, Delete, or Run.

Email publications
You can send publications through email on demand, or you can schedule them in the Scheduler module
®
in IBM Incentive Compensation Management.
You can schedule the publication of web forms and Presenter reports.
When you send publications through email, the following options are available:
• If you create a separate report for each payee, you can email each individual payee his or her own
report.
• You can specify an email address.
• You can select email addresses from the Payee table.

© Copyright IBM Corp. 2005, 2018 169

Publishing tables
®
You can publish data from tables in IBM Incentive Compensation Management directly to a Microsoft
Excel file, a PDF file, Salesforce.com table, or a text file.

Publishing tables to Microsoft Excel

®
You can publish data from tables in IBM Incentive Compensation Management directly to Microsoft Excel
files.

Procedure
1. Click the table.
A menu for the table displays on the right side of the window.
2. Select Show More.
3. Select Publish.
4. Choose one of the following options:
Option Description
One Time Publication Publish the file only once.
Saved Publication Saves the file to the server. If you choose this option, you can name and save
the publication to run at a later day through the Scheduler module.
5. Select Microsoft Excel as the destination for the published table.
6. Click Next.
7. In the Name field, type the title of the published file.
a) If you chose to save the publication, in the Prefix field, type any text that you want to add to the
filename of the saved publication.
8. Click Save.
9. Format the headers.
10.Click the Cells tab.
11.Format the cells.
12.If you are saving the publication, you can clear the Run this publish now check box if you want to save
the publication and run it at a later time.
13.Click Done.

What to do next
You can download the file from the Downloads page.

Publishing tables to PDF files

®
You can publish data from your IBM Incentive Compensation Management model directly to a PDF file.

Procedure
1. Click the table.
A menu for the table displays on the right side of the window.
2. Select Show More.
3. Select Publish.
4. Choose one of the following options:
Option Description
One Time Publication Publish the file only once.

170 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Option Description
Saved Publication Saves the file to the server. If you choose this option, you can name and save
the publication to run at a later day through the Scheduler module.
5. Select PDF as the destination for the published table.
6. Click Next.
7. In the Name field, type the title of the published file.
a) If you chose to save the publication, in the Prefix field, type any text that you want to add to the
filename of the saved publication.
8. Click Save.
9. Format the headers.
10.Click the Cells tab.
11.Format the cells.
12.Click Next.
13.Set the orientation and scaling for the PDF file.
14.Select the Use header image check box to display an image as the header on each PDF file and select
the image file from the drop-down list.
15.In the Footer field, type text to be included at the bottom of each page.
16.Select the Include page numbers check box to show page numbers in the footer.
17.Select the Show total page number check box to show the total number of pages in the document
along with the current page number.
18.If you are saving the publication, click Next and you can clear the Run this publish now check box if
you want to save the publication and run it at a later time.
19.Click Done.

What to do next
You can download the file from the Downloads page.

Publishing tables to text files

®
You can publish data from your IBM Incentive Compensation Management model directly to a text file.

Procedure
1. Click the table.
A menu for the table displays on the right side of the window.
2. Select Show More.
3. Select Publish.
4. Choose one of the following options:
Option Description
One Time Publication Publish the file only once.
Saved Publication Saves the file to the server. If you choose this option, you can name and save
the publication to run at a later day through the Scheduler module.
5. Select Text File as the destination for the published table.
6. Click Next.
7. In the Name field, type the title of the published file.
a) If you chose to save the publication, in the Prefix field, type any text that you want to add to the
filename of the saved publication.
8. Click Save.
9. Select a delimiter.

Publisher 171
 10.If you are saving the publication, click Next and you can clear the Run this publish now check box if
you want to save the publication and run it at a later time.
11.Click Done.

What to do next
You can download the file from the Downloads page.

Publishing tables to Salesforce.com

®
You can publish data from your IBM Incentive Compensation Management model directly to a
Salesforce.com table.

Procedure
1. In Salesforce.com, perform the following steps:
a) Select the Setup link.
b) Click Create > Objects from the App Setup section.
c) Select New Custom Object, and add the object according to your specifications.
2. In Composer, click the table.
A menu for the table displays on the right side of the window.
3. Select Show More.
4. Select Publish.
5. Choose one of the following options:
Option Description
One Time Publication Publish the file only once.
Saved Publication Saves the file to the server. If you choose this option, you can name and save
the publication to run at a later day through the Scheduler module.
6. Select Salesforce.com as the destination for the published table and click Next.
7. In the Name field, type the title of the published file.
a) If you chose to save the publication, in the Prefix field, type any text that you want to add to the
filename of the saved publication.
8. Click Save.
9. Type your user name, password, and security token, then click Connect.
10.Click Next.
11.Select the Salesforce.com table to export the data to.
12.Click Next.
13.Map the Composer table columns to the Salesforce.com table columns.
14.Click Done.

172 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Publishing calculations
®
You can publish data from calculations in IBM Incentive Compensation Management directly to a
Microsoft Excel file, a PDF file, Salesforce.com table, or a text file.

Publishing calculations to Microsoft Excel files

®
You can publish calculation data from your IBM Incentive Compensation Management model directly to a
Microsoft Excel file.

Procedure
1. Click the calculation.
A menu for the calculation displays on the right side of the window.
2. Select Publish Calculation from the menu.
3. Choose one of the following options:
Option Description
One Time Publication Publish the file only once.
Saved Publication Saves the file to the server. If you choose this option, you can name and save
the publication to run at a later day through the Scheduler module.
4. Select Microsoft Excel as the destination for the published calculation.
5. Click Next.
6. In the Name field, type the title of the published file.
a) If you chose to save the publication, in the Prefix field, type any text that you want to add to the
filename of the saved publication.
7. Click Save.
8. Format the headers.
9. Click the Cells tab.
10.Format the cells.
11.If you are saving the publication, you can clear the Run this publish now check box if you want to save
the publication and run it at a later time.
12.Click Done.

What to do next
You can download the file from the Downloads page.

Publishing calculations to PDF files

®
You can publish calculation data from your IBM Incentive Compensation Management model directly to a
PDF file.

Procedure
1. Click the calculation.
A menu for the calculation displays on the right side of the window.
2. Select Publish Calculation from the menu.
3. Choose one of the following options:
Option Description
One Time Publication Publish the file only once.
Saved Publication Saves the file to the server. If you choose this option, you can name and save
the publication to run at a later day through the Scheduler module.

Publisher 173
 4. Select PDF as the destination for the published calculation.
5. Click Next.
6. In the Name field, type the title of the published file.
a) If you chose to save the publication, in the Prefix field, type any text that you want to add to the
filename of the saved publication.
7. Click Save.
8. Format the headers.
9. Click the Cells tab.
10.Format the cells.
11.Click Next.
12.Set the orientation and scaling for the PDF file.
13.Select the Use header image check box to display an image as the header on each PDF file and click
Browse to locate the image file.
14.In the Footer field, type text to be included at the bottom of each page.
15.Select the Include page numbers check box to show page numbers in the footer.
16.Select the Show total page number check box to show the total number of pages in the document
along with the current page number.
17.If you are saving the publication, you can clear the Run this publish now check box if you want to save
the publication and run it at a later time.
18.Click Done.

What to do next
You can download the file from the Downloads page.

Publishing calculations to text files

®
You can publish calculation data from your IBM Incentive Compensation Management model directly to a
text file.

Procedure
1. Click the calculation.
A menu for the calculation displays on the right side of the window.
2. Select Publish Calculation from the menu.
3. Choose one of the following options:
Option Description
One Time Publication Publish the file only once.
Saved Publication Saves the file to the server. If you choose this option, you can name and save
the publication to run at a later day through the Scheduler module.
4. Select Text File as the destination for the published calculation.
5. Click Next.
6. In the Name field, type the title of the published file.
a) If you chose to save the publication, in the Prefix field, type any text that you want to add to the
filename of the saved publication.
7. Click Save.
8. Select a delimiter.
9. If you are saving the publication, you can clear the Run this publish now check box if you want to save
the publication and run it at a later time.
10.Click Done.

174 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 What to do next
You can download the file from the Downloads page.

Publishing calculations to Salesforce.com

®
You can publish calculation data from your IBM Incentive Compensation Management model directly to
Salesforce.com.

Procedure
1. In Salesforce.com, perform the following steps:
a) Select the Setup link.
b) Click Create > Objects from the App Setup section.
c) Select New Custom Object, and add the object according to your specifications.
2. In Composer, click the calculation.
A menu for the calculation displays on the right side of the window.
3. Select Publish Calculation from the menu.
4. Choose one of the following options:
Option Description
One Time Publication Publish the file only once.
Saved Publication Saves the file to the server. If you choose this option, you can name and save
the publication to run at a later day through the Scheduler module.
5. Select Salesforce.com as the destination for the published calculation and click Next.
6. In the Name field, type the title of the published file.
a) If you chose to save the publication, in the Prefix field, type any text that you want to add to the
filename of the saved publication.
7. Click Save.
8. Type your user name, password, and security token, then click Connect.
9. Click Next.
10.Select the Salesforce.com table to export the data to.
11.Click Next.
12.Map the Composer calculation columns to the Salesforce.com table columns.
13.Click Done.

Publishing Presenter reports

®
You can publish Presenter reports from IBM Incentive Compensation Management as PDF files. Before
you publish a Presenter report, make sure that you selected the appropriate PDF options and
preferences.

Selecting publishing preferences

®
When you are ready to publish your Presenter report in IBM Incentive Compensation Management, you
can specify your publishing preferences.

About this task

Options that you select in the Preferences window are displayed in the Preview tab.

Procedure
1. In Presenter, click the Preferences icon.

Publisher 175
 2. In the Font section, you can set the default font for the report.
3. Select the Accessible by report list check box to make a report accessible from the available report
menu in the web client.
4. Select the Allow PDF export check box so that web users can generate PDF files of the Presenter
report from the web client. If the report has a payee list, the web user can publish reports for each
payee to a PDF file.
5. You can select a color for the background of the Presenter report from the Color menu.
6. Click Choose Image to select an image to display on the background of your Presenter report.
7. To edit an image, complete the following steps:
a) Click Remove Image to delete the image from the Presenter report.
b) From the Image Tile drop-down list, select how the image repeats: Vertically, Horizontally, Both,
or None.
c) From the Image Scroll drop-down list, select Scroll to have the image move when the user scrolls
down the report, or Fixed to have the image remain in the same position.
d) From the Image Position drop-down list, select Absolute to set the image location on the X and Y
axes in pixels, or select Percent to set the image location by percentage.
8. Click Save.

Publishing Presenter reports

®
In IBM Incentive Compensation Management, you can generate a Presenter report ss a PDF file for
specific payees. You can then save the PDF file to your computer or server.

Procedure
1. Open the Presenter report.
2. From the toolbar, click Publish.
3. Choose one of the following options:
Option Description
One Time Publication Publishes the report once.
Saved Publication Saves the publication. If you choose this option, you can name and save the
publication to run at a later day through the Scheduler module.
4. Click Next.
5. Type a name for the published report.
You can also define a prefix for the file name of each PDF file. By default, when you publish reports, the
file name consists of the report name, payee name, and date and time that the report was published to
a PDF file.
6. From the Portal Access Group drop-down list, select the group for which you want to generate
reports.
A report is created for each member in the Portal Access group.
7. If your Presenter report has parameters, select a value for each parameter from the drop-down list.
8. Click Next.
9. Set the options for the PDF file.
Option Description
Orientation You can choose either portrait or landscape orientations.
Use header image Select this check box to display an image as the header on each PDF file and
choose the image file. If you want to use a header image, the image must be in
the Saved Published Image Directory that is specified in the service
configuration file.

176 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Option Description
Scaling You can set the percentage scale for the report or enable auto scaling.
Footer In this field, type text to be included at the bottom of each page.
Include page Select this check box to show page numbers in the footer.
numbers
Show total page Select this check box to show the total number of pages in the document
number along with the current page number.
All statements in Select this check box to publish all the reports for each member of the
one PDF file selected Portal Access group in one PDF file. If you want to publish a separate
PDF file for each member of the selected Portal Access group, do not select
this option.
10.Click Next.
11.If you are saving the publication, you can select the following email options:
Email option Description
Email each payee their Select this option to email each payee in the Portal Access group
individual report their own report.
Email all reports to Select this option to email all reports to the selected payee in the
Payee table.
Email all reports to the Select this option to email all reports to the entered addresses.
following addresses Each email address must be on a separate line.
12.If you are saving the publication, you can clear the Run this publish now check box if you want to save
the publication and run it at a later time.
13.Click Done.

What to do next
You can download the file from the Downloads page.

Publishing web forms

®
In IBM Incentive Compensation Management, you can publish a web form as a PDF file.

Procedure
1. Open the web form.
2. In the toolbar, click Export.
3. Choose one of the following options:
Option Description
One Time Publication Publishes the report once.
Saved Publication Saves the publication. If you choose this option, you can name and save the
publication to run at a later day through the Scheduler module.
4. Click Next.
5. Type a name for the published web form.
You can also define a prefix for the file name of each PDF file.
6. From the Portal Access Group drop-down list, select the group for which you want to generate web
forms.
A web form is created for each member in the Portal Access group.
7. If your web form has parameters, select a value for each parameter from the drop-down list.

Publisher 177
 8. Click Next.
9. Set the options for the PDF file.
Option Description
Orientation You can choose either portrait or landscape orientations.
Use header image Select this check box to display an image as the header on each PDF file and
choose the image file. If you want to use a header image, the image must be in
the Saved Published Image Directory that is specified in the service
configuration file.
Scaling You can set the percentage scale for the web form or enable auto scaling.
Footer In this field, type text to be included at the bottom of each page.
Include page Select this check box to show page numbers in the footer.
numbers
Show total page Select this check box to show the total number of pages in the document along
number with the current page number.
All statements in Select this check box to publish all the web forms for each member of the
one PDF file selected Portal Access group in one PDF file. If you want to publish a separate
PDF file for each member of the selected Portal Access group, do not select
this option.
10.Click Next.
11.If you are saving the publication, you can select the following email options:
Email option Description
Email each payee their Select this option to email each payee in the Portal Access group
individual report their own report.
Email all reports to Select this option to email all reports to the selected payee in the
Payee table.
Email all reports to the Select this option to email all reports to the entered addresses.
following addresses Each email address must be on a separate line.
12.If you are saving the publication, you can clear the Run this publish now check box if you want to save
the publication and run it at a later time.
13.Click Done.

What to do next
You can download the file from the Downloads page.

178 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 21. Activity tab
®
The Activity tracking tab in IBM Incentive Compensation Management opens automatically when you
run an activity such as an import, model optimization, migration, calendar lock or unlock, calculation, task
generation, or task run.
When you begin one of these processes, the Activity tab opens and tracks the progress of the process.
You can work in other modules while the process is running.
The Activity tab records up to 100 activity logs per user. However, running activities are shown only in the
session in which they were started. You can delete records of individual activities or all activities from the
tab. If an activity results in an error, you can view the details of the error message.
Important: Users are only able to see their own activities, not all activities that are completed in the
model.

Filtering activities
®
In IBM Incentive Compensation Management, you can filter the completed activities on the Activity page
by date or type of activity.

Procedure
1. On the Activity page, view the completed activities.
2. In the Choose a date field, you can select a date to filter the activities by.
3. Click the Filter icon to filter the activities by type.

Canceling running activities

®
In IBM Incentive Compensation Management, you can cancel a live activity on the Activity page.

Procedure
1. On the Activity page, view the activities in progress.
2. Click the Delete icon next to the activity that you want to cancel.

Viewing failed activity details

®
In IBM Incentive Compensation Management, you can view the details of activities that failed.

Procedure
1. On the Activity page, from the Show All drop-down list, select Show Errors.
2. Click View details next to the activity that failed.

© Copyright IBM Corp. 2005, 2018 179

180 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 22. Pulse
®
Use Pulse in IBM Incentive Compensation Management to view and share key information with payees
through prebuilt reports.
You can build the reports using table and calculation data stored in Composer.
Payees and managers can view their reports on the web client or through the iPad app. For more
information on the Incentive Compensation Management web client or Incentive Compensation
Management Mobile application, see the IBM Incentive Compensation Management Web Client User Guide
and the IBM Incentive Compensation Management Mobile User Guide.
Here's a short video that gives you an introduction to the Pulse module:

https://www.youtube.com/watch?v=ptnySeMGdkw

Pulse reporting hierarchy

®
In IBM Incentive Compensation Management, the reporting hierarchy for Pulse reports is determined by
the Payee table.
Payees are considered to be on an individuals team if the individual is listed in the Parent column for the
payee in the Payee table. Payees are also considered to be on an individuals team if their Parent value
eventually rolls up to the individual.
Imagine the following reporting hierarchy; Dan Huddle is an account executive. His regional manager is
Doug Karey, who reports to Kim Dawson, the Vice President of Sales. In this scenario, Dan Huddle is on
both Doug Karey and Kim Dawson’s teams.

Plans
®
In IBM Incentive Compensation Management, use plans in the Pulse module to organize your reports.
For example, you can create a plan that contains data for all payees in your organization. This type of plan
gives you a high-level overview of your business. You can then create additional plans for payees in
specific regions, such as a plan for payees in North America and a plan for payees in Europe.
Here's a short video that shows you how to add a plan in Pulse:

https://www.youtube.com/watch?v=Y4BSa6c4j8g

Adding plans
®
In IBM Incentive Compensation Management, create plans in the Pulse module to organize your reports.

Procedure
1. In Pulse, click Create Plan.
2. Type a name and description for the plan.
3. Choose a highlight color for the plan.
4. Click Save Changes.

What to do next
Set the calendar for the plan. See “Setting the calendar for Pulse plans” on page 182.

© Copyright IBM Corp. 2005, 2018 181

Setting the calendar for Pulse plans
®
In IBM Incentive Compensation Management, each plan in Pulse must be associated with a calendar in
your model.

About this task

The calendar that you select defines the intervals of time that the reports in this plan use to organize the
data.
The calendar that you select must be used by all calculations that are tagged in the reports in this plan.

Procedure
1. In Pulse, click the ellipsis in the plan for which you want to set the calendar, and click Edit.
2. From the Calendar drop-down list, select the calendar that you want to be associated with the plan.
3. From the Level drop-down list, select the level of the calendar that you want to be displayed in the
reports.
This is the lowest level that you want to aggregate data by in the reports. For example, if you want to
aggregate data in the reports by months, years, and all time, but not by periods, select Months as the
Level.
4. You can select a start date and end date for data that is displayed in the plan.
The data displayed in the reports is filtered by these dates. If you do not select a start and end date,
data for the entire range of the calendar is displayed.
5. Click Save Changes.

Setting the Pulse reports pay schedule

®
In IBM Incentive Compensation Management, in Pulse, you can set the pay schedule for payees. This
populates the operational metrics when you view the plan overview.

Procedure
1. In Pulse, click the ellipsis in the plan for which you want to set the pay schedule, and click Edit.
2. In the Interval section, use the drop-down lists to set the pay schedule for the payees in this plan.
3. In the Payday Starts field, you can set the date on which the pay schedule began.

182 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Editing plans
®
In IBM Incentive Compensation Management, you can make changes to your plans in the Pulse module.

Procedure
1. In Pulse, click the ellipsis on the plan that you want to modify, and select Edit.
2. Make your changes.
3. Click Save Changes.

Viewing plan overview

®
In IBM Incentive Compensation Management, you can view an overview of administrator reports in the
Pulse module.

About this task

Compensation administrators can view operational data on a day-to-day basis.

Procedure
1. In Pulse, place your cursor over the plan that you want to view and click Open.
2. Click the report that you would like to view.

Pulse reports
®
In IBM Incentive Compensation Management, the Pulse module contains several prebuilt reports that
you can use to share data that is stored in Composer with payees and managers.
Here's a short video that shows you how to map data to reports in Pulse:

https://www.youtube.com/watch?v=FjdFtgjGb4g

Pulse report data sources

®
In IBM Incentive Compensation Management, Composer table and calculation data is used to populate
Pulse reports.
Each prebuilt report in Pulse has a set of required data sources that must map to table or calculation
columns in your model. If you do not have tables or calculations similar to the following examples, you
must create them in Composer before you can successfully populate all the reports in Pulse.
If your data source is a calculation with a time partition, the calendar used by the time partition must be
the same as the calendar that you selected for the Pulse plan.
A Time column in a Pulse data source, can be mapped to a date column or time partition column. The
only exception to this is the Time column in the Transactions data source; it can only be mapped to a
date column.
Some Pulse data sources are used in more than one report. After you have mapped the data source in one
report, the same mapping is carried over to the other reports so you do not have to identify the same data
source in multiple reports. The following Pulse data sources must be mapped to tables or calculations in
Composer to create Pulse reports:
Credited Transactions
Credited Transactions are required in the Total Earnings report, the Payee vs Performance report,
the Performance Against OTE report, the Transaction Report, and the Team Performance Report. It
is used to access all the credited transactions for the selected plan. The table or calculation that that
contains the data for Credited Transactions must have the following columns:
• Transaction ID
• Payee

Pulse 183
 • Credit Value
The following calculation results table is an example of a calculation that can be a data source for
Credited Transactions.

Table 38: Credited Transactions calculation

TransactionID PayeeID Value
TR001 E1005 300004.00
TR010 E1013 574.00
TR011 E1013 644.00
TR012 E1012 347.00

Earnings
Earnings are required for the Total Earnings report, the Payee vs Performance report, the
Performance Against OTE report, the Earnings Report, and the Team Rankings Report. It is used to
access the earnings for all payees in the selected plan. The table or calculation that that contains the
data for Earnings must have the following columns:
• Payee
• Earnings Type
• Time
• Value
The following calculation results table is an example of a calculation that can be the data source for
Earnings.

Table 39: Earning calculation

PayeeID EarningsType Months Value
E1001 Product Revenue 2015, Month 02 966.00
E1001 Product Revenue 2015, Month 06 982.00
E1010 Services Revenue 2015, Month 07 167.00
E1010 Services Revenue 2015, Month 06 149.00
E1100 Product Revenue 2015, Month 11 330.00

Qualified Transactions
Qualified Transactions are required for the Total Earnings report. It is used to access the qualified
transactions for all payees in the selected plan. The table or calculation that contains the data for
Qualified Transactions must have the following columns:
• TransactionID
• Payee
The following calculation results table is an example of a calculation that can be the data source for
Qualified Transactions.

Table 40: Qualified Transactions calculation

TransactionID PayeeID Value
TR001 E1005 223.00
TR010 E1013 520.00
TR011 E1013 477.00

184 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 40: Qualified Transactions calculation (continued)
TransactionID PayeeID Value
TR012 E1012 707.00

Quota Targets
Quota Targets are required for the Total Earnings report and the Team Performance Report. It is
used to access the quota targets for all payees in the selected plan. The table or calculation that
contains the data for Quota Targets must have the following columns:
• Payee
• Quota Type
• Time
• Value
The following calculation results table is an example of a calculation that can be the data source for
Quota Targets.

Table 41: Quota Targets calculation

PayeeID QuotaType Months Value
E1001 Product Quota 2015, Month 01 875.00
E1001 Services Quota 2015, Month 06 510.00
E1001 Product Quota 2015, Month 02 355.00
E1001 Services Quota 2015, Month 04 241.00

Transactions
Transactions are required for the Total Earnings report, the Payee vs Performance report, the
Performance Against OTE report, the Transactions Report, and the Team Performance Report. It is
used to access the transactions for all payees in the selected plan. The table or calculation that
contains the data for Transactions must have the following columns:
Note: The Time task in this task group can only be mapped to a date column and not to a time
partition column.
• TransactionID
• Transaction Type
• Time
• Value
The following table is an example of a table that can be the data source for Transactions.

Table 42: Transactions table

TransactionID TransactionType Time Value Payee
TR001 Product Revenue 5/22/2015 223.00 E1005
TR010 Services Revenue 12/27/2015 520.00 E1013
TR011 Product Revenue 8/19/2015 477.00 E1013
TR012 Services Revenue 8/17/2015 707.00 E1012

Bonus
Bonus is required for the Earnings Report. It is used to access the bonuses for all payees in the
selected plan. The table or calculation that contains the data for Bonus must have the following
columns:

Pulse 185
 • Payee
• Bonus Type
• Time
• Value
The following calculation results table is an example of a calculation that can be the source for Bonus.

Table 43: Bonus calculation

PayeeID BonusType Months Value
E1001 Services Quota Bonus 2015, Month 04 77.00
E1001 Product Quota Bonus 2015, Month 09 764.00
E1001 Product Quota Bonus 2015, Month 11 681.00
E1001 Services Quota Bonus 2015, Month 08 85.00

Commission
Commission is required for the Earnings Report. It is used to access the commission for all payees in
the selected plan. The table or calculation that is the data source for Commission must have the
following columns:
• Payee
• Transaction ID
• Commission Type
• Time
• Value
The following calculation results table is an example of a calculation that can be the data source for
Commission.

Table 44: Commission calculation

PayeeID TransacationID CommissionType Months Value
E1001 TR023 Base Commission 2015, Month 07 567.00
E1001 TR026 Salary Guarantee 2015, Month 02 64.00
E1001 TR031 Salary Guarantee 2015, Month 09 270.00
E1001 TR037 Base Commission 2015, Month 02 510.00

Manual Payout Adjustments

Manual Payout Adjustments is required for the Earnings Report. It is used to access the plan
adjustments for all payees in the selected plan. The table or calculation that is the source for Manual
Payout Adjustments must have the following columns:
• Payee
• Adjuster
• Comment
• Time
• Value
The following calculation results table is an example of a calculation that can be the source for
Manual Payout Adjustments.

186 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 45: Manual Payout Adjustments calculation
PayeeID PayeeID2 Comment Months Value
E1001 E1011 Top Earner 2015, Month 03 500.00
E1001 E1014 Top Earner 2015, Month 12 500.00
E1001 E1003 Top Earner 2015, Month 10 500.00
E1001 E1006 Top Earner 2015, Month 04 500.00

Actuals
Actuals are required for the Team Performance Report and the Team Rankings Report. It is used to
access the actuals for all payees in the selected plan. The table or calculation that is the source for
Actuals must have the following columns:
• Payee
• Actuals Type
• Time
• Value
The following calculation results table is an example of a table that can be the source for Actuals.

Table 46: Actuals calculation

PayeeID Actuals TypeID Months Value
E1001 Product Revenue 2015, Month 11 217.00
E1001 Services Revenue 2015, Month 09 144.00
E1001 Product Revenue 2015, Month 02 271.00
E1001 Product Revenue 2015, Month 05 347.00

Performance
Performance is required in the Team Performance Report and the Team Rankings Report. It is used
to access the attainments for all payees in the selected plan. The table or calculation that contains the
data for Performance must have the following columns:
• Payee
• Performance Type
• Time
• Percentage
The following table is an example of a table that can be the source for Performance.

Table 47: Attainment calculation

PayeeID Attainment Type Months Value
E1001 Product Revenue 2015, Month 06 0.14
E1001 Services Revenue 2015, Month 10 0.10
E1010 Product Revenue 2015, Month 09 0.55
E1010 Services Revenue 2015, Month 12 0.76

Performance YTD
Performance YTD is required in the Performance Against OTE report. It is used to access the
attainments for all payees in the selected plan for the year-to-date. The table or calculation that
contains the data for Performance YTD must have the following columns:

Pulse 187
 • Payee
• Time
• Percentage
The following table is an example of a table that can be the source for Performance YTD.

Table 48: Attainment YTD calculation

PayeeID Months Value
E1001 2015, Month 06 0.14
E1001 2015, Month 10 0.10
E1010 2015, Month 09 0.55
E1010 2015, Month 12 0.76

Creating Pulse plan admin reports

®
In IBM Incentive Compensation Management, administrators can create a report that contains an
earnings chart, payee versus performance, and performance against on target earnings (OTE) for the
payees in the plan.

About this task

This report can only be viewed by administrators in Pulse.
To create this report, you must have the required data sources in Composer.

Procedure
1. Click the ellipsis on the plan that you want to create the report for, and click Edit.
2. Click the Reports tab.
3. Click the Admin Reports tab on the left pane.
4. Click the report that you want to create.
5. For each required source, complete the following steps:
a) Expand the source.
b) From the Choose a data source drop-down list, select the table or calculation that is the data
source.
c) In each of the Choose columns drop-down lists, select the column in the table or calculation that
contains the required data.

Creating a Pulse Transaction Report

®
In IBM Incentive Compensation Management, administrators can create reports that highlight payees'
performance by displaying their total transaction value, total transaction volume, allocated credits, and
transactions over time.

About this task

To create this report, you must have the required data sources in Composer.
This report can be viewed by payees and their managers on the web client and iPad app. For more
information, see the IBM Incentive Compensation Management Web Client User Guide and the IBM
Incentive Compensation Management Mobile User Guide.

Procedure
1. Click the ellipsis on the plan that you want to create the report for, and click Edit.

188 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 2. Click the Reports tab.
3. Click the Sales Reports tab on the left pane.
4. Click Transactions Report.
5. For each required source, complete the following steps:
a) Expand the source.
b) From the Choose a data source drop-down list, select the table or calculation that is the data
source.
c) In each of the Choose columns drop-down lists, select the column in the table or calculation that
contains the required data.

Creating a Pulse Earnings Report

®
In IBM Incentive Compensation Management, administrators can create reports that show payees' total
compensation broken down over time and broken down by commission and bonus categories.

About this task

This report also provides information on payees' sales versus earnings over time as well as total earnings,
commission, bonuses, and adjustments.
To create this report, you must have the required data sources in Composer.
This report can be viewed by payees and their managers on the web client and iPad app. For more
information, see the IBM Incentive Compensation Management Web Client User Guide and the IBM
Incentive Compensation Management Mobile User Guide.

Procedure
1. Click the ellipsis on the plan that you want to create the report for, and click Edit.
2. Click the Reports tab.
3. Click the Sales Reports tab on the left pane.

Pulse 189
 4. Click Earnings Report.
5. For each required source, complete the following steps:
a) Expand the source.
b) From the Choose a data source drop-down list, select the table or calculation that is the data
source.
c) In each of the Choose columns drop-down lists, select the column in the table or calculation that
contains the required data.

Creating a Pulse Team Performance Report

®
In IBM Incentive Compensation Management, administrators can create reports that highlight payees'
performance by displaying their quota, actuals, performance, and transaction count.

About this task

To create this report, you must have the required data sources in Composer.
This report can be viewed by managers on the web client and iPad app. For more information, see the IBM
Incentive Compensation Management Web Client User Guide and the IBM Incentive Compensation
Management Mobile User Guide.

Procedure
1. Click the ellipsis on the plan that you want to create the report for, and click Edit.
2. Click the Reports tab.
3. Click the Sales Reports tab on the left pane.
4. Click Team Performance Report.
5. For each required source, complete the following steps:
a) Expand the source.
b) From the Choose a data source drop-down list, select the table or calculation that is the data
source.
c) In each of the Choose columns drop-down lists, select the column in the table or calculation that
contains the required data.

Creating a Pulse Team Rankings Report

®
In IBM Incentive Compensation Management, administrators can create reports that display a team's
metrics, including sales targets, actuals, performance, compensation, and transaction count.

About this task

To create this report, you must have the required data sources in Composer.
This report can be viewed by managers on the web client and iPad app. For more information, see the IBM
Incentive Compensation Management Web Client User Guide and the IBM Incentive Compensation
Management Mobile User Guide.

Procedure
1. Click the ellipsis on the plan that you want to create the report for, and click Edit.
2. Click the Reports tab.
3. Click the Sales Reports tab on the left pane.
4. Click Team Rankings Report.
5. For each required source, complete the following steps:
a) Expand the source.

190 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 b) From the Choose a data source drop-down list, select the table or calculation that is the data
source.
c) In each of the Choose columns drop-down lists, select the column in the table or calculation that
contains the required data.

Pulse report access

®
Managers and payees must be granted access to Pulse plans before they can open the reports in the IBM
Incentive Compensation Management web client and iPad app.
Here's a short video that shows you how enable Pulse plans for viewing on the web client:

https://www.youtube.com/watch?v=WZlr7EkUTzo
The following steps outline the work flow to grant users web access to a Pulse plan:
1. In Portal Access, create web tabs for each Pulse plan that you want to grant web users access to. For
example, create a web tab for the North America 2015 plan.
2. Create the Portal Access groups that are required to define the access trees. For example, create a
Portal Access group that contains the managers of the North American payees and a second Portal
Access group for the North American payees.
3. Grant the Portal Access groups access to the web client.
4. Create Portal Access trees. You must create a tree that defines the reporting hierarchy and indicates
which Portal Access groups have access to the plan. You can also create a sign off and inquiry tree for
the plan.
5. Assign the Portal Access trees to the Pulse plan.

Pulse 191
192 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 23. Workflow Manager
The task of compensating sales forces typically involves the cooperation of many groups of individuals,
®
processes, and tools in a workflow. You can use Workflow Manager in IBM Incentive Compensation
Management to create and manage your workflows.
Processes in Workflow Manager are triggered by specific business events, rather than static times in a
calendar. Processes can also initiate communications to users and relay contextual information based on
the current state of the system.
For example, a Presenter report might specify compensation details for sales representatives. You can
create a workflow for the approval process of the compensation details in the Presenter report. All sales
representatives must approve or escalate their compensation details reports. If the report is escalated, it
is sent to their regional sales manager to make corrections. After the corrections are made, the report is
sent back to the sales representatives for approval.
At a high level, the following steps describe how to create a workflow:
1. Create a workflow.
2. Add swim lanes for each user or group of users who are involved in the workflow.
3. Create action, alert, and process nodes, or any combination of the nodes, for each step of the
workflow.
4. Connect the nodes to create the path for the workflow.
5. Start the workflow.

Workflows
®
In IBM Incentive Compensation Management, use workflows in Workflow Manager to create logic to
automatically push a Presenter report into the next required state, based on predefined business rules.
Each workflow is associated with one Presenter report and consists of a series of alert, action, and
process nodes that are linked together. The path that is created by linking the nodes together defines the
logical flow of the business process.
Here's a short video that shows you how to add a workflow in Workflow Manager:

https://www.youtube.com/watch?v=rkNejyD0mys
You can create the following types of workflows in Workflow Manager:
Admin-initiated workflow
Use this type of workflow to prevent users from submitting additional data until the original
submission is completed. After the original submission is completed, the administrator must start the
workflow again. For example, you can create an admin-initiated workflow for an MBO self-scoring
form in which a user submits scores for various objects that must be approved by a manager. The user
cannot submit more than one set of scores per quarter.
User-initiated workflow
Use this type of workflow to submit additional data, even if the originally submitted data has not yet
completed the workflow process. Each time that a user submits data, an instance of the workflow
starts. For example, you can create a user-initiated workflow for an expense report in which a user
must submit more than one expense at a time.

© Copyright IBM Corp. 2005, 2018 193

Adding a workflow
®
In IBM Incentive Compensation Management, the first step to creating a business process is to create an
admin-initiated or user-initiated workflow in Workflow Manager.

Procedure
1. In Workflow Manager, click Add workflow.

2. Select one of the following types of workflow:

Workflow type Description

User initiated This is a workflow where data can be submitted multiple times. Each time the
workflow user submits data an instance of the workflow kicks off.

Admin initiated This is a workflow where the user can only submit data once. After that, it is
workflow up to an admin to start the whole workflow over again.

3. Click the Edit icon next to the Add a workflow name heading to type a name and description for the
workflow.
4. On the Choose Report tab, complete the following steps:
a) Select the Presenter report to associate with the workflow.
b) To use the Presenter report's default value for a parameter, leave the Use report default value
check box selected.
c) To select or enter a different value for a parameter, clear the Use report default value check box,
and complete one of the following steps:
• To select the web user or form initiator for a parameter, select Value from the drop-down list next
to the parameter, and then select the value from the next menu.
• To specify a constant value for a parameter, select Constant from the drop-down list next to the
parameter, and then type the constant value in the field.
5. If you selected a user-initiated workflow, on the Layout Restrictions tab, complete the following
steps:
a) Clear the Visible check box next to any layout tables that you do not want to display on the
Presenter report.

194 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 b) Clear the Editable check box next to any layout tables that you do not want to be editable in the
Presenter report.
6. On the Type tab, select one of the following choices:
Type Description
Explicity select payees You can chose the payees that are part of the form initiator swim lane.
Select payees by You can set restrictions to define the payees that are part of the form
restrictions initiator swim lane .
7. On the Data Sources tab, add any additional data sources that are required to define the payee or
payee group that makes up the first swim lane. You can use any table or calculation with a payee
partition as a source.
8. On the Restrictions tab, define the restrictions for the payee or payees who make up the form initiator
swim lane.
9. If you selected Explicitly select payees, on the Payees tab, add or remove a payee or payees from the
form initiator swim lane.
10.Click Create.

Editing a workflow
®
In IBM Incentive Compensation Management, you can make changes to an existing workflow in
Workflow Manager.

About this task

To change the form initiator, you must edit the Form Initiator swim lane. If the workflow is in progress,
you can open the Workflow Manager wizard, but you cannot make any changes.

Procedure
1. In Workflow Manager, place your cursor over the workflow that you want to edit and click the ellipsis.

2. Select Edit Workflow.

3. Make your changes.

Deleting a workflow
®
In IBM Incentive Compensation Management, if a workflow is not in progress, you can remove it from
Workflow Manager.

Procedure
1. In Workflow Manager, place your cursor over the workflow that you want to delete and click the
ellipsis.
2. Select Delete Workflow.

Workflow Manager 195

Copying a workflow
®
In IBM Incentive Compensation Management, you can copy a workflow in Workflow Manager.

About this task

When you copy a workflow instance, the process copies the configuration of the workflow, such as the
workflow type and the linked Presenter report, along with the swim lanes and nodes. The process does
not copy the workflow state, such as errors, pending actions, or history, of any running workflows. You can
copy a running workflow, but a copied workflow is initially in a stopped state.

Procedure
1. In Workflow Manager, place your cursor over the workflow that you want to copy and click the
ellipsis.
2. Select Copy Workflow.
3. Click the ellipsis at the top of the list of workflows, or click the ellipsis next to the folder that you want
to paste the workflow in.

4. Select Paste Workflow.

5. Type a name for the copied workflow.
6. Click Paste.

Setting default parameters for a workflow

®
In IBM Incentive Compensation Management, if a group of payees is assigned to the form initiator swim
lane, you can select one payee to be the default form initiator in Workflow Manager. Default parameters
are useful when you create additional swim lanes, because you can preview the selected payees who are
defined by a restriction by using the form initiator.

Procedure
1. In Workflow Manager, open the workflow.
2. In the toolbar, click the Settings icon.
3. Select a form initiator from the list.

Starting a workflow
®
In IBM Incentive Compensation Management, an administrator must initiate workflows in Workflow
Manager.

Procedure
1. In Workflow Manager, open the workflow.
2. In the toolbar, click the Start icon.
Note: When a workflow is in progress, the Stop icon next to the workflow name in the left panel
becomes a Start icon.

196 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Adding payees after a workflow is started
®
In IBM Incentive Compensation Management, you can add payees to swim lanes in Workflow Manager
after a workflow has started.

Procedure
1. In Workflow Manager, start the workflow.
2. In the toolbar, click Add workflow payees.
3. If you used restrictions to define payees, click Yes in the window that opens.
Important: If you used restrictions to define payees, you can schedule the addition of workflow
payees in the Scheduler module.
4. If you selected Explicit User to define swim lane payees, in the Add Workflow Payees wizard, add
any sources to define the additional workflow payees.
5. Create the restrictions to define the additional payees who you want to add to the workflow.
6. Select the payees who you want to add to the workflow.

Organizing workflows
®
In IBM Incentive Compensation Management, to organize your workflows, you can create folders in the
Workflow Manager sidebar.

Procedure
1. In Workflow Manager, click the ellipsis at the top of the list of workflows.
2. Select Add Folder.
3. Place your cursor over the new folder and click the Edit icon to give it a name.
4. Drag workflows into the folder.
5. Add a sub-folder by completing the following steps:
a) Place your cursor over the folder that you want to add a sub-folder to and click the ellipsis.
b) Select Add Sub-Folder.

Searching for a workflow

®
In IBM Incentive Compensation Management, you can use the search field in Workflow Manager to find
a specific workflow.

Procedure
In Workflow Manager, in the Search field, type the name of the workflow that you want to find.

Swim lanes
®
In IBM Incentive Compensation Management, you must create swim lanes in Workflow Manager to
define the person or group who are expected to take action, or the person or group who receives a
notification as part of the business process.
For example, if a swim lane is defined as any payee with the title Sales Reps, then any notifications in
this swim lane are sent to payees with the title Sales Reps, or any forms in this swim lane must be
acted upon by payees with the title Sales Reps.
When a workflow is created, it contains two swim lanes by default. The two swim lanes are a System
swim lane and a Form Initiator swim lane.
The System swim lane contains start and end nodes for the workflow. This swim lane, and the nodes
inside it, are not configurable.

Workflow Manager 197

 The Form Initiator swim lane is configured based on the workflow initiators that were selected when the
workflow was created. The Form Initiator swim lane can be edited after the workflow is created and
additional swim lanes can be added.
Here's a short video that shows you how to add swim lanes in Workflow Manager:

https://www.youtube.com/watch?v=hgihebMcAhA

Editing the Form Initiator swim lane

®
In IBM Incentive Compensation Management, when you create a workflow in Workflow Manager, you
must define payees for the Form Initiator swim lane.

About this task

In an admin-initiated workflow, the Form Initiator is the payee who is expected to perform an action as
the first step of the workflow.
In a user-initiated workflow, the Form Initiator is the payee who is expected to start the workflow. You
can edit the Form Initiator after the workflow is created.

Procedure
1. In Workflow Manager, open the workflow.
2. Place your cursor over the Form Initiator swim lane name, and click the Edit icon.
3. You can rename the swim lane and type a description by clicking the Edit icon in the header.
4. You can define the payee or payees who make up this swim lane in one of the following ways:
Payee selection Description
type
Explicitly select Select the Explicitly select payees option if you want to select specific payees
payees who will be involved in the workflow step. Then, on the Payees tab, select the
payees who are involved in the first step of the workflow.
Select payees by Select the Select payees by restrictions option if you want to select a group of
restrictions payees who will be involved in a workflow step, based on a restriction. Then, on
the Data Sources tab, add the sources required to make the restriction, and on
the Restrictions tab, create the restriction to define the group of payees.
5. Click Create.

Adding a swim lane

®
In IBM Incentive Compensation Management, to define other payees who are involved in the Workflow
Manager process, you can add additional swim lanes to the workflow.

Procedure
1. In Workflow Manager, open the workflow.
2. Click Add swim lane.
3. Type a name and description for the swim lane.
4. Add any tables, the current date, Presenter report parameters, or calculations that include a payee
partition to define your source.
5. On the Restrictions tab, create restrictions to define the payees who are involved.

198 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 6. Click Create.

Deleting a swim lane

®
In IBM Incentive Compensation Management, you can delete swim lanes from the workflow in Workflow
Manager, along with any nodes that are contained in the swim lane.

Procedure
1. In Workflow Manager, open the workflow.
2. Place your cursor over the name of the swim lane that you want to delete and click the Delete icon.

Adding and removing columns in swim lanes

®
In IBM Incentive Compensation Management, you can add or delete columns in a swim lane in Workflow
Manager.

About this task

Each workflow can contain a maximum of 32 columns.

Procedure
1. In Workflow Manager, open the workflow.
2. You can perform the following steps to create the number of columns required for the workflow:
• To remove an extra column, place your cursor over the column and click the Delete icon.
• To add a column, place your cursor over a column and click the Add icon to the left or to the right of
the column.

Nodes
®
In IBM Incentive Compensation Management, in addition to swim lanes, a workflow in Workflow
Manager also contains a series of nodes. Each node represents a step in the workflow that notifies
payees, requires payees to take action, or requires the system to run an action.
Here's a short video that shows you how to add nodes in Workflow Manager:

Workflow Manager 199

 https://www.youtube.com/watch?v=QW0xV93qBCQ
There are several types of nodes.
Start node
This node is added by default when a workflow is created and defines the beginning of the workflow.
End node
This node is added by default when a workflow is created and defines the end point of the workflow.
Alert node
Use this node to send customizable notifications to users by email or through web messages that are
delivered to the web client. You can use this type of node to notify specific users or groups of users
when a workflow requires their input or action to proceed.
Action node
This node defines the path that the workflow takes, based on an action that is taken by a user. Each
action node contains action paths that are associated with a Presenter report and different routes in
the workflow. For example, if a user has the choice to either approve or cancel a report, the action
node defines a different workflow path that is followed based on which option the user selects.
Process node
This node runs a saved Scheduler process. The scheduled process runs only when the Scheduler is
refreshed. By default, Scheduler refreshes every hour. The Scheduler user must not be logged into
the client at the same time.
Conditional node
This node routes users to different paths in the workflow, depending on defined conditions.
After the nodes for the workflow are created in the appropriate swim lanes, you can then connect them to
create the workflow process.

Editing the Start node

You can edit the Start node so that users can submit report data and move the report to the next step in
®
the workflow from the IBM Incentive Compensation Management web client.

Procedure
1. In Workflow Manager, open the workflow.
2. Place your cursor over the Start node and click the Edit icon.
3. Select the Submit when selected check box.
4. Click Save.

Adding alert nodes

®
You can use an Alert node to notify payees or groups of payees through the IBM Incentive Compensation
Management web client or by email when a Presenter report requires their input as part of a workflow.
You can also configure an Alert node to send emails to users who are not involved in the workflow.

Procedure
1. In Workflow Manager, open the workflow.
2. Place your cursor over the column in the swim lane that you want to add the alert node to, and click
Create new node.
3. Select Alert Node.
4. Type a name and description for the node and click Save.
5. From the Select message type drop-down list, choose one of the following options:
Message type Description
Internal Message Select to send a web message to the payees through the web client.

200 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Message type Description
Specified Email Select to send a message to specified email addresses only.
Internal Message and Select to send a web message to the payees through the web client and
Email Notification external email addresses that are specified in the Payee table.
6. In the Email subject field, type the subject for the message.
7. If you are sending an email, type the email address of the payee in the To and BCC fields.
8. In the Body field, type the message.
9. You can insert the following variables into the message:
Variable Description
Form Initiator Adds the name of the payee who is specified by the Form Initiator swim lane.
Recipient Name Adds the name of the payee who receives the message.
Report Name Adds the name of the Presenter report that is specified by the workflow.
Report Name Adds the name of the report and links to the Presenter report on the web client.
with Link This variable is available only when a message is sent through the web client and
requires configuration of the Base URL in the Administrative Options window.
Tip: It is helpful to add the Report Name with Link variable to the web message so
that web users can quickly find the report.

10.Click Done.

Configuring the Report Name with Link variable in an Alert node

In an Alert node in a workflow, it is helpful to add the Report Name with Link variable to web messages
®
that are sent through the IBM Incentive Compensation Management web client, so that web users can
quickly find the report. You must configure the Report Name with Link variable settings.

Procedure
1. Click Admin > More Options
2. Click the Web tab.
3. In the Base URL field, type the URL of your WAR file.
For example, type the following address: http://localhost:8080/ICM, where ICM is the name of
your WAR file.
4. Click Save.

Adding action nodes

®
In IBM Incentive Compensation Management, you can use an Action node to define operations that can
be performed on a report in a particular step of the workflow in Workflow Manager.

Procedure
1. In Workflow Manager, open the workflow.
2. Place your cursor over the column in the swim lane that you want to add the action node to, and click
Create new node.
3. Select Action Node.
4. Type a name and description for the node and click Save.
5. To define the action paths for the web users, complete the following steps:
a) Click Add a new action.
b) Place your cursor over the new action, click the Edit icon, and type a name for the action path.
c) Select the Submit when selected check box to send the report to the next step in the workflow and
submit the data when the action is performed in the web client.

Workflow Manager 201

 d) Select the Required by all check box if all initiated workflows that are defined by the proceeding
swim lane must reach the Action node before the action path is visible.
e) Select the Submit by all check box if all payees in the swim lane must perform the action before
the workflow can move on.
This option can be selected for only one action and it cannot be combined with the Required by all
selection.

6. On the Layout restrictions tab, you can perform the following actions:
• In the Visible column, clear the check boxes next to the layout tables that you do not want to be
visible to payees on the web client.
• In the Editable column, clear the check boxes next to the layout tables that you do not want to be
editable by users on the web client.
Important: The only fields that are editable in the report are the fields that were marked as editable in
the data grids in Presenter. If you do not select the Editable check box on the Layout restrictions tab,
the fields are not displayed as an editable part of the workflow, regardless of the Presenter settings.
7. Click Create.

Adding process nodes

®
In IBM Incentive Compensation Management, you can use a Process node to add a process that was
created in the Scheduler module to a workflow.

Procedure
1. In Workflow Manager, open the workflow.
2. Place your cursor over the column in the swim lane that you want to add the process node to, and click
Create new node.
3. Select Process Node.
4. Type a name and description for the node and click Save.
5. Select the Scheduler process folder that you want the node to run.
6. Click Create.

Results
If an error occurs when the defined process runs, the workflow either stops and enters an error state, or
continues to run. The result depends on the configuration of the Stop Process on Error option in
Scheduler.

202 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Adding conditional nodes
®
In IBM Incentive Compensation Management, you can use a Conditional node to define conditions that
must be met in a particular step of a workflow.

About this task

The entry path to a Conditional node must come from an action node. Conditional nodes must have two
exit paths. You can configure conditions with the following variables: parameters, editable value columns,
stored values, and dates. You can create a maximum of five conditions in each Conditional node. To use
the IF function with text values, you must have text values or text parameters defined in your associated
Presenter report and disable the Enforce best practices for formulas option.

Procedure
1. In Workflow Manager, open the workflow.
2. Place your cursor over the column in the swim lane that you want to add the conditional node to, and
click Create new node.
3. Select Conditional Node.
4. Type a name and description for the node and click Save.
5. Click Add a conditional path.
6. Click the Edit icon and type a name and description for the path.
7. Drag the available parameters into the window to create the formula for the condition.
8. Click Save.
9. When you are finished defining conditions, click Done.

Editing nodes
®
In IBM Incentive Compensation Management, you can edit most nodes in a workflow in Workflow
Manager.

About this task

You cannot change the node type after the node is created. You cannot change or delete Start and End
nodes.

Procedure
1. In Workflow Manager, open the workflow.
2. Place your cursor over the node that you want to edit and click the Edit icon.

Cutting, copying, and pasting nodes

®
In IBM Incentive Compensation Management, you can copy and paste nodes into different columns in
the same workflow, or to columns in a different workflow in Workflow Manager.

Procedure
1. In Workflow Manager, open the workflow.
2. Place your cursor over the node that you want to move, click the ellipsis and select Cut or Copy.

Workflow Manager 203

 3. Place your cursor over an empty column in the same workflow or a different workflow, click the ellipsis
and select Paste.

Connecting nodes
®
In IBM Incentive Compensation Management, after you create nodes, you must connect them to define
the workflow process in Workflow Manager.

Procedure
1. In Workflow Manager, open the workflow.
2. To connect the Start node to the first node of the process, click the Start node and drag the arrow to
the node that you want to connect to.

3. Connect the rest of the nodes to the workflow process in the same way.
4. To connect an Action node with multiple action paths, complete the following steps:
a) Click the Action node and drag the arrow to one of the nodes that you want to connect to.
b) Select the action path that you want to connect to the node, and click Save.

c) Repeat steps a and b to connect the other action paths to the appropriate nodes.
5. Connect the last node in the workflow process to the End node to complete the workflow.
You can specify whether the last node results in the workflow being approved or rejected.

204 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Deleting connections
®
In IBM Incentive Compensation Management, you can delete a connection between nodes in Workflow
Manager.

Procedure
1. In Workflow Manager, open the workflow.
2. Select the connection that you want to delete and click the X.

Workflow value submission in pending state

®
In IBM Incentive Compensation Management, you can create workflows that allow web users to submit
values that remain in a pending state until the workflow is approved.
First, the workflow must be associated with a Presenter report that has an editable column in a data grid.
Then, the workflow must contain an Action node that has at least one approval path and one rejection
path to the End node. Web users can open the workflow in the web client and edit columns in the data
grid. These edits remain in the pending state, and cannot be seen by other web users, until the workflow
is approved.

Enabling pending workflows

®
In IBM Incentive Compensation Management, any changes that are made to data in Presenter reports as
part of a workflow are placed in a pending state until the workflow is complete.

About this task

Changes to data in Composer tables as part of workflows are not updated until the workflow is complete
and approved. You can enable this setting in the Administrative Options window.

Procedure
1. Click Admin > More Options.
2. Click the Workflow tab.
3. Select the Enable pending workflows check box.

Workflow errors and reports

®
Workflow history is logged in two modules in IBM Incentive Compensation Management. General
workflow history is tracked in the Audit log, and node-specific history is tracked in Workflow Manager.
If a workflow encounters an error, you can view the details of the error on the Errors tab in Workflow
Manager. You can view the error and identify the node that caused the error.
When an Action node encounters an error, such as when the next payee involved in the workflow cannot
be determined, an error is recorded on the Action node errors page.
When an Alert node encounters an error, such as an invalid email address, an error is recorded on the
Service node errors page.
For the workflow to advance, an administrator must intervene.

Workflow Manager 205

Viewing workflow errors
®
In IBM Incentive Compensation Management, you can view workflow errors on the Errors page in
Workflow Manager.

Procedure
1. In Workflow Manager, open the workflow.
2. Click the Errors tab.
3. From the drop-down list, select the type of errors that you want to view.

Resolving node errors

®
In IBM Incentive Compensation Management, you can fix an error that is encountered by a node in the
Errors log in Workflow Manager.

Procedure
1. In Workflow Manager, select the workflow.
2. Click the Errors tab.
3. From the drop-down list, select the type of node errors that you want to resolve.
4. Place your cursor over the error and click the ellipsis.
5. Select the method by which you want to resolve the node error.

Viewing workflow events in the Audit log

®
In IBM Incentive Compensation Management, you can view general workflow actions such as adding,
deleting, starting, and stopping workflows, in the Audit log.

Procedure
1. Click Admin > Audit.
2. In the Module column, click the Filter icon.
3. Select Workflow Manager and click Apply filter.
Only the events recorded in Workflow Manager are displayed.

Viewing workflow events in Workflow Manager

®
In IBM Incentive Compensation Management, you can view the history of individual nodes on the History
tab in Workflow Manager. The history tracks the payee who performed actions or received notifications.

Procedure
1. In Workflow Manager, open the workflow.
2. Click the History tab.

206 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Viewing pending actions
®
In IBM Incentive Compensation Management, you can view the action node that is involved in the current
step of the workflow, and the payees who must perform an action, on the Pending Actions tab of
Workflow Manager. If the Scheduler service started after the workflow started, you can also see any
process nodes that were unable to initiate in the workflow.

Procedure
1. In Workflow Manager, open the workflow.
2. Click the Pending Actions tab.

Rerunning a process node

®
In IBM Incentive Compensation Management, if a process node was stopped because the Scheduler
service was started after the workflow began, you can restart the process node.

About this task

Alternatively, you can choose to not run the process node and move on to the next step in the workflow.

Procedure
1. In Workflow Manager, open the workflow.
2. Click the Pending Actions tab.
3. Place your cursor over the process node, click the ellipsis, and complete one of the following steps:
• To rerun the Scheduler process, click Rerun Process.
• To move to the next step in the workflow, click Move to next.

Forcing approval or rejection of pending actions

®
In IBM Incentive Compensation Management, you can choose to force an approval or rejection of a
pending action in a workflow.

Procedure
1. In Workflow Manager, open the workflow.
2. Click the Pending Actions tab.
3. Place your cursor over the action, click the ellipsis, and complete one of the following steps:
• Click Force Approve.
• Click Force Reject.

Filtering workflow errors, pending actions, or history

®
In IBM Incentive Compensation Management, you can filter errors, actions, and events on the Errors,
Pending Actions, or History tabs in Workflow Manager.

Procedure
1. In Workflow Manager, open the workflow.
2. Click the Errors, Pending Actions, or History tabs.
3. In the header of a column, click the Filter icon.
4. Select the options that you want to filter the errors by and click Apply filter.

Workflow Manager 207

Exporting errors, pending actions, or history to Microsoft Excel
®
In IBM Incentive Compensation Management, you can save history events, action node errors, and
service node errors from Workflow Manager as a Microsoft Excel file.

Procedure
1. In Workflow Manager, open the workflow.
2. Click the Errors, Pending Actions or History tabs.
3. Click Export.

Clearing history
®
In IBM Incentive Compensation Management, you can delete the events on the History tab in Workflow
Manager.

Procedure
1. In Workflow Manager, open the workflow.
2. Click the History tab.
3. Click Clear.

Workflow Manager in the web client

You can access all activity for Presenter reports that are involved in workflows through the message
®
center in the IBM Incentive Compensation Management web client.
Presenter reports involved in the workflows do not require tree assignment in the Portal Access module
to be viewed in the web client. Presenter report access in the web client is determined through the swim
lanes in the workflows of Workflow Manager. For more information on Workflow Manager in the web
client, see the IBM Incentive Compensation Management Web Client User Guide.

208 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 24. Portal Access
®
Use the Portal Access module in IBM Incentive Compensation Management to define web tabs for the
web client, web access, sign off, and responsibility for inquiry handling.
In most cases, users must be included in a Portal Access hierarchy, which plays a role in the process of
approvals and sign offs in the system. You can create web tabs, groups, hierarchical trees, and define
assignments, sign off, and inquiries processes.

Web tabs
®
In IBM Incentive Compensation Management, customize the tabs that are displayed in the web client in
Portal Access.
You can select the name, type, and sequence of tabs. You can also build report-driven home pages that
are appropriate for different Portal Access groups.
You can create web tabs for Presenter and Pulse reports, web forms, and external web pages. You can
create module tabs by selecting Data Edit, Inquiries, Reporting, or Web Forms. Users can organize tabs
into web tab groups, which create sub-tabs in the web client.
When only one object is assigned to a web tab, no sub-tabs are shown, and the report or form is rendered
immediately. When more than one object is assigned to a tab group, sub-tabs appear, and users must
select something before a form can open. After web tabs are created, administrators must assign access
to the tab itself and to the objects that are included in the tab. If users do not have access to the web tab
or the sub-tabs, they cannot see them in the web client.
The following web tabs are available:
• External URL
• Module
– Data Edit
– Inquiries
– Pulse
– Reporting
– Web Forms
• Presenter Report
• Pulse Plan
• Web Form

Adding web tabs

®
You can add web tabs in Portal Access that users can use for navigation in the IBM Incentive
Compensation Management web client.

Procedure
1. In Portal Access, on the Web Tabs tab, click the Add Web Tab icon.
Tip: To add a web tab to an existing folder, select the folder before clicking the Add Web Tab icon.
2. In the Name field, type a name for the web tab. You can use special characters, such as hyphens and
apostrophes.
3. From the Type drop-down list, select the type of web tab that you want to create.
4. From the Object drop-down list, select the object that is assigned to the web tab.

© Copyright IBM Corp. 2005, 2018 209

 5. Click Add Web Tab.
Important: The first tab that is listed in Portal Access is the first tab that is displayed on the web
client.

Editing web tabs

®
In IBM Incentive Compensation Management, you can change the name, type, and object that is
assigned to the web tab created in Portal Access.

Procedure
1. In Portal Access, click the Web Tabs tab.
2. Place your cursor over the web tab that you want to edit and click the Edit icon.
3. Make your changes.

Deleting web tabs

®
In IBM Incentive Compensation Management, you can delete a web tab which removes the web tab from
the web client.

Procedure
1. In Portal Access, click the Web Tabs tab.
2. Place your cursor over the web tab that you want to edit and click the Delete icon.

Moving web tabs

®
In IBM Incentive Compensation Management, you can change the location and order of web tabs in
Portal Access. The order of the web tabs in Portal Access determines the order of the web tabs in the
web client.

Procedure
1. In Portal Access, click the Web Tabs tab.
2. Drag the web tab to the location that you want.

Adding web tab groups

®
In IBM Incentive Compensation Management, you can create web tab groups where you can place
individual web tabs in Portal Access. For example, you can create a web tab group called Plans, and
place the web tabs for individual Pulse plans into this group.

Procedure
1. In Portal Access, on the Web Tabs tab, click the Add Web Tab Group icon.
2. Place your cursor over the new folder and click the Edit Icon
3. Type a name for the web tab group.
4. Drag web tabs and place them in the web tab group.

Setting access to web tabs

®
To view web tabs and their objects on the IBM Incentive Compensation Management web client, users
must be able to access both the web tab and the objects. For example, if you have a reporting web tab,
you must set access to the reporting web tab and to the individual Presenter reports.

Before you begin

You must have access trees created in Portal Access.

210 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Procedure
1. In Portal Access, click the Assignment tab.
2. In each column, select access trees from the drop-down lists.

Portal Access groups

®
In IBM Incentive Compensation Management, you must create groups that are used to define access
trees. Access trees are assigned to web tabs in Portal Access so that web users can access items in the
web client.
Here's a short video that shows you how to add use Task Manager to maintain your Portal Access groups:

https://www.youtube.com/watch?v=3H56VXH_y_g
At a high level, the following steps describe how to define a Portal Access hierarchy:
1. Create groups. If payees are added to the Payee table after Portal Access groups are created, you can
use the Task Manager module to add these payees to your Portal Access groups.
2. Make access trees.
3. Assign trees to the reports, documents, and web forms.

Adding Portal Access groups

®
In IBM Incentive Compensation Management, add Portal Access groups to create payee groups that are
used to define web client access trees.

About this task

Any payees that exist in the model can be added to any group. Typically, you would add a group for each
level of the Portal Access hierarchy, for each plan, report, and so on.

Procedure
1. In Portal Access, click the Groups tab.
2. Click the Add Group icon.
3. Type the group name and click Save.
4. Select the Maintain this group in Task Manager check box to add a copy of the group in Task
Manager so that you can add rules to maintain the group's members.
5. Define the Portal Access group members by using the Payee table as a source, as well as any other
sources that you want to append.
6. On the Restrictions tab, add restrictions to define exactly which members of the source can
participate in the Portal Access group.
For example, to add a Portal Access group that contains only Account Executives, you could define a
restriction stating that only payees whose title ID = Account Executive should be included. Defining
restrictions is optional. You can also manually select payees from the Payees tab.
Tip: If you are planning on maintaining your Portal Access group in Task Manager, define your group
members on the Restrictions tab. If you are not maintaining the group in Task Manager, feel free to
add members manually as needed.
7. On the Payees tab, select the payees to create the exact group that you want. Any members that you
already selected through the restrictions screen are automatically displayed.
8. Click Finish.

Portal Access 211

Managing web access
®
In IBM Incentive Compensation Management, you can enable payees for web access and edit the web
login credentials for any member of a group in Portal Access.

About this task

When an administrator changes a user's password through the Manage Web Access window, the
password history is not remembered by Incentive Compensation Management.

Procedure
1. In Portal Access, click the Groups tab.
2. Click the group that you want to manage web access for.
3. Click the Manage Web Access icon.
4. You can perform the following actions to manage users' web access:
Action Description
Web enable In the Web Enabled column, select the members that you want to grant web
access. You must type and confirm a password for each member that you enable
for the web. After the member is enabled, web users can use the email address
defined in the Payee table as their login ID.
Important: The email address cannot be changed from Portal Access.

Disable web Clear the check boxes in the Web Enabled column of the members that you
access want to disable web access for.
Unlock web users Clear the check boxes in the Locked column of the members who have been
locked out of the web client.
Change a user's Click the user who you want to change a password for and click Change
password Password.
Force users to Select the check boxes in the Change Password on Next Login column to force
change their the users to change their passwords the next time that they log in to the web
passwords on client.
next login
Export Select one or more users (using Ctrl + click or Shift + click) and click Export to
download the user information in the Manage Web Access window as a .CSV
file. If no users are selected, all users are exported.
Copy Select one or more users (using Ctrl + click or Shift + click) and click Copy to
copy the user information in the Manage Web Access window to the clipboard.
5. When you are done managing web access, click Finish.
Important: The Task Manager module provides an option for generating passwords and sending
emails informing groups of payees of their passwords. This task can be used anytime a new payee is
added to a Portal Access group, or to provide existing users with new passwords in the case of a
forgotten password. Task Manager can be used to assign passwords to a large group of individuals at
once. You can change the email address of the emails sent by the application on the Admin > Portal
Access tab.

212 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Forcing web users to change passwords on next login
®
In IBM Incentive Compensation Management, administrators can enable an option that forces web users
to change their password the next time they log in to the web client.

About this task

This option can be selected only for web enabled users. If the User Must Have Strong Password option is
selected on the Web tab in the Administrative Options window, the user's new password must adhere to
the strong password guidelines.
Important: Web users are forced to enter a password into the New Password field the next time that
they log in to the web client. However, web users are permitted to reuse passwords. This means that the
new password can be the same as the old password.

Procedure
1. In Portal Access, click the Groups tab.
2. Click the Manage Web Access icon.
3. In the Change Password on Next Login column, select the users that you want to enable this option
for.

Portal Access trees

®
In IBM Incentive Compensation Management, from the Trees tab in Portal Access, you can create
hierarchy trees to define access to web tabs, sign offs, and inquiry handling responsibilities.
A tree can have as many or as few groups as you would like, and there is no limit to the level of complexity
of the hierarchy. You might want to create different hierarchy trees for web review, sign off, and inquiry
handling for each plan.

Table 49: Portal Access tree types

Portal Access tree Description
Access trees Access trees are created to define who can see information in the web
client. Members at the top of the tree can see their own results and the
results of anyone below them in the tree. Group members cannot see
results for others who are in the same group as them.
Only Pulse plans have hierarchical access. For this reason, trees that
are used to define report, web form, or document access must contain
only one level or one group.

Sign off trees Sign off trees determine the order that payees sign off on results.
Payees in the top group must complete signoff before payees in the
next group can begin. To create sign off trees, you must define the
hierarchy and decide who can sign off on results, for example, all
members or one member in the group.

Inquiry trees Inquiry trees define the inquiry handling process. For inquiries,
information always flows from the top of the tree to the bottom.
Members at the top of the tree can launch inquiries that can be
handled by members of the group below them.
For example, you can create an inquiry handling tree where inquiries
by all Account Executives who launch inquiries are handled by the
Regional Sales Manager (RSM). If the RSM chooses, he or she can
escalate the inquiry to the vice president.

Portal Access 213

 After a tree is created, it can be assigned to as many plans, reports, web forms, or documents as you like.

Creating Portal Access trees

®
In IBM Incentive Compensation Management, on the Trees tab in Portal Access, you can create access
trees to define the Portal Access groups that have web access to specific items.

About this task

There is no limit to the level of complexity that your tree can have.

Procedure
1. In Portal Access, click the Trees tab.
2. Click the Add New Tree icon at the bottom of the Trees tab.
3. Type a name for your tree and click Save.
4. To create your tree, complete the following steps:
a) Click the tree that you want to create the hierarchical structure for.
b) Click the Groups tab in the left pane.
c) Drag a Portal Access group onto the canvas.
d) To create the hierarchical structure, select a group on the canvas, drag the arrow and place it on
another group.

Using the Portal Access tree builder

®
In IBM Incentive Compensation Management, you can automate the creation of trees and the groups
that belong in the trees in Portal Access.

About this task

This process generates a Portal Access tree hierarchy based on a specified parent-child relationship.
After the hierarchy is defined, you can use automate the partitioning of your child groups, giving breadth
to your tree.

214 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Procedure
1. In Portal Access, click the Trees tab.
2. Click the Tree Builder icon at the bottom of the Trees tab.
3. Click the Edit icon and type the name of your tree. The name of the tree must be unique.
4. You can select the Maintain generated groups in Task Manager check box to place a copy of all of the
groups that are created by this wizard in Task Manager so that they can be maintained with Task
Manager rules and tasks.
Important: Only the groups can be maintained in Task Manager. The tree structure must be
maintained manually in Portal Access.
5. Define any additional sources that must be joined to the Payee table to provide the source data that is
needed to create the groups and trees.
Important: The source data must not contain cycles. That is, there must not be a path from any
payee's parent to itself. Also, there can be only one row entry in the source data for each payee
selected.
6. On the Restrictions tab, define any restrictions on the source data.
Use restrictions to limit the tree to a subset of payees. For example, you might want to create a
reporting hierarchy tree that contains only payees from a particular territory region. Also, if more than
one entry exists for some payees, you can use restrictions to specify which entry to use.
7. On the Hierarchy Columns tab, from the Parent Column drop-down list, select the parent column.
Tip: The parent column defines the hierarchical structure of the tree and it gives the tree its depth. The
parent column can be any column that is a pick list to the Payee table. For example, if you select the
Reports To column, the tree hierarchy is created according to who the payees report to.
8. From the Group Definition Column drop-down list, you can select a column that provides a way to
divide each hierarchical level of your tree into multiple groups.
Important: The group definition column can be any text-based column in your source. For example, if
you select job title as the group definition column, separate groups are created for each job title,
at each level of the hierarchy.
9. Click Finish.

Results
The tree is available in the Trees tab and it can be edited by dragging and dropping Portal Access groups.
All of the groups that are created for the tree are accessible from the Groups tab inside a folder that uses
the following naming convention: Tree Builder - <tree name>.

Defining hierarchies for sign off

®
In IBM Incentive Compensation Management, in Portal Access, you can specify whether all groups
members must sign off, or only one group member must sign off on a report, web form, or document.

About this task

These settings apply only to trees that are used to define sign off responsibility.
Important: The Sign Off Type for the group needs to be defined in the tree that is used to define access,
not the tree that is used to define sign off.

Procedure
1. In Portal Access, click the Trees tab.
2. Click the access tree.
3. On the canvas, click the ellipsis on the group in the tree and select Options.
4. Select one of the following options:

Portal Access 215

 Options Description
All group members must All members of the group must sign off on results for the step of the
sign off approval process to be complete.
One group member must Only one member of the group can sign off for the step of the
sign off approval process to be complete.
5. Click Save.

Adding web adjustments

®
In the Portal Access module, you can grant a group permission to adjust results through the IBM
Incentive Compensation Management web client.

About this task

When group members with adjustment privileges log in to the web client, they can make manual
adjustments to the results of any members in the group below them on the access tree.

Procedure
1. In Portal Access, click the Trees tab.
2. Click the access tree.
3. On the canvas, click the ellipsis on the group in the tree and select Options.
4. Select the Can adjust on web check box.
5. Click Save.

Results
On the web client, web users can make a manual adjustment to data. People with adjustment privileges
cannot adjust their own results or the results of other members in the same Portal Access group.

Assignments
®
In IBM Incentive Compensation Management, you can assign an access, sign off, or inquiry tree to
reports, documents, and web forms in Portal Access. If necessary, you can assign the same tree multiple
times.
When you assign access, sign off, and inquiry trees to reports, documents, and web forms consider the
following details:
Document assignment
Any documents that are added to the Manage Documents window are listed in the Assignment tab
and can be enabled for web review. When you assign trees to documents, keep in mind that access to
the document is either granted or denied, and you cannot give partial access to a document. For this
reason, the trees that you use to define document access must contain only one group.
Web form assignment
All web forms that are created and saved are listed in the Assignment tab. When you assign trees to
web forms, keep in mind that you cannot give partial access to a web form through Portal Access. For
this reason, the trees that you use to define web form access must contain only one group. To restrict
web form access, assign restrictions directly to the form through the Web Forms module.
Presenter report assignment
All Presenter reports that are created and saved are listed in the Assignment tab. When you assign
trees to Presenter reports, keep in mind that you cannot give partial access to a Presenter report
through Portal Access. For this reason, the trees that you use to define Presenter report access must
contain only one group. To restrict Presenter report access, assign restrictions directly to the report
through the Presenter module.

216 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Assigning tree access
If you want web tabs, reports, documents, web forms, and Presenter reports to be visible to users on the
®
IBM Incentive Compensation Management web client, you must assign them to Portal Access trees.

Procedure
1. In Portal Access, click the Assignment tab.
2. Select the report, document, web form, or web tab. The access, sign off, and inquiries columns all
contain drop-down lists with every tree that was created in the Trees tab.
3. From the drop-down list in each column that you want to define access for, select an available tree.

Validating tree assignments

You can check the validity of tree assignments for web tabs, reports, documents, and web forms in Portal
®
Access in IBM Incentive Compensation Management.

Procedure
1. In Portal Access, click the Assignment tab.
2. Click a web tab, report, document, or web form.
3. In the toolbar, click the Validate Assignments icon.

Notifying access tree about available documents

®
In IBM Incentive Compensation Management, you can notify all users in a Portal Access access tree that
a document is available for review on the web client.

Before you begin

A document must be added through the Manage Documents window and web access to the document
must be defined by a Portal Access access tree.

Procedure
1. In Portal Access, click the Assignment tab.
2. Select the document.
3. Click the Notify Portal Access Tree icon.

Results
This action sends an email to all members in the Portal Access tree. The email indicates that the
document is available on the web client.

Sign off
®
In IBM Incentive Compensation Management, you can begin or end an approval process, view history of
past sign offs, and see the current sign off status in Portal Access.
For each document, web form, and report, you can see what group has signed off, who has not yet signed
off, and if necessary, you can force approvals.
Important: The approval process is not tied to period locking; the process can begin and end at any time.
For information on how to sign off from the web client, see the IBM Incentive Compensation Management
Web User Guide.

Portal Access 217

Starting a sign off
®
In IBM Incentive Compensation Management, you can begin the sign off process on the web client from
Portal Access.

Procedure
1. In Portal Access, click the Sign Off tab.
2. Select the report, document, or web form that has a sign off tree assigned to it.
3. From the toolbar, click the Start Sign Off icon.
4. Type a name for the sign off.
5. Click START.

Ending the sign off process

®
In IBM Incentive Compensation Management, a sign off process ends automatically after the members of
the final group sign off. However, you can cancel the sign off process in Portal Access before it is
complete.

Procedure
1. In Portal Access, click the Sign Off tab.
2. Select the tree that you want to cancel the sign off for.
3. From the toolbar, click the Cancel Sign Off icon.

Sending email notification about the sign off process to pending payees
®
In IBM Incentive Compensation Management, after the sign off process starts in Portal Access, you can
send an email to all members in the tree to inform them that the sign off process is underway.

Procedure
1. In Portal Access, click the Sign Off tab.
2. Select the item with the sign off tree that you want to view from the list.
3. Click the Email Groups icon.
4. From the To drop-down list, select All Groups.
5. Type a subject and message.
6. You can select the Send to pending payees only check box to notify only payees in the top node of the
sign off tree.
7. Click Send.

Sending email notification about the sign off process to all members of one group
®
In IBM Incentive Compensation Management, after the sign off process starts in Portal Access, you can
send an email to one group in the tree to inform them that the sign off process is underway.

Procedure
1. In Portal Access, click the Sign Off tab.
2. Select the item with the sign off tree that you want to view from the list.
3. On the canvas, click the ellipsis on the group that you want to email and select Send email to Group.
4. Type a subject and message.
5. Click Send.

218 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Setting automatic notifications to users when a sign off is pending
You can specify that you want to send an email automatically to users whenever a sign off is pending in
®
the IBM Incentive Compensation Management web client.

About this task

The automated email informs web users when they need to log in and approve results on the web client.
Email notifications about pending sign offs are sent in the following situations:
• When a sign off is started from the Incentive Compensation Management client, all users in the top
node of the sign off tree are notified.
• When all members of a sign off tree are force approved by the administrator through the client,
members of the next node down the tree are notified that they have a sign off pending (if applicable).
• When all members of a node in the sign off tree approve the sign off through the web client, members of
the next node down the sign off tree are notified that they have a pending sign off (if applicable).

Procedure
1. Click Admin > More Options.
2. Click the Portal Access tab.
3. Select the Email users when a sign off is pending check box.
4. In the Sender Email Address field, you can change the model's sender email address for Portal
Access emails.

Forcing sign off approval

®
In IBM Incentive Compensation Management, the administrator can force approval for any pending sign
offs in Portal Access.

Procedure
1. In Portal Access, click the Sign Off tab.
2. Select the item with the sign off tree that you want to view from the list.
3. On the canvas, click the ellipsis on a group with pending sign offs and select Force Approve All.

Results
After you force approve results, sign off moves on to the next group of payees.

Viewing sign off status for group members

®
In IBM Incentive Compensation Management, you can open a table that displays all members in a group
in a Portal Access tree. For any members who signed off, the sign off date and approval type are also
listed.

Procedure
1. In Portal Access, click the Sign Off tab.
2. Select the item with the sign off tree that you want to view from the list.
3. On the canvas, click the ellipsis on the group that you want to view the sign off status for and select
View Members.

Results
If Approved is listed in the Approval Type column, the member signed off on results through the web
client. If Force Approved is listed, then the company's administrator forced approval through the
Incentive Compensation Management client.

Portal Access 219

Inquiry process
®
In IBM Incentive Compensation Management, you can handle web inquiries in Portal Access.
Incentive Compensation Management automatically enables inquiries for reports.
However, you can enable or disable a user's ability to launch inquiries for report from the Inquiries tab. If
the creator of an inquiry is deleted from the Payee table, the system keeps the inquiry so that an
administrator can view and maintain the inquiry.
For information on how to submit an inquiry from the web client and handle inquiries, see the IBM
Incentive Compensation Management Web User Guide.

Disabling inquiries
®
You can choose to prevent users from being able to launch inquiries from the IBM Incentive
Compensation Management web client.

Procedure
1. In Portal Access, click the Inquiries tab.
2. Select the item for which you want to disable inquiries.
Important: An inquiry tree must be assigned to the object.
3. From the toolbar, click the Disable Inquiries icon.

Enabling inquiries
®
By default, users can launch inquiries for documents, web forms, and Presenter reports from the IBM
Incentive Compensation Management web client. If you disabled this function, you can enable it again.

Procedure
1. In Portal Access, click the Inquiries tab.
2. Select the item that you want to enable inquiries for.
Important: An inquiry tree must be assigned to the object.
3. From the toolbar, click the Enable Inquiries icon.

Sending email notifications about inquiries to pending payees

®
In IBM Incentive Compensation Management, you can send an email to all groups in the Portal Access
inquiry tree.

Procedure
1. In Portal Access, click the Inquiries tab.
2. Select the item with the inquiry tree that you want to view from the list.
3. Click the Email Groups icon.
4. From the To drop-down list, select All Groups.
5. Type a subject and message.
6. You can select the Send to pending payees only check box to notify only payees in the top node of the
inquiry tree.
7. Click Send.

220 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Sending email notifications about inquiries to all members of one group
®
In IBM Incentive Compensation Management, you can send an email to all members of one group in the
Inquiry tree from Portal Access.

Procedure
1. In Portal Access, click the Inquiries tab.
2. Select the item with the inquiry tree that you want to view from the list.
3. Click the ellipsis on the group that you want to email and select Send email to Group.
4. Type a subject and message.
5. Click Send.

Setting automatic notifications to users when an inquiry is pending

You can specify that you want to send an email automatically to the designated inquiry handler when an
®
inquiry is started and pending review in the IBM Incentive Compensation Management web client.

Procedure
1. Click Admin > More Options.
2. Select the Portal Access tab.
3. Select the Email users when an inquiry is pending check box.
4. In the Sender Email Address field, you can change the model's sender email address for Portal
Access emails.

Viewing inquiry assigned to a group

®
In IBM Incentive Compensation Management, you can see the inquiry details for inquiries assigned to a
group in an inquiry tree; this includes comments and attachments.

Procedure
1. In Portal Access, click the Inquiries tab.
2. Select the item with the inquiry tree that you want to view from the list.
3. In the toolbar, click the Highlight Assigned icon to highlight the groups in the inquiry tree that have
assigned inquiries.
4. Click the ellipsis on the group that you want to view inquiry details for and select View assigned
inquiries.
5. Expand the inquiry viewer to view all the assigned inquiries.
6. Click the inquiry that you want to view.
Any comments or attachments that were posted with this inquiry are displayed. You can change the
status and category of the inquiry from this location.

Viewing inquiries made by a group

®
In IBM Incentive Compensation Management, you can view the details of an inquiry that was made by a
group.

Procedure
1. In Portal Access, click the Inquiries tab.
2. Select the item with the inquiry tree that you want to view from the list.
3. In the toolbar, click the Highlight Created icon to highlight the groups in the inquiry tree that created
inquiries.
4. Click the ellipsis on the group that create the inquiries that you want to view and select View made
inquiries.

Portal Access 221

 5. Expand the inquiry viewer to view all the created inquiries.
6. Click the inquiry that you want to view.
Any comments or attachments that were posted with this inquiry are displayed. You can change the
status and category of the inquiry from this location.

Viewing inquiries assigned to the administrator

®
In IBM Incentive Compensation Management, you can view the details of an inquiry that was assigned to
the administrator from Portal Access.

Procedure
1. In Portal Access, click the Inquiries tab.
2. Select the item with the inquiry tree that you want to view from the list.
3. From the toolbar, click the Inquiries Assigned to Admin icon.
4. Click the inquiry that you want to view.
Any comments or attachments that were posted with this inquiry are displayed. You can change the
status and category of the inquiry from this location.
5. To add a comment to the inquiry, perform the following steps:
a) Click the Comments tab.
b) Click Add a Comment.
c) Type the comment and click Save.
6. To add attachments to the inquiry, perform the following steps:
a) Click the Attachments tab.
b) Click Add an attachment.
c) Select the file that you want to attach to the inquiry.

Adding inquiry categories

®
In IBM Incentive Compensation Management, you might want to create categories where you can store
various inquiries. You can add inquiry category names in Portal Access.

Procedure
1. In Portal Access, click the Inquiries tab.
2. From the toolbar, click the Inquiry Categories icon.
3. Type the name for the new category and click Add.
4. When you finish adding inquiry categories, click Done.

Web client theme

®
You can change the IBM Incentive Compensation Management web client theme to match
Salesforce.com and add your company logo to the header.

Changing the theme to Salesforce.com

®
When you access IBM Incentive Compensation Management from Salesforce, you might want to
configure the appearance of Incentive Compensation Management to be more consistent with the
appearance of Salesforce.

Procedure
1. Click Admin > More Options.
2. Click the Themes tab.

222 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 3. In the Web Theme Settings section, select the Salesforce.com check box.
4. Click Save.

Adding a custom logo

®
In IBM Incentive Compensation Management you can customize the logo that is displayed in the web
client.

Procedure
1. Click Admin > More Options.
2. Click the Themes tab.
3. Select the Enable custom header check box.
4. Browse for the image that you want. The width of the image must be less than 250 pixels.
5. Click Save.

Disabling the web client Message Center icon

If you have other systems for inquiries or messages. you can disable the message center that is displayed
®
in the IBM Incentive Compensation Management web client.

About this task

This also removes the Web Messages option from the admin web application and the Workflow Manager
option from the payee web application.

Procedure
1. Go to Admin > More Options > Web.
2. Clear the Enable Message Center check box.

Portal Access 223

224 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 25. Scheduler
®
In IBM Incentive Compensation Management, create and schedule processes such as imports,
calculations, and calendar locking in Scheduler.
Keeping a model up-to-date is essential. Without regular transactional data updates, Incentive
Compensation Management cannot calculate up-to-date compensation amounts. You can use Scheduler
to manage the import process. Structural and data loads that are saved in the application are accessible
in Scheduler and can be grouped as steps in a single process. Each process can be run either on demand
or on a scheduled basis, keeping your compensation model in sync with the latest data from your source
systems.
In addition to data imports, Scheduler can be used to schedule all administrative tasks that need to be
run regularly. Scheduler can also be used to automate the process of calculating results, locking periods,
and generating administrative tasks that are created in Task Manager.

Scheduler properties
®
In IBM Incentive Compensation Management, you can set properties for individual processes in
Scheduler or all processes at once.
Global Scheduler properties apply to all processes unless you have set properties at the process level.
You can use global Scheduler properties to set the maximum run time for an external tool, stop an
external tool after it exceeds the set run time, and send email warnings when Scheduler encounters an
error or runs successfully.
Here's a short video that shows you how to set Scheduler properties:

https://www.youtube.com/watch?v=PBmFth2j8lw

Setting global Scheduler properties

®
In IBM Incentive Compensation Management, you can select options for all Scheduler processes at
once, such as stopping a process if it encounters an error.

Procedure
1. In Scheduler, in the toolbar, click the Settings icon.
2. On the Properties tab, perform the following steps:
a) Select the Stop process on error check box if you want to stop the whole Scheduler process if it
encounters an error while it is running a task.
b) Select the On error, send email to these addresses check box if you want Scheduler to email
users when processes or tasks complete with errors or fail, and type the users' email addresses in
the field.
c) Select the On success, send email to these addresses check box if you want Scheduler to email
users when processes or tasks complete successfully, and type the users' email addresses in the
field.
d) Select the Retry attempts check box to set the number of times that you want Scheduler to retry a
failed process or task.
3. On the External Tools tab, perform the following steps:
a) From the Maximum run time (seconds) field, set the maximum time that you want Scheduler to
allow an external tool to run.
b) Select the Stop on timeout check box if you want the external tool to no longer run after it exceeds
the maximum run time.

© Copyright IBM Corp. 2005, 2018 225

 Important: If the external tool is not running on the same computer as the Incentive Compensation
Management client, stopping the external tool after the timeout cannot be guaranteed.
4. Click OK.

Setting process-level properties

®
In IBM Incentive Compensation Management, you can select options for each Scheduler process, such
as stopping a process if it encounters an error.

About this task

If you do not set properties for sub-processes, they inherit the properties of the higher-level process
folder. If you do not set properties for any process folders, they inherit the global properties that you have
set.

Procedure
1. In Scheduler, place your cursor over the process folder for which you want to set properties, click the
ellipsis and select Properties.
2. On the Properties tab, perform the following steps:
a) Select the Stop Process On Error check box if you want to stop the whole Scheduler process if it
encounters an error while it is running a task.
b) Select the On error, send email to these addresses check box if you want Scheduler to email
users when processes or tasks complete with errors or fail, and type the users' email addresses in
the field.
c) Select the On success, send email to these addresses check box if you want Scheduler to email
users when processes or tasks complete successfully, and type the users' email addresses in the
field.
d) Select the Retry attempts check box to set the number of times that you want Scheduler to retry a
failed process or task.
3. On the External Tools tab, perform the following steps:
a) From the Maximum run time (seconds) field, set the maximum time that you want Scheduler to
allow an external tool to run.
b) Select the Stop on timeout check box if you want the external tool to no longer run after it exceeds
the maximum run time.
Important: If the external tool is not running on the same computer as the Incentive Compensation
Management client, stopping the external tool after the timeout cannot be guaranteed.
4. Click OK.

What to do next
Restart the Scheduler service.

Scheduler process
®
In IBM Incentive Compensation Management, Scheduler processes contain a series of tasks that can be
scheduled to run at specific times.
Processes can include tasks such as calculations, imports, publications, calendar locking, and task
generation.
Here's a short video that shows you how to add a process folder in Scheduler:

https://www.youtube.com/watch?v=67au7ApGwdo

226 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Adding processes
®
In IBM Incentive Compensation Management, create processes in Scheduler that can be run on demand
or on a schedule.

About this task

It is a good idea to create processes first, and then organize a combination of structural and data imports
and calculations into process folders.

Procedure
1. In Scheduler, click the Add icon.
2. From the Type drop-down list, choose Folder.
3. In the Name field, type a name for the process.
4. You can set the schedule for the process by completing the following steps:
a) Select either the day of the month or the day of the week when you want the process to run.
b) Select the minute and hour that you want the process to run on.
c) Select the month that you want the process to run in.
5. Click Create.

Adding a subfolder
®
In IBM Incentive Compensation Management, add subfolder to process folders in Scheduler to organize
the tasks in the process.

About this task

You can add up to three sub process folder within a single folder. More than one folder can have the same
name as long as they are not on the same level. You can set the stop on errors functionality, configure
separate email recipients, and external tool settings for each subfolder. Tasks run in their sequential order
according to the task or folder location.

Procedure
1. In Scheduler, select the parent process folder and click the Add icon.
2. From the Type drop-down list, choose Folder.
3. In the Name field, type a name for the process.
4. You can set the schedule for the process by completing the following steps:
a) Select either the day of the month or the day of the week when you want the process to run.
b) Select the minute and hour that you want the process to run on.
c) Select the month that you want the process to run in.
5. Click Create

Copying and pasting processes

®
In IBM Incentive Compensation Management, you can copy and paste processes in Scheduler.

About this task

When pasting a process or sub process, all tasks within the process folder are pasted. The schedule for
the process is not retained when it is pasted. The property settings are included when a process is pasted.

Procedure
1. In Scheduler, select the process that you want to copy.
2. In the toolbar, click the Copy icon.

Scheduler 227
 3. Select the folder where you want to place the process and click the Paste icon.
4. Place your cursor over the copied process and click the Edit icon.
5. Give the copied process a new name.

Disabling tasks and processes

®
In IBM Incentive Compensation Management, you can prevent processes, or tasks within a process, from
running.

Procedure
1. In Scheduler, place your cursor over the task or process that you want to disable and click the ellipsis.
2. Select Edit Schedule.
3. You can select one of the following options:
Option Description
Enable A scheduled task or process will run.

Disable A task or process that is disabled cannot be run manually or within a scheduled
process until it is enabled again. It can be useful to disable a task or process when
you do not want a certain task within a process, such as a saved import, to run.

skip for next Tasks and processes can be disabled for the next scheduled run only. After the next
run scheduled run, the task or process is automatically enabled again.

Scheduler tasks
®
In IBM Incentive Compensation Management, tasks are the items that you must add to a process folder
to create a process in Scheduler.
You can schedule tasks to run individually or as part of the complete process. You can also run a task
manually from Scheduler.
Here's a short video that shows you how to add tasks to process folders in Scheduler:

https://www.youtube.com/watch?v=xSk53bn0ylE
You can choose from the following task types:

Table 50: Scheduler task types

Task type Description
Calculation Runs a calculation of your whole model.
Import Runs the specified saved import.
Task Generation Generates task in Task Manager. You must have defined groups, created
rules, or enabled alerts in Task Manager.
Star Schema Population Populates star schemas created in Composer.
Lock Period Adds period locking for a specific calendar to the next period. You can
schedule locking only one period at a time.
® ®
Territory Management Table Synchronizes data between IBM Cognos Territory and Quota
®
Management and IBM Incentive Compensation Management. You must
choose the Territory Management object to import data to.

228 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 50: Scheduler task types (continued)
Task type Description
Web Status Allows you to disable the web client temporarily and then enable it again.
This is useful to prevent web users from logging in to the web client and
making changes while the model is being updated.
Transformation Runs the selected saved data transformations.
Clear Table Delete the contents of a selected table.
To use the clearing tables feature, you must have view and edit
permissions for Composer and the component that contains the table. If
the table is in the top level of Composer, you must have Top > Edit
permission.
You must also have view and edit permissions for the structure of the
table that you want to clear.

Publish Publishes the selected saved publication.

Calculate Presenter Report Calculates one or all Presenter reports. You must choose the report to
calculate or choose to calculate all reports.
Optimize Run the model optimization feature.
Tip: Scheduler this task to run during off peak hours.

Task Run
Add Workflow Members
Unassigned Idle Inquiries
Runs tasks in Task Manager. Tasks must be generated in Task Manager
first.
Adds payees to a selected workflow in Workflow Manager. You must
have swim lanes defined with restrictions in the workflow.
Unassigns a user from an inquiry if the user has not updated the inquiry in
the web client after a specified number of days.
After the inquiry has been unassigned, it is returned to the same Portal
Access group to be reassigned. A comment is added to the inquiry to
indicate that the assignee has been unassigned from the inquiry because
it was inactive for the specified number of days.

Purge History Clears the history for selected tables. If you select a data table, you must
select a date range for the table data that you want to remove history
data from.
®
PLCM Synchronizes data between IBM Producer Lifecycle and Credential
®
Management and IBM Incentive Compensation Management. You must
choose the PLCM object to import data to.
Expiring Password Email Sends email to web client users notifying them that their passwords are
Notification about to expire.
®
Quick Optimize This option is only available to IBM Incentive Compensation
Management Premium Performance users and optimizes calculation
outputs only.
®
External Tool Runs processes that exist outside of IBM Incentive Compensation
Management. An external tool is any program that can be run from the
command line. The external tool must exist in the External Tools
®
directory. External tools are configured in the IBM Incentive
Compensation Management Windows service configuration file.

Scheduler 229
Table 50: Scheduler task types (continued)
Task type Description
System Tool Encrypts or decrypts files using PGP.
You must specify the Input file path, which is the location of the file that
you want to encrypt or decrypt in the following format: <folder>/<file
name>. For example, Publication/payee.pdf.
You must also specify the Output file path, which is the location that you
want the file to be placed after it is encrypted or decrypted. It must also
be in the following format: <folder>/<file name>.
Important: To enable this feature, you must contact the Incentive
Compensation Management Operations team. You must then send the
Incentive Compensation Management team a public key, and in return
you are sent a public key that is generated per model. PGP encryption and
decryption is only available in Incentive Compensation Management on
Cloud and is not available in the on premise version.

Adding tasks
®
In IBM Incentive Compensation Management, to create a process in Scheduler, you must add a task to a
process folder.

About this task

You can schedule the runtime for each task that you add to the process or you can schedule the runtime
for the entire process.

Procedure
1. Open Scheduler, select the process folder that you want to add a task to.
2. Click the Add icon.
3. From the Type drop-down menu, select the type of task that you want to add.
4. You can set the schedule for the task by completing the following steps:
a) Select either the day of the month or the day of the week when you want the task to run.
b) Select the minute and hour that you want the task to run on.
c) Select the month that you want the task to run in.
5. Click Create.

Viewing the tables and date ranges for a scheduled history purge
®
You can view the tables and date ranges that were selected for a scheduled history purge in IBM
Incentive Compensation Management.

Procedure
1. In Scheduler, open the process folder.
2. Place your cursor over the Purge Table History task and click the ellipsis.
3. Select Edit Schedule.

230 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Scheduled items
®
In IBM Incentive Compensation Management, processes or individual tasks that are scheduled can be
unscheduled, disabled, or run manually from Scheduler.
Here's a short video that shows you how to schedule tasks and processes in Scheduler:

https://www.youtube.com/watch?v=h7VvhTNMO58

Running an item
®
You can make a process or item run immediately from the Scheduler module in IBM Incentive
Compensation Management.

Procedure
1. In Scheduler, select the process folder or task that you want to run.
2. In the toolbar, click Run.

Scheduler timing
®
In IBM Incentive Compensation Management, you might find that a scheduled process does not run at
exactly the time that you specified in Scheduler. The discrepancy might be caused by time changes in the
system.
For example, you might set Scheduler to run at exactly 11:00 p.m. The next day, you might notice that the
Scheduler log file shows that the item ran at 11:02 p.m.
This discrepancy might be caused by time changes in the system. For example, Windows Time Services
periodically makes minor adjustments to the system time. These adjustments can interfere with
Scheduler running at exactly the specified time.

Scheduler time conflicts

®
In IBM Incentive Compensation Management, when you schedule tasks in Scheduler, remember that
two tasks cannot run at the same time.
For example, if one process is scheduled at 11:00 p.m. and another process is scheduled at 11:01 p.m.,
the second process does not run if the first is not completed. If the second task cannot run, an error
message is displayed to indicate a scheduling conflict. The conflict must be resolved before Scheduler
can run successfully.
Scheduler has a 10-minute window to run the task before it is skipped. For example, if Scheduler misses
a 11:00 p.m. scheduled time due to a scheduling conflict, it continues to try to run the task until 11:09:59
p.m. If the task cannot run in the 10-minute window, the task is skipped.
Important: The Scheduler service can run only one process at a time. If more than one model uses the
same Scheduler service, scheduled processes must occur at different times for each model. If scheduled
model administration must occur simultaneously on more than one model, each model must point to a
different service.

Scheduler error notification

®
In IBM Incentive Compensation Management, when Scheduler runs items, some items might not run. If
any items do not run, you are notified.
If an item runs successfully, a green check mark is displayed in the Status column. The Last Run Time
column records the last successful and error-free completion of each task.
If an item does not run, the following actions occur:
• A message instructs you to see the Audit log for more information.

Scheduler 231
 • A red x is displayed under the Status column.
• No time is displayed in the Last Run Time column of the Scheduler module.
• The Audit log captures all Scheduler activity.
When a scheduled item does not run, the scheduled task is skipped. Scheduler tries to run the task item
at the next scheduled interval.
If the first item in a process does not run, by default, Scheduler tries to run the remaining items in the
process.
If you do not want Scheduler to try to run the remaining items in the process after a task fails, set the
Stop Process on Errors value.
To prevent problems that might be associated with a lost import, you can configure Scheduler to send an
email to an individual or distribution list about the error. You can also configure Scheduler to send an
email notification upon successful completion. The email message is sent to the address set in the
Scheduler properties window.

Accessing the Scheduler log

®
In IBM Incentive Compensation Management, if a scheduled process fails, the date, time, step the
process failed on, and other vital information is copied into the Scheduler log.

Procedure
1. Click Admin > Logs > Scheduler.
2. You can filter the results by a selected date range.

232 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 26. PGP Encryption
®
You can use PGP encryption to encrypt and decrypt files that are exported or imported into IBM Incentive
Compensation Management (ICM) storage.

Prerequisites
Each model in your ICM 10 application can only have one set of PGP keys. A set of PGP keys include your
public PGP key and a public PGP key provided by IBM. For example, if you have Production, QA, and
Development environments, then you can have a unique set of PGP keys for each environment or you can
use the same set for all three environments. However, a single environment cannot use more than one
pair of PGP keys. IBM provides one public PGP key per environment or one public PGP key for all
environments. If you require PGP encryption, then you must provide IBM with your public PGP key that
has the name parameter set to outbound and a strength of 2048 bits.

Scheduling PGP encryption and decryption

®
PGP encryption and decryption tasks are run via the IBM Incentive Compensation Management
Scheduler module as a System Tool.

About this task

For both PGP actions, you must specify the parameters for the input and output file paths.

Procedure
1. Open Scheduler, select the process folder that you want to add a task to.
2. Click the Add icon.
3. From the Type drop-down menu, select System Tool.
4. You can set the schedule for the task by completing the following steps:
a) Select either the day of the month or the day of the week when you want the task to run.
b) Select the minute and hour that you want the task to run on.
c) Select the month that you want the task to run in.
5. From the Available system tools drop-down menu, select either PGPEncrypt or PGPDecrypt.
6. In the Input file path field, type the location of the file that you want to encrypt or decrypt in the
following format: /root/<folder>/<file name>.
For example, /root/Publication/payee.pdf.
Note: The file path fields are case sensitive.
7. In the Output file path, type the location that you want the file to be placed after it is encrypted or
decrypted. It must also be in the following format: /root/<folder>/<file name>.
Tip: Include /root in all file paths.
8. Click Create.

PGP encryption automation

®
In IBM Incentive Compensation Management (ICM), you can automate PGP encryption and decryption.
Automating PGP encryption and decryption requires additional external tools to ensure that no conflicts
occur when outputs are being created and the expected file names are present for consumption in
downstream processes.

© Copyright IBM Corp. 2005, 2018 233

 Example
In the following example, we will simulate a basic workflow for a PGP encrypted file that needs to be
imported into ICM and use PGP encryption to export a published file.

Prerequisites
The following external tools are required for this workflow:
remove_file.py
This external tool deletes a specified file if it exists.
remove_timestamp.py
This external tool looks for and deletes the latest timestamp for a given file prefix.

Sample workflow
• SFTP - The file import.csv.pgp is moved to the /root/Data folder.
• Scheduler - The external tool, remove_file.py /root/Data/import.csv removes any decrypted
files from the previous Scheduler run.
• Scheduler - The system tool, PGPDecrypt, with the /root/Data/import.csv.pgp and /root/
Data/import.csv file paths, decrypts the newly uploaded import file
• Scheduler - The necessary tasks with the decrypted import file are run.
• Scheduler - The report-timestamp.pdf file is published.
• Scheduler - The external tool, remove_file.py /root/Publication/report.pdf cleans up the
file from the last Scheduler run.
• Scheduler - The external tool, remove_file.py /root/Publication/report.pdf.pgp cleans up
the file from the last Scheduler run.
• Scheduler - The external tool, rename_timestamp.py /root/Pubication/report.pdf removes
the timestamp from the latest published report file.
• Scheduler - The system tool, PGPEncrypt, with the /root/Publication/report.pdf and /root/
Publication/report.pdf.pgp file paths, encrypts the published report file.
• SFTP - The file report.pdf.pgp can now be copied out of the ICM application.

234 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 27. Task Manager
®
In IBM Incentive Compensation Management, use Task Manager to maintain your model. Task Manager
simplifies the process by generating lists of model maintenance and Portal Access tasks to be completed,
based on defined criteria.
You can also use tasks to alert administrators when certain situations arise, such as when terminated
payees are still active in a payee group.
When you create a task, you specify the process of performing various actions when data in the model
changes, such as when new payees are imported into the Payee table. With tasks, you can easily define
payee groups and create rules to perform administrative actions on those groups. After the customized
task list is generated, you can run the tasks to complete model maintenance.
At a high level, the following steps describe how to perform model maintenance in Task Manager:
1. Add a group.
2. Add a rule.
3. Generate the task list.
4. Administer the tasks.
5. Add email notification and enable alerts.

Task Manager groups

®
In IBM Incentive Compensation Management, you can organize the tasks that are performed on payees
by adding groups in Task Manager.
In Task Manager, the Payee table is used by default to add groups. However, you can add any tables or
calculated results to the Payee table to define the source of the payees. You can then use restrictions to
specify which payees to include in the group.
When you add groups, think about the actions that you want to perform on those groups, such as what
rule you want to apply to the group. For example, you might add a Task Manager group that includes all
payees whose status is terminated, and then you might add a rule to remove those payees from their
payee group.
The groups that you add in Portal Access, with the Maintain this group in Task Manager option enabled,
appear in the Groups tab of Task Manager. These groups are created and maintained in Portal Access. If
you want to change the definition of a group created in Portal Access, you must make the changes in
Portal Access and not to the Task Manager rules.

Adding Task Manager groups

®
In IBM Incentive Compensation Management, to organize the tasks that are performed on payees, add a
group in Task Manager.

Procedure
1. In Task Manager, on the Groups tab, click the Add Group icon.
2. Type a name for your group and click Save.
3. Define the data sources required to create the group.
4. On the Restrictions tab, define restrictions to create the group.
5. Click Finish.

© Copyright IBM Corp. 2005, 2018 235

Organizing Task Manager groups
®
In IBM Incentive Compensation Management, you can create folders to organize the groups that you
create in Task Manager.

Procedure
1. In Task Manager, on the Groups tab, click the Add Folder icon.
2. Place your cursor over the new folder and click the Edit icon.
3. Type a name for the folder.
4. Drag groups and place them in the folder.

Task Manager rules

®
In IBM Incentive Compensation Management, Task Manager rules are used to determine the actions
that you want to perform on specified groups of payees.
The payee groups that are added or removed are defined on the Groups tab of Task Manager.
Several rule options are available.

Table 51: Task Rules

Module Rule Description
Payee Groups Add payees to a Add payees in a defined group to a specified payee group. The
payee group start date for the added payees is the first day of the fiscal year.
Example: Add all payees with job title "Inside Sales Rep" to Inside
Sales Rep payee group. Payee start date is the first day of the
fiscal year.

Payee Groups Add payees to a Add a defined group of payees to a payee group with today's date
payee group as of as their start date.
today
Example: Add all payees with job title "Inside Sales Rep" to Inside
Sales Rep payee group. Payee start date is the day that the task is
run.

Payee Groups Remove payees Remove payees in a defined group from a specified payee group.
from a payee group
Example: Remove all terminated payees from a specified payee
group.

Payee Groups Set end dates for Set end dates for a group of payees for anywhere from today to
payees in a payee 180 days from today.
group
Example: Set end dates for all terminated payees.

Portal Access Add payees to a Add a group of payees in a defined group to a Portal Access
Portal Access group group.

Example: Add all "Account Executives" to the Account Executive

Portal Access group.

Portal Access Enable a group of Grant web access to specified payees. Random passwords are
payees for web and generated and emailed to the address in the Payee table.
notify them of their
passwords. Important: This rule does not add payees to a Portal Access
group; you need to perform this task separately.

236 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 51: Task Rules (continued)
Module Rule Description
Portal Access Maintain payees in a Adds and removes payees from the group in Portal Access.
Portal Access group
Important: This rule is created by default for Portal Access
groups that users set up to be maintained in Task Manager.

Portal Access Remove payees Remove payees in a specified group from Portal Access.
from a Portal
Access group

Adding Task Manager rules

®
In IBM Incentive Compensation Management, create rules in Task Manager to specify the actions that
you want to perform on groups of payees.

Procedure
1. In Task Manager, on the Rules tab, click the Add Rule icon.
2. Type a name for your rule and click Save.
3. Select the type of action for this rule to perform.
The fields displayed are specific to the rule that you select.
4. Select the group, payees, or dates and click Next.
5. Select the roles that you want to email.
6. If you do not want to enable email notification for a rule, select Done without selecting any roles.
Important: Email notification can be sent to administrators when a task is generated by Task
Manager. Email notification is defined individually for each rule and is sent to all users who are
assigned to the selected user role. The user role is defined in the Manage Roles window.

Organizing Task Manager rules

®
In IBM Incentive Compensation Management, you can create folders to organize the rules that you create
in Task Manager.

Procedure
1. In Task Manager, on the Rules tab, click the Add Folder icon.
2. Place your cursor over the folder and click the Edit icon.
3. Type a name for the folder.
4. Drag rules and place them in the folder.

Generate and administer tasks

®
In IBM Incentive Compensation Management, you can generate a task list to see administrative tasks in
Task Manager. You can then choose to delete, defer, or run a task.

Generating a task list

®
In IBM Incentive Compensation Management, generate your task list to view a list of tasks to be
performed based on the rules that you created in Task Manager.

About this task

You can also schedule task generation to run at specific times in Scheduler.

Task Manager 237

 Procedure
1. In Task Manager, click the Tasks & Alerts tab.
2. In the toolbar, click Generate.
The tab is populated with a list of tasks to be run based on the specified rules. For example, if you have
created a rule to add all payees in a particular group to Portal Access, Task Manager generates a list
of all the payees that need to be added to a Portal Access group.
3. Review the generated list of tasks.

Running a task
®
In IBM Incentive Compensation Management, you can run a task that is generated in Task Manager.

Procedure
1. In Task Manager, on the Tasks & Alerts tab, click the task that you want to run.
2. In the toolbar, click Run.

Deleting a task
®
In IBM Incentive Compensation Management, you can delete a task that is generated in Task Manager.

About this task

Important: If a task is deleted, it is lost. Regenerating the tasks does not regenerate any deleted tasks. If
you mistakenly delete a task, you can regenerate the task by deleting the rule and then recreating it.

Procedure
1. In Task Manager, on the Tasks & Alerts tab, place your cursor over the task that you want to delete.
2. Click the Delete icon.

Deferring a task
®
In IBM Incentive Compensation Management, you can defer a task that is generated in Task Manager to
run at a later date.

Procedure
1. In Task Manager, on the Tasks & Alerts tab, click the task that you wan to run.
2. In the toolbar, click the Defer icon.
3. Select the date that you want to generate the selected task on.

Results
When you defer a task, it is removed from the Tasks & Alerts tab and placed in the Deferred Tasks tab on
the specified date.

Canceling a deferral
®
If a task is deferred, you can cancel the deferral in the Task Manager module in IBM Incentive
Compensation Management.

Procedure
1. In Task Manager, on the Deferred Tasks tab, select the task.
2. Click the Restore icon.

238 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Results
The task is placed in the Tasks & Alerts tab.

Adding email notifications for tasks

®
In IBM Incentive Compensation Management, define which administrators receive an email notification if
a rule generates a task in Task Manager.

Procedure
1. In Task Manager, click the Tasks & Alerts.
2. In the toolbar, click the Modify Email Role icon.
3. Select the role that you want to send email notifications to.
4. Select the rules that you want to prompt an email notification.
5. Click Done.

Results
When a task is generated for a selected rule, the administrator receives an email notification.

Alert options for tasks

®
In IBM Incentive Compensation Management, to simplify the maintenance of payee groups,
administrators can use Task Manager to set up notifications when certain situations arise.
Administrators can be notified if terminated payees are still active in a payee group. If a payee is marked
as terminated in the Payee table but is still active in a payee group (the end date does not match the
termination date), you can choose to be notified.

Activating a payee alert

®
In IBM Incentive Compensation Management, you can enable default alerts through the Tasks & Alerts
tab in the Task Manager module. If payees belong to any of the enabled alert categories, the alert is
displayed on the Tasks & Alerts tab.

Procedure
1. In Task Manager, click the Tasks & Alerts tab.
2. In the toolbar, select the Alert check box.

Disabling a payee alert

®
In IBM Incentive Compensation Management, you can disable alert options that were enabled in Task
Manager.

Procedure
1. In Task Manager, click the Tasks & Alerts tab.
2. In the toolbar, clear the Alert check box.

Task Manager 239

240 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 28. Scenarios
®
You can use scenarios to analyze how variations in the output of a model in IBM Incentive Compensation
Management can be apportioned to different sources of variation.
You can use the Scenarios module to build what-if scenarios, view a side-by-side comparison of targets
to actual results, and analyze significant variances from the plan. You can test the impact of proposed
changes before they are implemented. If you like the changes that you tested in the scenario, you can
then promote them to the model for implementation.
When you create a scenario, you can add calculations and tables to the scenario. You can then complete
the following actions:
• Alter the data and logic, including adding or removing data rows
• Determine what changes were made in the scenario
• Calculate the scenario
• Compare scenario results to actual calculated results or other scenarios in a report
Imagine that you have the following basic plan layout, and many calculations are needed in each
component to fully build out the logic.

By creating a scenario based on the basic plan layout, you can create many combinations of what-if
modeling, including the following changes:
• A change to crediting rules
• A change to goals or attainment rules
• A change to earnings rules
For example, you might want to view how the Account Executives compensation plan might change if you
increase their commission rates by 2%. You can create a scenario based on the Account Executives
compensation plan, add the table that contains the Account Executives commission rates, and add a
transform change set to the table in which you adjust the commission rates by 2%.
Similarly, you might want to view how the Inside Sales Representatives compensation plan change if you
decrease the commission rate on a particular product. You can create a scenario based on the Inside
Sales Representatives compensation plan, add the table that contains the product commission rates for
Inside Sales Representatives, and add an overwrite change set to the table in which you change the
commission rate for the specific product.
Scenarios are based on the current data in tables and calculations in your model. If you change tables or
calculations in Composer, these changes are reflected in Scenarios.
You can use the Scenarios module to forecast the impact of changes in compensation plans before you
implement changes for budgeting and cost management. You can get visibility into specific individuals
who are the most and least impacted by any changes. Then, you can proactively and effectively
communicate any plan changes. Scenarios can be created and compared to each other or to the current
plan so that you can better understand the impact of prospective changes across historical, future, or
current data.

© Copyright IBM Corp. 2005, 2018 241

 Note: When you upgrade a model to version 10, scenarios from previous versions are not upgraded with
the model. The scenarios are deleted and you must recreate them.

Workspaces
®
Before you add and work with scenarios in IBM Incentive Compensation Management, you must add a
workspace to contain your scenarios.
Each workspace must be associated with a payee group and a calculation. Only calculations that use the
same calendar as the payee group and contain payee, date, and value columns are available for selection.

Adding workspaces
®
In IBM Incentive Compensation Management, you must add workspaces to contain your scenarios.

Procedure
1. In Scenarios, click Add new workspace.
2. Type a name and description for the workspace.
3. Set start and end dates to define the periods that are accessible for editing in the scenario.
4. From the Accessibility drop-down list, choose one of the following options:
Option Description
Public A public workspace is available to any user with access to Scenarios.
Private A private workspace is available only to the user who added it and users assigned to the
administrator role.

Important: You can grant users access to private workspaces in the Manage Roles window.
5. Click Next.
6. From the Payee Group drop-down list, select the payee group associated with this workspace.
7. From the Calculation drop-down list, select the calculation that you want to use in the workspace.
8. Click Add to workspace.
9. Click Add.

Editing workspaces
®
In IBM Incentive Compensation Management, you can edit the name, description, and accessibility of a
workspace in Scenarios.

Procedure
1. In Scenarios, place your cursor over the workspace that you want to edit and click the Edit icon.
2. Make your changes.

Deleting workspaces
®
In IBM Incentive Compensation Management, you can remove workspaces from Scenarios.

Procedure
In Scenarios, place your cursor over the workspace that you want to delete and click the Delete icon.

242 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Calculating workspaces
®
In IBM Incentive Compensation Management, you can run a calculation for a workspace to see the
effects of any changes that you made in Scenarios.

Before you begin

You must create a scenario and add change sets in the workspace before running a calculation.

Procedure
1. In Scenarios, open the workspace that you want to calculate.
2. Click Calculate.

Workspace scenarios
®
In IBM Incentive Compensation Management, you can use scenarios for side-by-side comparison of data
to help with modeling of compensation plans for the next year.
After you add a workspace, you can add scenarios that can make logic changes, edit or delete source
data, transform data, and add to source data. For example, if you want to see how changing a payee's
quota affects the total compensation payment for the payee, add the table that contains quotas to your
scenario and change the amount.

Adding scenarios
®
In IBM Incentive Compensation Management, add scenarios to workspaces to make logic changes to
source data.

Procedure
1. In Scenarios, open the workspace that you want to add a scenario to.
2. Click the Add icon.
3. Place your cursor over the new scenario and click the Edit icon.
4. Type a name and description for the scenario.
5. Click Save.

Adding items to scenarios

®
In IBM Incentive Compensation Management, you can add tables and calculations to scenarios that are
associated with the calculation in your workspace.

About this task

You might add a quota table to see how changing a payee's quota affects the total compensation payout.
The data from added calculations is displayed in table form. The workspace must first be calculated
before the table is populated with the calculated results. You can then edit, add, delete, or transform the
calculation results in any way. You can edit results such as attainment or annual compensation without
having to go back to source data or early calculation results.

Procedure
1. In Scenarios, open the workspace
2. Click the scenario that you want to add an item to.
3. Click Add Item.
4. Use the Search field to search for an item, or scroll down and select a table or calculation that you
want to edit.

Scenarios 243
 Important: If you add a calculation, a warning sign is displayed next to the item to indicate that the
workspace must first be calculated before changes can be made. It can also indicate that the table is
too large to be used in the workspace.
5. Click Add.

Moving items to another scenario

®
In IBM Incentive Compensation Management, you can move an item from one scenario to another.

Procedure
1. In Scenarios, open the workspace, then click the scenario that contains the item that you want to
move.
2. Drag the item and place it on the tab of the scenario that you want to move the item to.

Results
After dropping the item into the new scenario, the tab opens and the dropped item is displayed at the top
of the list.

Scenario change sets

®
In IBM Incentive Compensation Management, you can add change sets to edit the data in the tables and
calculations that you added to a scenario.
There are two types of change sets: overwrite change sets and transform change sets.
Overwrite
Use an overwrite change set to add rows to tables and calculations and change values for columns
that are not primary key columns. The table or calculation data is presented in table form and you can
edit the data to suit your scenario. This change set is most useful if you want to make a change to a
specific value in a table or calculation.
Transform
Use a transformation to make changes to a table or calculation across multiple rows for non-primary
key columns at the same time. You can create restrictions to replace or adjust specific data in a
column of a table or calculation. For example, if you want to change the quota only for managers, you
can restrict the data to include only managers. This change set is most useful when you want to make
a uniform change to more than one row of data.

Adding overwrite change sets

®
In IBM Incentive Compensation Management, you can add an overwrite change set to make specific
changes to each row in a table in a scenario. For example, you can use an overwrite change set to view the
effects on a compensation plan when you increase the quantity that is sold for a specific payee.

Procedure
1. In Scenarios, open the workspace then click the scenario.
2. Click the New Overwrite icon next to the table or calculation that you want to add an overwrite change
set to.

3. Type a name for the overwrite.

4. Click the Add Row icon to add a new row of data.

244 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 5. In the table of data, make the changes that you want to the rows. You cannot change primary key
columns.
6. Click Create.

Adding transform change sets

®
In IBM Incentive Compensation Management, add a transform change set to apply a uniform change over
multiple rows of data in your scenario. For example, you can use a transform change set to view the
effects on a compensation plan when you decrease the quota by 10% for all managers.

Procedure
1. In Scenarios, open the workspace then click the scenario.
2. Click the New Transform icon next to the table or calculation that you want to add a transform change
set to.

3. Click the Edit icon next to the name of the transform change set to rename it and type a description.
4. Define any restrictions for the transformation.
If you want to replace only some of the values in a column, define restrictions here to indicate which
values to update. For example, if you want to update values only for John Smith, restrict the data in the
table to include records for only John Smith.
Tip: Use the Preview button to make sure that you have restricted the data in the way that you want.
5. Click Next.
6. From the Column drop-down list, select the column that you want to perform the transformation on.
7. From the Transform Type drop-down list, select one of the following options:
Option Description
Replace Replaces the data with new data.
Adjust Increases or decreases the values in the selected table by a percentage or a set value.
8. If you select Replace, in the Replace With field, select a column or type a value.
The value that you type or select replaces all values in the selected column.
9. If you select Adjust, perform the following steps:
a) In the Adjust Type field, select Value or Percentage as the type of adjustment that you want to
make.
b) In the Adjust By field, type a value that you want to adjust the data by.
10.Click Add.

Reordering change sets

®
In IBM Incentive Compensation Management, when you have multiple change sets for one table or
calculation in a scenario, you can change the order of the change sets. The change set that is listed last is
used to calculate the report.

Procedure
1. In Scenarios, open the workspace then click the scenario.
2. To move the change set, drag it up or down the list.

Scenarios 245
Editing change sets
®
In IBM Incentive Compensation Management, you can make changes to a transform change set or
overwrite change set that has already been added to a scenario.

Procedure
1. In Scenarios, open the workspace then click the scenario.
2. Place your cursor over the change set that you want to modify and click the Edit icon.

Scenario results
®
In IBM Incentive Compensation Management, you can preview the changes made to an item in a
scenario and generate reports to compare scenarios.

Previewing transform change set results

®
In IBM Incentive Compensation Management, after you create a transform data change set in a scenario,
you can calculate and preview your scenario to see the effects of any changes that you made.

Procedure
1. In Scenarios, open the workspace then click the scenario.
2. Place your cursor over the transform change set that you want to view results for and click the Preview
icon.

Results
A table opens with the results.

Generating scenario reports

®
In IBM Incentive Compensation Management, you can generate a report to present your results and
compare your scenario to the current model or other scenarios.

Before you begin

Before you generate a report, you must calculate the workspace that you want to generate the report for.

Procedure
1. In Scenarios, open the workspace.
2. Click the Report tab.
3. From the Report Type drop-down list, you can select to compare results by payee or by period.
4. From the Base Scenario drop-down list, select the scenario that you want use to compare to the target
scenario.
If you select (Base), your scenario is compared to the current data in the model. If you created more
than one scenario, you can also compare two scenarios to each other.
5. From the Target Scenario drop-down list, select the scenario that you want to compare with the base
scenario.
6. From the Calculation drop-down list, select the calculation that you want to generate results for.
7. If you selected Period Comparison as the Report Type, from the Payee drop-down list, select a payee
to view. If you selected Payee Comparison, from the Periods drop-down list, select a period to view.
8. From the Number of Chart Items drop-down list, select the number of items that you want to display
in the chart.
9. Click Generate Report.

246 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Promoting scenarios
®
In IBM Incentive Compensation Management, you can promote a scenario to replace the current data in
your model with the new data from the scenario. This action replaces the items in Composer that you
used to create your scenario with the edited scenario items.

Procedure
1. In Scenarios, open the workspace then click the scenario that you want to promote.
2. Click Promote.

Scenarios 247
248 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 29. Logs
®
In IBM Incentive Compensation Management, there are several logs that monitor all activity by all users.
You can also view lists of errors and Scheduler and task messages.
You can access multiple logs to view a list of errors that were generated, the date and time the error
occurred, a description of the error, and the error type.
All logs, except for the Error log, show information specific to the model the user is logged in to. The Error
log is user-specific and not model-specific, so it shows information for all models.
The following logs are available:
• Audit log
• Computation log
• Import log
• Export log
• Scheduler log
• Task log
• Signature Control log
• Performance log

Audit log
®
By default, the Audit log monitors all activity by all users in IBM Incentive Compensation Management. It
logs any database creation, modification, and deletion activity, and presents those activities in the form of
a filter-capable grid for administrator review.
If you need to retrace your steps, the Audit log provides all the key information that you need to
determine the exact process that was used to build your model.
In addition to monitoring all activity in the Incentive Compensation Management client, the Audit log also
displays web data edit and Portal Access entries that were made by web client users. The user types for
changes are administrator for the Incentive Compensation Management client and web user for the web
client.

Audit log functionality

®
In the IBM Incentive Compensation Management, you can use the Audit log to review events and actions
that were taken by administrators.
You can view the following events in the Audit log:
• Adding user roles
• Administrator log on and log off
• Category calculation changes
• Calculation started, stopped, canceled, and completed
• Changing user role permissions
• Column added and removed
• Connections made between components
• Configuration change
• Created or deleted tables, Views, or Presenter reports
• Data and assignments saved

© Copyright IBM Corp. 2005, 2018 249

 • Data import begun and concluded
• Favorites section modifications
• Folder created and deleted
• Inquiry changes made in the client and web client
• Items scheduled, unscheduled, saved, added, run, renamed, started, and deleted
• Migration log on, log off, ended, and began
• Modified user information
• Modified View tables
• New model created
• Number of new rows imported into a table
• Number of rows updated in a table
• Password changed
• Payee enabled for web access
• Row update submission
• Sign off begun
• Star schema populated
• Started and completed optimization
• Tasks deferred or dismissed
• Task rules edited or added
• Trees and groups created, deleted, edited, and saved
• Updates to Presenter reports
• Upgrade models
• User modified
• Users log on, log on failed, and log off
• Web data edit
• What role the user is when added
• Portal Access entries
• Migrated object and objects deleted during migration

Filtering Audit log results

®
In IBM Incentive Compensation Management, you can filter results in the Audit log by user type, user ID,
module, event type, and date.

Procedure
1. Click Admin > Audit.
2. In the header of the column that you want to filter, click the Filter icon.
3. Select an item or items to filter by.
4. Click Apply filter.
Tip: You can also use the date fields in the toolbar to display the results for a specified period of time.

250 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Viewing details of table edits
®
In IBM Incentive Compensation Management, you can view details of changes that were made to tables
in Composer in the Audit log. Only the rows that were edited are displayed.

Procedure
1. Click Admin > Audit.
2. Filter the log to display table changes.
For example, filter the Event column by Data Saved.
3. Click the event that you want to view the details for.
Important: If a data import into a table causes a new payee to be added to the Payee table, the Audit
log shows both the update to the data table and the addition of the member to the Payee table.

Results
The details of the changes made to the table are displayed.

Exporting the Audit log

®
In IBM Incentive Compensation Management, you can export the contents of the Audit log to comma-
delimited, tab-delimited, or Microsoft Excel formats. An export is useful for creating an archive of old
Audit log contents.

Procedure
1. Click Admin > Audit.
2. Click Export.
3. Select a destination folder for the Audit log, type a file name, and select type of file that you want to
save the audit log as.
4. Click Save.

Setting Audit log options

®
In IBM Incentive Compensation Management, you can specify that you want an automated entry to be
created in the Audit log every time a user logs into or out of the web client. You can also specify the order
in which the events are sorted.

Procedure
1. Click Admin > More Options.
2. On the Audit Log tab, you can select the following options:
Option Description
Track web user log on/off Select this check box to specify that you want an automated entry to be
created in the Audit log every time a user logs into or out of the web
client.
Reverse the sort to show Select this check box to show the newest events first in the Audit log.
newest events first

Computation log
®
In IBM Incentive Compensation Management, the Computation log displays the time breakdown of a
calculation by calculated item. If you find that your calculation time is unusually slow, you can use this log
to pinpoint the source of the delay.
The Computation log lists the following information:

Logs 251
 • Version of Incentive Compensation Management
• Date and time of calculation
• Each calculation and length to calculate
• Any calculations that are started but not finished. They have a status of Started.

Disabling the generation of a Computation log

®
By default, IBM Incentive Compensation Management generates Computation logs automatically. You
can disable the generation of computation logs, if necessary.

About this task

When this the generation of Computation logs is enabled, the log lists all the names of your calculations
and how long they ran.

Procedure
1. Click Admin > More Options.
2. On the Calculation tab, clear the Enable generation of Computation Logs check box.

Viewing Computation log details

®
In IBM Incentive Compensation Management, you can view Computation logs in the Activity module.

About this task

The log lists all the names of your calculations and how long they ran.

Procedure
1. Open the Activity module.
2. Click the Filter icon and select Calculation.
3. Click View details next to the calculation run that you want to view the details for.

Error logs
®
In IBM Incentive Compensation Management, you can view any errors that occur during an export,
import, Scheduler process run, or Task Manager task generation.

Viewing the export error log

®
If an export was unsuccessful, the Export log in IBM Incentive Compensation Management provides
details about the problem.

About this task

For example, if the user exports a numeric column from a table into a Salesforce.com date column, the
error is displayed in the Export Errors log.

Procedure
1. Click Admin > Logs > Export Errors.
2. In the Export Errors log, you can complete the following tasks:
• View the details of error by clicking the link in the Summary column.
• Filter the results by clicking the Filter icon in each column header.
• View all errors within a specified date range.

252 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Viewing import exceptions log
®
In IBM Incentive Compensation Management, if a data import is unsuccessful, details of the problem
with the import is displayed in the Import log.

Procedure
1. Click Admin > Logs > Import Errors.
2. In the Import log, you can complete the following tasks:
• View the details of the failed import by clicking the link in the Summary column.
• Filter the results by clicking the Filter icon in each column header.
• View all errors within a specified date range.

Viewing the Scheduler error log

®
In IBM Incentive Compensation Management, the Scheduler log provides details about all Scheduler
errors and successful run information.

About this task

If the Scheduler service is not running before a user schedules an item, an error is displayed in the
Scheduler log. Scheduling conflicts might also affect the specified process run time. If a process is
scheduled at 11:00 p.m. and another at 11:01 p.m., the second process might not run because the first
process was not completed. If the second task cannot run, a message is displayed in the log.
The Scheduler log lists the following information:
• Date and time error occurred
• Description of error

Procedure
1. Click Admin > Logs > Scheduler.
2. You can filter the results by a selected date range.

Viewing the task error log

®
If an error is generated during task generation, the Task log in IBM Incentive Compensation Management
provides details about the error.

About this task

For example, if you generate tasks that try to email payees without a defined email address, you see a
message in the Task log.
The Task log lists the following information:
• Version of Incentive Compensation Management
• Date and time error occurred
• A statement about the error
• Error type
• Stack trace

Procedure
1. Click Admin > Logs > Task.
2. You can filter the results by a selected date range.

Logs 253
Signature log
®
The Signature log in IBM Incentive Compensation Management indicates whether payees accepted or
declined agreements in reports.
The Signature log lists the following information:
• Presenter report name
• Signature ID
• Payee
• Status (accepted or declined)
• Time

Viewing the Signature Control log

®
In IBM Incentive Compensation Management, you can view the status of agreements in the form of
Signature Controls added to Presenter reports.

Procedure
1. Click Admin > Signature Control.
2. In the header of any column, click the Filter icon to filter the results.

Performance log
®
You can view calculation performance in IBM Incentive Compensation Management.
You can view the following information on calculation performance:
Computations
You can view the duration of computations, which are calculation run tasks.
Single calculation
You can select a specific calculation that you want to view performance data for.
Computation comparison
You can compare two computations to view the difference in duration between the two calculation
runs.
Recommendation on changing calculation methods
You can view a graph of the last calculation runs to view the longest running calculations.

Viewing the calculation performance log

®
You can view the duration of full model calculations as well as single calculations in IBM Incentive
Compensation Management.

Procedure
1. Click Admin > Performance.
2. You can filter the columns or select a date range to filter results by.

Comparing computations
®
In IBM Incentive Compensation Management, you can compare two computations to view the difference
in duration between the two calculation runs.

Procedure
1. Click Admin > Performance.

254 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 2. In the Select column, select the check box next to the two calculations that you want to compare.
3. Click Compare.

Tenant log
®
The IBM Incentive Compensation Management tenant log displays user information for the model.
You can view the tenant log, filter the events that are displayed, and export the log to a .CSV file.

Viewing the tenant log

®
Use the IBM Incentive Compensation Management tenant to view events such as, login and logout times
for administrator users, when password changes are made, when administrator users are added or
deleted from the model, and when role changes are made.

Procedure
1. Next to the model name, click the drop-down arrow and click View Tenant Log.
2. In the Date From and the Date To fields, you can select dates to filter the log events by.

Exporting the tenant log

®
You can export the IBM Incentive Compensation Management tenant log to report on results.

Procedure
1. Next to the model name, click the drop-down arrow and click View Tenant Log.
2. Click Export.
The Tenant log is downloaded as a .CSV file.

Logs 255
256 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 30. Security
®
You can control access to IBM Incentive Compensation Management models. Users can be denied
access completely, granted access for viewing only, or granted access for both editing and viewing.
If access to a particular feature or module is denied, and a user tries to gain access, an Access Denied
message is displayed.
On the Manage Roles page, a empty check boxes and check boxes with subtraction signs or check marks
are used to indicate whether access is denied, partially granted, or granted.

Table 52: Role access indicators

Access Indicator Description
This is used to indicate that the user is denied access
to the module, object, or feature.
This is used to indicate that the user has partial access
to the module, object, or feature.
This is used to indicate that the user has been granted
full access to the module, object, or feature.

For example, a role can be granted partial access to Portal Access by granting view privileges but not edit
privileges. Any users who are assigned to this role can view any web tabs, Portal Access groups, or
access trees, but they are not permitted to edit content.

Roles
®
To protect the integrity of the data in your model, you can define security roles in IBM Incentive
Compensation Management.
The administrator role is created automatically and has full access to all modules by default. Initially, all
administrators belong to the administrator user group, but more roles with varying levels of access can be
created and assigned.
You can create user roles to restrict access to modules in Incentive Compensation Management. For each
role that is created, accessible modules are defined.
For example, you might have an administrator who is responsible for setting up and maintaining the
Portal Access hierarchy, but is not authorized to edit tables or reports. In this case, you might want to set
up a user group that has access to the Portal Access module, but cannot access the Composer module.
You can then assign the Portal Access administrator role to a user from the Manage Users page.
When an administrator changes a user's password through the Manage Users page, the password history
is not remembered by Incentive Compensation Management.
Important: To manage and assign user roles, you must be logged in as an administrator with permission
to edit and view administrative options.

Adding roles
®
You can add a roles to IBM Incentive Compensation Management.

Procedure
1. Click Admin > User and Permissions > Manage Roles.
2. Click Add new role at the bottom of the roles list.
3. Place your cursor over the new role and click the Edit icon to name the role.

© Copyright IBM Corp. 2005, 2018 257

 What to do next
Define permissions for the role.

Deleting roles
®
If a role is no longer needed, and if no users are assigned to it, you can delete the role from IBM Incentive
Compensation Management.

Procedure
1. Click Admin > User and Permissions > Manage Roles.
2. Select the role and click the Delete icon.

Copying roles
®
You can copy a role, along with its security, in IBM Incentive Compensation Management.

Procedure
1. Click Admin > User and Permissions > Manage Roles.
2. Place your cursor over the role and click the Copy icon.
3. Place your cursor over the new role and click the Edit icon to rename it.

Exporting roles
®
You can export the roles created in IBM Incentive Compensation Management to a .csv file.

Procedure
1. Click Admin > User and Permissions > Change Roles.
2. Click Export.

Role permissions
®
After you create a role in IBM Incentive Compensation Management, you can grant access to certain
items and deny access to others. By default, new roles are denied access to everything.

Access permissions
®
When a user role is given access to a module in IBM Incentive Compensation Management, certain
access rights or privileges go along with the module or feature.
Table showing access rights or privileges for each module or feature.

Table 53: Access rights

Module or feature Privileges
Activity Cancel All
Gives user permission to cancel other users' live activities (must also
have View All permission).
View All
Gives user permission to view all live activities.

258 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 53: Access rights (continued)
Module or feature Privileges
Audit log Edit
Gives user permission to clean up the Audit log (must also have View
permission).
View
Gives user permission to view, sort, filter, and show details of the
data.

Calculate Individual Calculation

Gives user permission to calculate a single calculation at a time.
View
Gives user permission to view calculation details but not run a
calculation on any items in the Calculation Type menu.
Run
Gives user permission to run a calculation on any items in the
Calculation Type list (must also have View permission).

Composer Add Views

Gives user permission to add a View table (must also have View and
Edit permissions for Composer as well as View and Edit permissions
for the space where the table will be added, that is, either the
component where the user is adding the table or the top level of
Composer).

Composer Component
For each component in Composer, including Producer Lifecycle and
Credential Management objects, users can be granted the following
actions:
Delete
Gives user permission to delete the component (must also have
View and Edit permissions for Composer as well as View and
Edit permissions for the space that contains the component, that
is, either the parent component or the top level of Composer).
Edit
Gives user permission to edit objects in the component or add
objects to the component (must also have View and Edit
permissions for Composer and View permission for the
component).
View
Gives user permission to view the objects inside a component
(must also have View permission for Composer).

Composer Edit
Gives user permission to edit and add objects to Composer that they
are granted View and Edit permissions for.

Security 259
Table 53: Access rights (continued)
Module or feature Privileges
Composer Input Forms
For all input forms in Composer, users can be granted the following
actions (must also have View and Edit permissions for Composer as
well as View and Edit permissions for the space that contains the
table, that is, either the component or the top level of Composer):
Add
Gives user permission to create a new input form for a table.
Delete
Gives user permission to delete input forms (must also have View
permission for the input form).
Edit
Gives user permission to edit pre-existing input forms and their
validation rules (must also have View permission for the input
form).

Composer Table
Users can be granted access to the following actions for input forms
and the structure of the table:
Input Forms
For each input form, users can be granted access to the following
actions (users must have permission to view the input form to
complete these actions):
Add
Gives user permission to add new rows to a table but not to
import data.
Delete
Gives user permission to delete existing rows in a table.
Edit
Gives user permission to edit existing rows in a table.
History
Gives user permission to click the History button when the
user is viewing table data.
View
Gives user permission to export rows to Microsoft Excel,
Publish, View Used By, and Web Data Edit (Edit Column
Permissions, View Restrictions, and Direct Edit).

260 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 53: Access rights (continued)
Module or feature Privileges
Composer Structure
For each table, users can be granted access to the following actions
(must also have View and Edit permissions for Composer as well as
View and Edit permissions for the space that contains the table, that
is, either the component or the top level of Composer):
Drop
Gives user permission to delete the table.
Edit
Gives user permission to add or remove table columns (must also
have View permission for the table structure).
Important: The structure of Hierarchy tables cannot be edited.
History
Gives user permission to purge table history.
Import
Gives user permission to import data to a table (must also have
View permission for the table structure). The user does not need
Edit permission for the component that contains the table.
View
Gives user permission to view table structure.

Composer TopComponent
Gives user permission to complete the following action to the top
level of Composer:
Edit
Gives user permission to edit the top level of Composer (must
also have View and Edit permissions for Composer).
View
Gives user permission to view the Composer module and the
components and objects on the top level. Users must be granted
access to components to view the objects inside them. Users with
View permission in Composer can also open the Calculation wizard
in read-only mode.
Web Data Edit
Gives user permission to view restrictions and edit column
permissions, approve or reject edits, and enable direct database
editing for tables that are enabled for Web Data Edit (must also have
View and Edit permissions for Composer as well as View and Edit
permissions for the space that contains the table, that is, either the
component or the top level of Composer).

Security 261
Table 53: Access rights (continued)
Module or feature Privileges
Data stores Data Store
Users can be granted access to the following actions for data stores:
Add
Gives user permission to create data stores in Composer.
Data Store
For each data store, users can be granted access to the following
actions (must also have View permission for Composer and the
component that contains the data store):
Delete
Gives user permission to remove the data store from
Composer (must also have View and Edit permissions for
Composer and the component that contains the data store).
Edit
Gives user permission to edit the data store.
View
Gives user permission to view the data store object in
Composer.

Home page Admin Options

Edit
Gives user permission to edit the administrative options for the
current model (must also have View permission for
administrative options).
View
Gives user permission to view the administrative options for the
current model.

Home page Calendars

Edit
Gives user permission to edit calendars (must also have View
permission for Calendars).
Period Locking
Gives user permission to lock and unlock all calendars in the
model (must also be granted View permission for calendars to
lock periods).
Period Purging
Gives user permission to complete all actions in period purging.
View
Gives user permission to view the list of calendars.

262 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 53: Access rights (continued)
Module or feature Privileges
Home page Manage Data Grid Templates
Add
Gives user permission to add and duplicate templates. Must also
have View permission.
Delete
Gives user permission to delete templates. Must also have View
permission.
Edit
Gives user permission to edit and set default templates. Must
also have View permission.
View
Gives user permission to view templates.

Home page Manage History Tracking

Edit
Gives user permission to enable or disable history tracking in the
Administrative Options window.
View
Gives user permission to view the history tracking option in the
Administrative Options window.

Home page Manage Saved Imports

Delete
Gives user permission to delete saved imports (must have View
permission for Saved Imports).
Edit
Gives user permission to edit saved imports (must have View
permission for Saved Imports).
View
Gives user permission view the list of saved imports and run
saved imports.

Home page Manage Saved Publications

Delete
Gives user permission to delete saved publications (must have
View permission for Saved Publications).
Edit
Gives user permission to edit saved publications (must have View
permission for Saved Publications.)
View
Gives user permission to view the list of saved publications and
run saved publications.

Security 263
Table 53: Access rights (continued)
Module or feature Privileges
Home page Manage Saved Transformations
Delete
Gives user permission to delete saved transformations (must
have View permission for Saved Transformations).
Edit
Gives user permission to edit saved transformations (must have
View permission for Saved Transformations).
View
Gives user permission to view the list of saved transformations
and run saved transformations.

Home page Migrations

Edit
Gives user permission to create a migration (must also have
Execute permission).
Execute
Gives user permission to run a migration (must also have Edit
permission).
Optimize Model
Gives user permission to run the Model Optimization SQL process.

Manage Theme Gives user permission to enable custom headers that will appear in the
Web Client. Custom headers allow the use of logos and color changes.

Home page Payee Groups

Edit
Gives user permission to edit payee groups (must also have View
permission).
View
Gives user permission to view the list of payee groups.

Home page Process Lists

Add
Gives user permission to add a process list.
Process List Name
Gives user permission to complete the following actions on a
specific process list:
Delete
Gives user permission to delete the process list (must also
have View permission).
Edit
Gives user permission to edit the process list (must also have
View permission).
View
Gives user permission to view the process list.

264 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 53: Access rights (continued)
Module or feature Privileges
Home page Star Schema
Edit
Gives user permission to edit existing star schemas and create
new ones (must also have View permission).
View
Gives user permission to view existing star schemas.

Import Advanced
Gives user permission to select the Use Advanced Settings check
box to enter a custom connection string when the user is importing
from an ODBC database (must also have View and Edit permissions
for Composer, View and Edit permissions for the space that contains
the table, that is, either the component or the top level of Composer,
Edit permission for the table, and Import > Data permission).
Data
Gives user permission to import data into a table (must also have
View and Edit permissions for Composer as well as View and Edit
permissions for the space that contains the table, that is, either the
component or the top level of Composer and Edit permission for the
table).

Import Files
Edit
Gives user permission to overwrite and delete saved import files
on the Downloads page (must also have View permission).
View
Gives user permission to view saved import files on the
Downloads page.

Portal Access Edit

Gives user permission to edit all items that are contained in Portal
Access tabs (must also have View permission for Portal Access and
access to compensation plans, Presenter, and web forms to view
their assignment, sign off, and inquiries in Portal Access).
View
Gives user permission to view all tabs in Portal Access and the items
that are contained within (must also have access to compensation
plans, Presenter, and web forms to view their assignments, sign off,
and inquiries in Portal Access).

Presenter Audit Log

View
Gives user permission to use the Audit log as a data source in
Presenter reports (must have View permission to Presenter).
View
Gives user permission to complete all functions in Presenter (must
have Presenter Audit log View access to use the Audit logs as a data
source).

Security 265
Table 53: Access rights (continued)
Module or feature Privileges
Pulse View
Gives user permission to view all plans and reports in the Pulse
module.
Edit
Gives user permission to complete all functions in the Pulse module
(must also have View permission for the Pulse module).

Query Tool View

Gives user permission to view and use the Query Tool feature.

Scenarios Promote
Gives user permission to promote scenarios (must also have View
permission).
View
Gives user permission to view the Scenarios module, create
workspaces and scenarios (to create workspaces, the user must also
have permission for specified compensation plans).
Workspace
Workspace Name
Gives user permission to view and edit the workspace (must also
have View permission for Scenarios module).

Scheduler View
Gives user permission to view and run tasks in Scheduler.
Edit
Gives user permission to complete the following functions in
Scheduler; adding and removing tasks and processes, setting the
Scheduler properties, pausing and activating the Scheduler service,
and enabling and disabling tasks (users must also have View
permission).

Tasks View
Gives user permission to complete all functions in Task Manager.

Web forms View

Gives user permission to complete all functions in web forms (users
do not need separate access to tables and calculations to use them in
web forms).

266 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 53: Access rights (continued)
Module or feature Privileges
Workflow Manager Edit
Gives user permission to edit preexisting workflows (must also have
View permission for the workflow).
View
Gives user permission to view the Workflow Manager.
Workflow Name
For each workflow, the user can be granted the following actions
(users must also have View permission for Workflow Manager):
Execute
Gives user permission to start the workflow process (must also
have View permission for the workflow).
Edit
Gives user permission to add workflows in Workflow Manager
(must also have View permission).
View
Gives user permission to view the workflow.

Process list security

To give roles permission to create, view, edit, duplicate, or delete process lists, you must grant access in
®
IBM Incentive Compensation Management.

Giving roles permission to add a process list

®
You can grant a role permission to create process lists in IBM Incentive Compensation Management.
Users who are assigned to these roles also have permission to edit, duplicate, and delete any process list
that they create.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Process List.
3. Select the Add check box.

Giving roles permission to view a process list

®
You can grant a role view-only permission for specific process lists in IBM Incentive Compensation
Management. Users who are assigned to this role cannot create or edit process lists.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Process List.
3. Expand the process list that you want the role to have permission to view.
4. Select the View check box.

Security 267
 Giving roles permission to view and edit a process list
®
You can grant a role permission to edit and duplicate specified process lists in IBM Incentive
Compensation Management. If users who are assigned to this role create a duplicate of a process list,
they automatically have view, edit, and delete permissions for the process list.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Process List.
3. Expand the process list that you want the role to have permission to view.
4. Select the View check box.
5. Select the Edit check box.

Giving roles permission to delete a process list

®
You can grant a role permission to delete a specified process list from the IBM Incentive Compensation
Management client.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Process List.
3. Expand the process list that you want the role to have permission to delete.
4. Select the View check box.
5. Select the Delete check box.

Composer security
®
You can grant a role permission to view and edit Composer in IBM Incentive Compensation Management.
You can set security for specific components, tables, and input forms in Composer. You can also grant
permission to add View tables and permission to perform web data edits.

Giving roles permission to view Composer

®
You can grant a role view-only permission for Composer in IBM Incentive Compensation Management.
Users who are assigned to this role can open and view Composer and view components and other objects
on the top level of Composer, but they cannot drill into components.

About this task

Users with view-only permission can complete the following actions on objects in the top level of
Composer:
• View the Uses and Used By trees of objects
• Use the Visibility icons
• Export the Composer diagram
• Publish table and calculation data
• View calculation history
• Open calculations in read-only mode
• Edit table descriptions
• Add objects to the Favorites list

268 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer.
3. Select the View check box.

Giving roles permission to view and edit the top level of Composer
®
You can grant a role permission to view the top level of the Composer module in IBM Incentive
Compensation Management and to add objects to the top level.

About this task

To add View tables to Composer, users must be granted additional permissions.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer.
3. Select the View check box.
4. Select the Edit check box.
5. Select the TopComponent check box.

Component security
®
In IBM Incentive Compensation Management, you can grant or restrict access to each component in
Composer.
To access a component, the role must also have View permission for Composer. To edit and add objects
to a component, the role must have Edit permission for the component as well as Composer.
Security for Producer Lifecycle and Credential Management objects is handled in the same way as
components.

Giving roles permission to view a component

®
In IBM Incentive Compensation Management, you can grant a role view-only permission for a component
in Composer. Users who are assigned to this role can drill into the component and view the objects inside,
and they can open the component from the Home page and from Composer.

About this task

Users can complete the following actions on the objects inside the component:
• View the Uses and Used By trees of objects
• Publish table and calculation data
• Preview and view current values of calculations and connections
• Edit table descriptions
• Edit connections
• View the parent component of objects
• Add objects to the Favorites list

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer.

Security 269
 3. Select the View check box.
4. Expand the component that you want to grant the role permission to view.
5. Select the View check box.

Giving roles permission to view and edit a component

®
In IBM Incentive Compensation Management, if a role has View and Edit permissions for a component in
Composer, you can grant the role permission to add connections to the component, edit calculations in
the component, and wrap objects into child components.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer.
3. Grant View and Edit permissions for Composer. If the component is in the top level of Composer,
select the TopComponent check box.
4. Expand the component that you want to grant the role permission to view.
5. Select the View check box.
6. Select the Edit check box.

Giving roles permission to delete a component

®
In IBM Incentive Compensation Management, you can grant a role permission to delete components in
Composer. The role must also have View and Edit permissions for its parent component and for
Composer.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer.
3. Grant View and Edit permissions for Composer.
• If the component is in the top level of Composer, select the Top check box.
• If the component is inside a parent component, grant View and Edit permissions for the parent
component.
4. Expand the component that you want to give the role permission to delete.
5. Select the Delete check box.

Table security
®
In IBM Incentive Compensation Management, you can grant a role permission to create, view, and edit
input forms and the structure of tables in Composer. You can also grant permission to complete data
imports and web data edits, and add View tables.

Giving roles permission to view the structure of a table

®
In IBM Incentive Compensation Management, you can grant a role view-only permission for the structure
of a table in Composer. Users who are assigned to the role can view the table structure, add the table to
the Favorites list, edit the table description, publish the table data, and view its uses.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Grant View permission for Composer.
3. Grant View permission for the component that contains the table.
4. Expand Table.

270 IBM Incentive Compensation Management Version 10.0.0 : User Guide

5. Expand the table whose structure you want the role to be able to view.
6. Expand Structure.
7. Select the View check box.

Giving roles permission to view and edit the structure of a table

®
In IBM Incentive Compensation Management, you can grant a role permission to view and edit the
structure of a table in Composer. Users who are assigned to this role can add and remove columns in the
table.

About this task

To make changes to the table's structure, the role must also have View permission.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Grant View permission for Composer.
3. Grant View permission for the component that contains the table.
4. Expand Table.
5. Expand the table that you want the role to be able to view and edit.
6. Expand Structure.
7. Select the View check box.
8. Select the Edit check box.

Giving roles permission to purge change log history

®
In IBM Incentive Compensation Management, you can grant a role permission to clear history that is
collected for specific tables in Composer.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer.
3. Expand the table that you want to grant the role permission for.
4. Expand Structure.
5. Select the History check box.

Giving roles permission to delete a table

®
In IBM Incentive Compensation Management, you can grant a role permission to delete a table from
Composer.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Grant View and Edit permissions for Composer.
3. Grant View and Edit permissions for the component that contains the table. To delete a table from the
top level of Composer, select the TopComponent check box.
4. Expand Table.
5. Expand the table that you want the role to be able to delete. A table can be deleted only if it has no
dependencies.
6. Expand Structure.
7. Select the Drop check box.

Security 271
 Giving roles permission to add a View table
®
In IBM Incentive Compensation Management, you can grant a role permission to add View tables in
Composer.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer.
3. Select the Add Views check box.
4. Grant View and Edit permissions for Composer.
5. To add a View table to a component, grant View and Edit permissions for the component.
6. To add a table to the top level of Composer, select the TopComponent check box.

Giving roles permission to enable web data edit for tables

®
In IBM Incentive Compensation Management, you can grant a role permission to enable web data edits
for tables in Composer. Users who are assigned to this role can view the row restrictions for the table,
edit the column permissions, approve or reject edits that are made by web users, and enable direct
database editing for tables that were enabled for web data edit.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer.
3. Select the Web Data Edit check box.
4. Grant View and Edit permissions for Composer.
5. To access the Web Data Edit menu options for a table in a component, grant View and Edit
permissions for the component.
6. If the table is in the top level of Composer, select the TopComponent check box.

Import data security

®
In IBM Incentive Compensation Management, you can grant a role permission to import data into tables
in Composer.
If users are importing data from an ODBC-compliant database, you can grant permission for advanced
settings. Advanced settings allow the role to enter a custom connection string during data import.

Giving roles permission to import data

®
In IBM Incentive Compensation Management, you can grant a role permission to import data into
specified tables in Composer.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Grant View permission for Composer.
3. Grant Edit permission for Composer.
4. Grant View permission for the component that contains the table.
5. Expand Table.
6. Expand the table that you want to allow the role to import data to.
7. Expand Structure.
8. Select the Import check box.
9. Select the View check box.

272 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Giving roles permission to use advanced settings to import data from an ODBC-compliant database
®
In IBM Incentive Compensation Management, you can grant a role permission to use advanced import
settings in Composer. Users can select the Use Advanced Settings to enter a custom connection string
when they import data from an ODBC-compliant database.

About this task

The role must have View and Edit permissions for Composer.
To import data into a table in a component, the role must have View and Edit permissions for the
component.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Import.
3. Select the Advanced check box.
4. Select the Data check box.
5. Expand Composer > Table.
6. Expand the table that you want to allow the role import data to.
7. Expand Structure.
8. Select the Edit check box.
9. If the table is in the top level of Composer, select the TopComponent.

Giving roles permission to view import files

®
In IBM Incentive Compensation Management, you can grant a role permission to view the import files on
the Downloads page.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Import.
3. Expand Files.
4. Select the View check box.

Giving roles permission to overwrite saved import files

®
In IBM Incentive Compensation Management, you can grant a role permission to overwrite or delete
saved import files.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Import.
3. Select the Files check box.
This enables both the View and Edit functionality for the Downloads page.

Security 273
Input form security
®
In IBM Incentive Compensation Management, you can grant a role permission to view input forms, view
the history of changes that were made to input forms, and add, edit, and delete rows in specified input
forms in Composer.

Giving roles permission to add an input form

®
In IBM Incentive Compensation Management, you can grant a role permission to add input forms for any
tables in Composer.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer > Input Forms.
3. Select the Add check box.
4. Grant View and Edit permissions for Composer.
5. To add input forms to a table in a component, grant View and Edit permissions for the component.
6. If the table is in the top level of Composer, select the TopComponent check box.

Giving roles permission to delete an input form

®
In IBM Incentive Compensation Management, if a role has View access for a table in Composer, you can
grant the role permission to delete input forms from the table.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer > Input Forms.
3. Select the Delete check box.
4. Expand Table.
5. Expand the table that contains the input form that you want to allow the user to delete.
6. Expand the input form that you want to allow the user to delete.
7. Select the View check box.
8. Grant View and Edit permissions for Composer.
9. To add input forms to a table in a component, grant View and Edit permissions for the component.
10.If the table is in the top level of Composer, select the TopComponent check box.

Giving roles permission to edit an input form

®
In IBM Incentive Compensation Management, you can grant a role permission to edit input forms that
they have access to in Composer.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Grant View and Edit permissions for Composer.
3. To edit the input forms of a table in a component, grant View and Edit permissions for the component.
4. If the table is in the top level of Composer, select the TopComponent check box.
5. Expand Composer > Input Forms.
6. Select the Edit check box.
7. Expand Table.
8. Expand the table that you want to allow the user to edit.
9. Expand the input form that you want to allow the user to edit.

274 IBM Incentive Compensation Management Version 10.0.0 : User Guide

10.Select the View check box.

Giving roles permission to add rows to an input form

®
In IBM Incentive Compensation Management, you can grant a role permission to use an input form to
add rows to a table in Composer. This permission does not allow users to import data into the table.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer > Table.
3. Expand the table that contains the input form that you want to allow users to add rows to.
4. Expand the input form that you want to allow users to add rows to.
5. Select the View check box.
6. Select the Add check box.

Giving roles permission to delete rows from a table

®
In IBM Incentive Compensation Management, you can grant a role permission to remove rows from a
table in Composer.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer > Table.
3. Expand the table that contains the input form that you want to allow users to delete rows from.
4. Expand the input form that you want to allow users to delete rows from.
5. Select the View check box.
6. Select the Delete check bo.

Giving roles permission to edit data in a table

®
In IBM Incentive Compensation Management, you can grant a role permission to edit rows in a table in
Composer.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer > Table.
3. Expand the table that contains the input form that you want to allow users to edit rows in.
4. Expand the input form that you want to allow users to edit rows in.
5. Select the View check box.
6. Select the Edit check box.

Giving roles permission to view the history of a table

®
In IBM Incentive Compensation Management, you can grant a role permission to view the details of edits
that were made to rows in a table in Composer.

About this task

When you grant this permission, users can click the History button to view the details of edits that were
made to the rows in a table.

Security 275
 Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer > Table.
3. Expand the table that contains the input form whose history you want to allow users to view.
4. Expand the input form whose history you want to allow users to view.
5. Select the View check box.
6. Select the History check box.

Data store security

®
You can grant a role permission to specific data stores in IBM Incentive Compensation Management. You
can also grant permission to view, edit, and or delete data store objects in Composer.

Giving roles permission to view a data store

®
In IBM Incentive Compensation Management, you can grant a role view-only permission for a specific
data store in Composer. Users who are assigned to this role can add the data store to the Favorites list
and view the Uses and Used By trees, but they cannot edit the data store.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Grant View access to Composer.
3. If the data store is in a component, also grant View access to the component.
4. Expand Data Store.
5. Expand the data store that you want to grant View permission for.
6. Select the View check box.

Giving roles permission to view and edit a data store

®
In IBM Incentive Compensation Management, you can grant a role permission to view and edit data store
objects in Composer. Users who are assigned to this role can edit the data store.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Grant View and Edit permissions for Composer.
3. If the data store is in a component, also grant View and Edit permissions for the component.
4. Expand Data Store.
5. Expand the data store that you want to grant View and Edit permissions to.
6. Select the View check box.
7. Select the Edit check box.

Giving roles permission to view and delete a data store

®
In IBM Incentive Compensation Management, you can grant a role permission to view and remove data
store objects from Composer.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Composer.
3. Select the View check box.

276 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 4. Select the Edit check box.
5. If the data store is in a component, also grant View and Edit permissions for the component.
6. Expand Data Store.
7. Expand the data store that you want to grant View and Delete permission for.
8. Select the View check box.
9. Select the Delete check box.

Scenarios security
®
In IBM Incentive Compensation Management, you can grant a role permission to create workspaces and
scenarios. You can grant a role permission to promote scenarios to replace the current data in the model.

Giving roles permission to view the Scenarios module and create workspaces
®
In IBM Incentive Compensation Management, you can grant a role permission to open and view the
Scenarios module.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Scenarios.
3. Select the View check box.

Results
When a user creates a public workspace, all users with permission to view the Scenarios module can view
the workspace. When a user creates a private workspace, only the user who created the workspace and
the administrator can view it. You can change public and private access to the workspace in the Manage
Roles window.

Giving roles permission to add and edit a scenario in a workspace

®
In IBM Incentive Compensation Management, you can grant a role permission to view and edit a
workspace in the Scenarios module.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Scenarios.
3. Select the View check box.
4. To allow the role to view and edit scenarios in a workspace, expand Workspaces.
5. Select the check box next to the workspace that you want to give the role permission to edit.

Giving roles permission to promote a scenario

®
In IBM Incentive Compensation Management, you can grant a role permission to replace the current data
in a model with the new data from their scenario in the Scenarios module.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Scenarios.
3. Select the View check box.
4. Select the Promote check box.
5. Expand Workspaces.
6. Grant the role permission for the workspace that contains the scenarios.

Security 277
Web form security
®
In IBM Incentive Compensation Management, you can grant a role permission to edit existing web forms
in Composer.

Giving roles permission to open and edit web forms

®
In IBM Incentive Compensation Management, you can grant a role permission to complete all functions
in web forms in Composer.

About this task

Users do not need separate access to tables to use them in web forms. To add web forms to Composer,
users also need View and Edit permissions for Composer and for the component that they want to add
web forms to.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Web Forms.
3. Select the View check box.

Presenter report security

®
In IBM Incentive Compensation Management, you can grant a role permission to edit Presenter reports
and use the Audit log as a source in Presenter.

Giving roles permission to view a Presenter report object in Composer

®
In IBM Incentive Compensation Management, you can grant a role view-only permission to view a
Presenter report object in Composer. Users who are assigned to this role must also have permission to
view Composer and the component that contains the report.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Presenter.
3. Select the View check box.
4. Grant View permission for Composer.
5. Grant View permission for the component that contains the Presenter report.

Giving roles permission to open and edit a Presenter report

®
In IBM Incentive Compensation Management, you can grant a role permission to complete all functions
in a Presenter report in Composer.

About this task

To open existing Presenter reports and add new Presenter reports in Composer, the role must also have
View and Edit permissions for Composer and View and Edit permissions for the component where they
want to add Presenter reports.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Presenter.
3. Select the View check box.
4. Grant View and Edit permissions for Composer.

278 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 5. Grant View and Edit permissions for the component the report is in.
6. If the report is in the top level of Composer, select the TopComponent check box.

Giving roles permission to use the Audit log as a source in Presenter reports
®
In IBM Incentive Compensation Management, you can grant a role permission to add the Audit log in as a
data source in Presenter reports.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Presenter.
3. Select the View check box.
4. Expand Audit Log.
5. Select the View check box.

Pulse security
®
In IBM Incentive Compensation Management, you can grant a role permission to view, or view and edit,
plans and reports in the Pulse module.

Giving roles permission to view Pulse

®
In IBM Incentive Compensation Management, you can grant a role view-only permission for all items in
Pulse.

About this task

Roles with view-only access to the Pulse module can view all plans, tags, and calendar settings but
cannot make any changes.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Pulse.
3. Select the View check box.

Giving roles permission to edit Pulse plans and reports

®
In IBM Incentive Compensation Management, you can grant a role permission to complete all functions
in Pulse.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Pulse.
3. Select the View check box.
4. Select the Edit check box.

Portal Access security

®
IBM Incentive Compensation Management, you can grant a role view-only permission to Portal Access.
To view the assignments, sign offs, and inquiries for Presenter reports and web forms, users must also be
granted view permission for Presenter reports and web forms. Users can also be granted the ability to
perform all actions in the Portal Access module. To set Portal Access assignments for Presenter reports
and web forms, user must have view permission for them.

Security 279
 Giving roles permission to view the Portal Access module
®
In IBM Incentive Compensation Management, you can grant a role view-only permission for Portal
Access.

About this task

To view the assignments, sign off and inquiry trees for Presenter reports and web forms on the
Assignment, Sign Off, and Inquiries tabs, users must have view permission for Presenter reports and
web forms.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Portal Access.
3. Select the View check box.
4. To allow users to view the assignment, sign off, and inquiries for Presenter reports, grant View
permission for Presenter.
5. To allow users to view the assignment, sign off, and inquiries for web forms, grant View permission for
web forms.

Giving roles permission to view and edit the Portal Access module
®
In IBM Incentive Compensation Management, you can grant a role permission to edit all items in Portal
Access.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Portal Access.
3. Select the View check box.
4. Select the Edit check box.
5. To allow users to view the assignment, sign off, and inquiries for Presenter reports, grant View
permission for Presenter.
6. To allow users to view the assignment, sign off, and inquiries for web forms, grant View permission for
web forms.

Scheduler security
®
In IBM Incentive Compensation Management, you can grant a role permission to view or make changes
in Scheduler.
To open the Scheduler module and run processes and tasks, a user can have view-only access to the
Scheduler module.
To add processes and tasks, change Scheduler properties, pause or activate the Scheduler service, or
enable and disable tasks, a user must have view and edit permission.

Giving roles permission to view the Scheduler module

®
In IBM Incentive Compensation Management, you can grant a role permission to see the Scheduler
module and run processes.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Scheduler.
3. Select the View check box.

280 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Giving roles permission to edit the Scheduler module
®
In IBM Incentive Compensation Management, you can grant a role permission to make changes in
Scheduler. Users who are assigned to this role can add and remove tasks and processes, set Scheduler
properties, pause and activate the Scheduler service, and enable and disable tasks.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Scheduler.
3. Select the View check box.
4. Select the Edit check box.

Setting Task Manager security

®
In IBM Incentive Compensation Management, you can grant access users access to Task Manager to add
tasks and alerts.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Tasks.
3. Select the View check box.

Audit module security

®
In IBM Incentive Compensation Management, you can grant a role view-only permission for the Audit
logs, or you can grant access to allow users to edit the Audit logs.

Giving roles permission to view the Audit module

®
In IBM Incentive Compensation Management, you can grant a role view-only permission for the Audit
logs. Users who are assigned to this role can view, sort, filter, and show the details of the data in the Audit
logs, but they cannot remove data.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Audit Log.
3. Select the View check box.

Giving roles permission to view and edit the Audit module

®
In IBM Incentive Compensation Management, you can grant a role permission to view and edit the Audit
logs. Users who are assigned to this role can view, sort, filter, show the details of data and clean up the
Audit log.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Select the Audit Log check box.

Security 281
Workflow Manager security
®
In IBM Incentive Compensation Management, you can grant a role permission to view Workflow
Manager, create workflows, edit existing workflows, and run workflows.

Giving roles permission to view Workflow Manager

®
In IBM Incentive Compensation Management, you can grant a role view-only permission for Workflow
Manager. To view workflows, users who are assigned to this role must also have view access to each
workflow.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Workflow Manager.
3. Select the View check box.

Giving roles permission to view Workflow Manager and create workflows

®
In IBM Incentive Compensation Management, you can grant a role permission to view Workflow
Manager and add workflows.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Workflow Manager.
3. Select the View check box.
4. Select the Edit check box.

Giving roles permission to view a workflow

®
In IBM Incentive Compensation Management, you can grant a role view-only permission for a workflow
in Workflow Manager.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Workflow Manager.
3. Select the View check box.
4. Expand the workflow that you want the user to be able to view.
5. Select the View check box.

Giving roles permission to edit a workflow

®
In IBM Incentive Compensation Management, you can grant a role permission to edit a workflow in
Workflow Manager.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Workflow Manager.
3. Select the View check box.
4. Expand the workflow that you want the user to be able to edit.
5. Select the View check box.
6. Select the Edit check box.

282 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Giving roles permission to start a workflow
®
In IBM Incentive Compensation Management, you can grant a role permission to start a workflow in
Workflow Manager.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Workflow Manager.
3. Select the View check box.
4. Expand the workflow that you want the user to be able to start.
5. Select the View check box.
6. Select the Execute check box.

Setting calculate security

®
You can grant a role permission to view details of a calculation run in IBM Incentive Compensation
Management and to run a calculation on any item. To preview or view calculation data in the Composer
model, users who are assigned to this role must also have view permission for calculation runs.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Calculate.
3. To allow the user to view details for a calculation run, select the View check box.
4. To allow the user to view and run a calculation, grant View and Run permission.

Administration security
®
In IBM Incentive Compensation Management, you can grant a role permission to set administrative
options, run and edit saved imports, run and edit saved publications and edit saved transformations.
By default, all administrator users can see the Home page, including the information in the Admin menu.
Additionally, all administrators can create web messages, manage documents, change their password,
and view and export the Model Summary from the Admin menu. All other rights must be granted to a
user's role to allow the user to be able to act upon items.

Giving roles permission to view administrative options

®
In IBM Incentive Compensation Management, you can grant a role view-only permission for
administrative options for the current model. Users who are assigned to this role cannot make any
changes.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Admin Options.
3. Select the View check box.

Giving roles permission to view and edit administrative options

®
In IBM Incentive Compensation Management, you can grant a role permission to view and edit the
administrative options in a model.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.

Security 283
 2. Expand Home Page.
3. Select the Admin Options check box.

Giving roles permission to view and run saved imports

®
You can grant a role permission to view and run saved imports in IBM Incentive Compensation
Management.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Manage Saved Imports.
3. Select the View check box.

Giving roles permission to view, run, and edit saved imports

®
You can grant a role permission to view, run, and edit saved imports in IBM Incentive Compensation
Management.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Manage Saved Imports.
3. Select the View check box.
4. Select the Edit check box.

Giving roles permission to view, run, and delete saved imports

®
You can grant a role permission to view, run, and delete saved imports in IBM Incentive Compensation
Management.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Manage Saved Imports.
3. Select the View check box.
4. Select the Delete check box.

Giving roles permission to view and run saved publications

®
You can grant a role permission to view and run saved publications in a IBM Incentive Compensation
Management model.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Manage Saved Publications.
3. Select the View check box.

Giving roles permission to view, run, and edit saved publications

®
You can grant a role permission to view, run, and edit saved publications in IBM Incentive Compensation
Management.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.

284 IBM Incentive Compensation Management Version 10.0.0 : User Guide

2. Expand Home Page > Manage Saved Publications.
3. Select the View check box.
4. Select the Edit check box.

Giving roles permission to view, run, and delete saved publications

®
You can grant a role permission to view, run, and delete saved publications in IBM Incentive
Compensation Management.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Manage Saved Publications.
3. Select the View check box.
4. Select the Delete check box.

Giving roles permission to view saved transformations

®
You can grant a role view-only permission for saved transformations in a IBM Incentive Compensation
Management model.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Manage Saved Transformations.
3. Select the View check box.

Giving roles permission to view and edit saved transformations

®
You can grant a role permission to view and edit saved transformations in IBM Incentive Compensation
Management.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Manage Saved Transformations.
3. Select the View check box.
4. Select the Edit check box.

Giving roles permission to view and delete saved transformations

®
You can grant a role permission to view and delete any saved transformation from an IBM Incentive
Compensation Management model.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Manage Saved Transformations.
3. Select the View check box.
4. Select the Delete check box.

Security 285
 Giving roles permission to add documents to the Manage Documents window
®
You can grant a role permission to view and add documents in IBM Incentive Compensation
Management. Users who are assigned to this role must also have view and edit permissions for Portal
Access.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Select the Portal Access check box.

Tools security
®
You can grant a role permissions that are related to tools in IBM Incentive Compensation Management.
Users who are assigned to these roles can optimize models, view and edit calendars, view and edit payee
groups, view and create star schemas, perform migrations, and manage the client and web theme.

Giving roles permission to optimize a model

®
You can grant a role permission to run the Model Optimization SQL process from IBM Incentive
Compensation Management.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page.
3. Select the Optimize Model check box.

Giving roles permission to view calendars

®
You can grant a role view-only permission for the list of calendars in an IBM Incentive Compensation
Management model.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Calendars.
3. Select the View check box.

Giving roles permission to view and edit calendars

®
You can grant a role permission to view and edit the calendars in an IBM Incentive Compensation
Management model.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Calendars.
3. Select the View check box.
4. Select the Edit check box.

286 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Giving roles permission to view and lock calendars
®
You can grant a role permission to view and lock calendars in an IBM Incentive Compensation
Management model.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Calendars.
3. Select the View check box.
4. Select the Period Locking check box.

Giving roles permission to view payee groups

®
You can grant users view-only permission for the list of payee groups in an IBM Incentive Compensation
Management model.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Payee Groups.
3. Select the View check box.

Giving roles permission to view and edit payee groups

®
You can grant a role permission to edit the payee groups in an IBM Incentive Compensation Management
model.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Payee Groups.
3. Select the View check box.
4. Select the Edit check box.

Giving roles permission to view star schemas

®
You can grant a role view-only permission for the star schemas in an IBM Incentive Compensation
Management model.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Star Schema.
3. Select the View check box.

Giving roles permission to view and edit star schemas

®
You can grant a role permission to view, delete, and create star schemas in IBM Incentive Compensation
Management.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Star Schema.
3. Select the View check box.

Security 287
 4. Select the Edit check box.

Giving roles permission to perform a migration

®
You can grant a role permission to perform a migration in the target IBM Incentive Compensation
Management model. The user must use the administrator role user name and password to connect to the
source model and must have both edit and execute permission in the target model.

Procedure
1. Click Admin > User and Permissions > Manage Roles, and select the role that you want to grant
permissions for.
2. Expand Home Page > Migrations.
3. Select the Edit check box.
4. Select the Execute check box.

User security
®
In IBM Incentive Compensation Management, you can add, edit, or delete administrator user IDs, email
addresses, and passwords. You can also assign user roles.
Each administrator can be assigned a user role that grants them appropriate access rights. Users without
sufficient privileges to access a module are denied access.

Adding users
®
You can add new users and then assign roles that grant them access to IBM Incentive Compensation
Management.

Procedure
1. Click the model name in the header of the application.
2. Click Model Options.
3. Click Add User.
4. Type the first and last name for the user and click Done.
5. Type all required information for the user.
6. You can choose one of the following user permissions:
Permission Description
All permissions This gives the user permission to add and delete users, assign and
remove users from models, and change other users' passwords.
Add and delete users in This gives the user permission to add and delete users, and assign and
models remove users from models.
No permissions This prevents the user from adding or modifying users.
7. Click Finish.

Concurrent users
®
After you define and assign roles to different users, they can log in to IBM Incentive Compensation
Management simultaneously, so that multiple users can complete actions on the model at the same time.
For example, while Administrator User 1 is adding a table to the model, Administrator User 2 can be
logged in concurrently to edit a calculation.
The exception to this rule occurs when multiple administrators try to simultaneously perform a global
action on the model, such as a calculation or data import. One calculation must be completed before
another one can start, and only one data import can occur at a time. If a second administrator tries to

288 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 perform a calculation or data import while another one is in progress, the second administrator sees a
warning message.
The second administrator must wait for the first administrator's global action to complete.
In general, when two or more administrators are making unrelated changes in the model, all
administrators can make changes without any type of warning. When two administrators are making
changes to the same information, the second administrator receives a reminder to refresh the data before
it can be saved.
The following table provides examples of multi-administrative situations. This table covers common
examples of multiple administrators trying to simultaneously make changes in the same module, as well
as administrators trying to make changes while a calculation or import is in progress. In all cases where
administrators are making unrelated changes in different modules, all administrators can make and save
changes without warnings.
Examples of multi-administrative situations

Table 54: Common multi-administrative situations

Module/Action Situation
Imports If multiple administrators try to import data into a table, the first administrator to
finish a data import completes the import without warning. All other
administrators are informed that the first administrator's import must complete
before they can complete their imports.
Imports If an administrator is performing an import and a second administrator tries to add
a row to the same table, the second administrator is informed that the first
administrator's import must complete before the second administrator can add a
row.
Calculate If an administrator tries to calculate the model while another calculation is in
progress, the second administrator is informed that the calculation cannot proceed
because another calculation is in progress.
Composer If multiple administrators try to add or edit different rows in a table, all
administrators can make and save changes without warning.
Composer If an administrator tries to edit a table while another administrator is trying to clear
the same table, the first administrator to click Save can save changes without
warning. All subsequent administrators are instructed to refresh the data before
they can save.
Composer If an administrator tries to edit a table while another administrator is trying to clear
a different table, all administrators can make and save changes without warning.
Composer If multiple administrators are editing the same row simultaneously, the first
administrator to click Save can save changes without warning. All subsequent
administrators are instructed to refresh the data before they can save.
Composer If two administrators try to add new payee groups, both administrators can make
and save changes without warning.
Portal Access If multiple administrators are simultaneously creating Portal Access groups, all
administrators can make and save changes without warning.
Input Forms If multiple administrators are creating input forms simultaneously, the first
administrator to click Save can save changes without warning. All subsequent
administrators are instructed to refresh the data before they can save.
Web Forms If multiple administrators create web forms, all administrators can make and save
changes without warning.

Security 289
Table 54: Common multi-administrative situations (continued)
Module/Action Situation
Web Forms If multiple administrators try to add a web resource to the same web form, the first
administrator to click Save can save changes without warning. All subsequent
administrators are instructed to refresh the data before they can save.
Scheduler If multiple administrators try to edit the same scheduled process in Scheduler, the
first administrator to click Save can save changes without warning. All subsequent
administrators are instructed to refresh the data before they can save.

Role segregation example

®
You might find it helpful to view an example of role segregation in IBM Incentive Compensation
Management.
Consider the following example.
Your company has a compensation plan builder, John, who is responsible for building all of your
company's compensation plans. Because all building is done in the development environment, he must
have access to the development environment. He must be able to see compensation plan results in the
quality assurance (QA) and production environments. Therefore, his user role must be different in those
environments.
Your company also has a Portal Access manager, Sally, who is responsible for setting up and maintaining
the Portal Access hierarchy. She does not require access to the development and QA environments. In
the production environment, she must be able to assign Portal Access trees and add Task Manager rules,
but she does not need access to any other model component.
Table showing examples of the level of access that is required for different roles across several environments

Table 55: Role segregation example

Development
Role Environment QA Environment Production Environment
John - Plan Builder Build plans View plans View plans
Add and edit tables
Import Data

Sally - Portal Access No access No access Assign Portal Access

Manager trees
Add Task Manager rules

Environment roles creation

®
To create different roles for each environment in IBM Incentive Compensation Management, the primary
administrator must log in to each environment separately and define appropriate user role access.
First, the primary model administrator must log in to the model to create user roles for the plan builder
and the Portal Access manager.
Within the development environment, the primary model administrator creates a user role that grants the
plan builder access to all compensation plans, the Composer module, selected tables within Composer,
and import capabilities. The plan builder role does not have access to Scheduler, Task Manager, or any
other area that is not required for building plans.
Within the development environment, the Portal Access manager role does not have access to any model
components.

290 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 While the primary administrator is logged in to the QA and production environments, he or she creates
slightly different access rights for the plan builder and Portal Access manager roles. In these
environments, the plan builder role can view compensation plans, but cannot change them.
The Portal Access manager role can perform actions in the Portal Access and Task Manager modules
but cannot perform any other actions in the model.

User role assignment

®
After roles are created in IBM Incentive Compensation Management, they must be assigned to specific
users.
After roles are assigned and users log in to their model, they can view and perform only the actions that
are allowed in their user roles. Sally is assigned to the role of Portal Access manager. If Sally logs in to the
production environment of the model, she has access to the Portal Access and Task Manager modules
only, and she can perform any action.
When John logs in to the development environment, he can build and change compensation plans. If he
logs in to the QA environment, he receives a warning message if he tries to make any plan changes.

Changing users' passwords

®
You can change passwords for users in IBM Incentive Compensation Management.

About this task

If an administrator with appropriate access rights wants to change the password of another administrator,
the first administrator can do so from the Manager Users page. Blanks passwords cannot be used.

Procedure
1. Click the model name in the header of the application.
2. Click Model Options.
3. Place your cursor over the user whose password you want to change and click the Edit icon.
4. Type and confirm a new password.
5. Click Finish.

Setting web user login security options

®
You can set security for the IBM Incentive Compensation Management web client. If you do not set
options in this window, users have unlimited login attempts, users cannot reset forgotten passwords, and
users are not required to create strong passwords.

Procedure
1. Click Admin > More Options.
2. On the Web tab, you can select the following options:
Option Description
Enable Web Clear this check box to temporarily disable the web client while the model is being
updated and prevent web users from logging in.

Enable self- Select this check box to let users reset a forgotten password through a link on the
service web client.
password reset
Web server email settings must be configured before you can use this feature.
After you select this feature, you must specify the length of time (in seconds) that
web users must reset their password before it expires.

Lockout user Select the check box to indicate how many attempts web users have to log in to
after the web client before their accounts are disabled. After an account is disabled, an

Security 291
 Option Description

administrator with permission to edit users must enable the account again.
Additionally, web users can unlock their accounts by using the password reset
feature.

Password To force web users to change their passwords after a particular number of days,
expires after select this check box and type the number of days after which you want the
password to expire.
Keep password Select this check box to indicate how many times users must create a different
history for password before they can reuse a previous password.
3. Click Save.

Setting email address for Request Assistance link on the web client
®
You can configure the email address that is used when a user clicks the following links in the IBM
Incentive Compensation Management web client: Request Assistance, Forgot your user name and
password, and Don't have an account.

Procedure
1. Click Admin > More Options.
2. Click the Web tab.
3. In the Help Email field, type the email address of the user whom you want to notify when a web user
requests assistance on the web client.
4. Click Save.

Setting the base URL for the web client

®
In IBM Incentive Compensation Management, to ensure that the Report Name With Link variable in
Workflow Manager functions correctly in a message by an Alert node to the web client, the base URL for
the web client must be configured.

Procedure
1. Click Admin > More Options.
2. Click the Web tab.
3. In the Base URL field, type the URL of your WAR file.
For example, type the following address: http://localhost:8080/ICM, where ICM is the name of
your WAR file.
4. Click Save.

Forcing web users to change passwords on first login

®
You can enable an option that forces users to change their passwords the first time they log in to the IBM
Incentive Compensation Management web client.

About this task

The forced password reset applies to new web users who are logging in for the first time and re-enabled
web users who are logging in for the first time after they were re-enabled through Portal Access.
Important: This option is available only for users who are enabled for web through Portal Access and
who do not use LDAP authentication.

Procedure
1. Click Admin > More Options.

292 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 2. Click the Web tab.
3. Select the User must change the password the first time he or she logs in check box.

What to do next
Web users must enter a password into the New Password field the first time they log in. However, web
users are permitted to reuse passwords, which means that the new password can be the same as the old
password.

Publishing a users and permissions report

®
You can export a list of users, their roles, and their access permissions in IBM Incentive Compensation
Management.

Procedure
1. Click Admin > Users and Permissions > Change Roles.
2. Click Export.
3. Choose a destination file, type a file name, and click Save.

Security 293
294 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 31. Tools
®
In IBM Incentive Compensation Management, tools allow you to perform actions options such as model
optimization, editing calendars, adding payee groups, adding star schemas, and migrations.

Optimizing a model
®
For increased performance, you can manually optimize the IBM Incentive Compensation Management
model at the database level.

About this task

Before you run a calculation, you can use the Optimize Model feature to ensure favorable calculation time
after data is updated. You can also schedule model optimization as part of a process in Scheduler.
The database calculates statistics to improve query performance, so that data can be accessed more
efficiently. Optimize your model after many changes are made, a period is locked, or a large data import is
done.
Important: More frequent use does not necessarily provide a noticeable improvement in calculation time.

Procedure
1. Click Admin > Tools > Optimize Model.
2. Click Yes, optimize this model.

Results
The Activity page opens and displays the progress of the optimization process. After the process is
complete, a message that indicates that the model was successfully optimized is displayed.

Calendars
®
In IBM Incentive Compensation Management, you can create multiple calendars to address the needs of
different lines of business.
A calendar is created automatically when the model is created or manually by a model administrator.
For example, consider a company that has a sales and a consulting line of business. The sales line of
business might define the end of a period as the last day in a month, but the consulting line of business
might plan around full weeks, ending their period after the completion of the last full week in any month.
Incentive Compensation Management can manage the different ways each line of business aggregates
data through calendars. Each compensation plan uses a single calendar that tells the compensation plan
how to aggregate data in time-based calculations. A set of compensation plans for consulting aggregates
correctly based on one calendar, and a different set of compensation plans for sales can simultaneously
calculate correctly based on a different calendar.
The selected calendar combines date ranges into periods. Date ranges can be created manually for
precision, or automatically with the integrated Add Year button in any existing calendar.

© Copyright IBM Corp. 2005, 2018 295

Adding calendars
®
You can add different calendars to your IBM Incentive Compensation Management model. You can also
add custom calendars.

Procedure
1. Click Admin > Calendars.
2. Click the Add icon.
3. Type a name for the calendar.
4. Select the start date.
5. Select the template format.
6. Click Add.

Editing calendars
®
After a calendar is created in IBM Incentive Compensation Management, you can edit it.

Procedure
1. Click Admin > Calendars.
2. Place your cursor over a calendar and click the Edit icon.
3. To add a year in the calendar, complete the following steps:
a) Select either After Current Year or Before Current Year.
b) Select the template format.
c) Click Add.
4. To edit a period in the calendar, place your cursor over the period and click the Edit icon.
5. To add a period to the calendar, complete the following steps:
a) Click the Add Period tab.
b) Type a name for the period.
c) Select the end date for the period.
d) Click Add.
6. Click Next.
After multiple ranges are defined, they can then be grouped for calculation and reporting purposes.
Ranges must be continuous.
7. To edit the time hierarchy, complete the following steps:
a) In the Add time rollup field, type a name for a new time roll up.
b) Select the Create a new top level check box to add a new top level to the new time roll up and type
a name for the level.
c) Click Add.
d) To edit the existing hierarchy, place your cursor over a time rollup and click the Edit icon.
8. Click Save.

Multiple calendars
®
You can use multiple calendars in one IBM Incentive Compensation Management model, but use only
one calendar (or as few as possible) for payout purposes.
Within a compensation plan, certain calculations might reference different calendars, but the calculation
that the payment is based on (final calculation in the plan) must be the same for each compensation plan.
This approach simplifies the process of period locking by eliminating the need to lock multiple calendars.

296 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Period locking
®
IBM Incentive Compensation Management can calculate highly accurate compensation results based on
varied information, and then it can lock the calendar.
Before payees and their managers can approve their compensation calculations, you can use Incentive
Compensation Management to lock periods to prevent accepted results from changing. As a result,
Incentive Compensation Management is not apparent to the administrator and the user. Period locking
ensures that the amount on each check that is written for each payee corresponds exactly to the values
that are shown for that payee and period in the application.
With period locking, the following actions can occur:
• Administrators can freeze the calculation and record list for closed, commissioned periods.
• The system can protect the results for closed periods and enforce restrictions that ensure that the
results are fully auditable and do not change.

Period accuracy
®
Without period locking, you must ensure that the new results in IBM Incentive Compensation
Management agree with the original payment amounts for that period.
To ensure accuracy, all of the following requirements must be met:
• All errors in the data must be corrected prior to the close of a period. All relevant metadata must be up-
to-date before the close of each period.
• Records that are associated with a period are never added after that period is closed.
• Payee titles, quotas, and other non-period-specific data must not change.
If these circumstances are not met when a recalculation is run, the system determines new results based
on any new or altered data. The new results do not agree with the original payment amounts for that
period.

How period locking works

®
When a period is locked for a particular calendar in IBM Incentive Compensation Management, it
prevents any values from changing through the lock date.
All associated compensation plans and data tables are locked simultaneously, preventing any calculation
results (or source data) from changing. This approach ensures the integrity of prior period results.
When periods are locked, all data tables that are associated with that calendar are locked by the date field
(but other table types are not locked). If more than one date field in the table is selected as a primary key,
you must select a Lock by Date when the table is created, to specify the field to look at during the locking
process.
Before a period is locked, when you calculate all items, Incentive Compensation Management calculates
results for all calculations and all periods. After a period is locked, Incentive Compensation Management
enforces rules that prevent administrative actions that would invalidate locked calculation results. For
example, any new calculations that are created after a period is locked can contain only unlocked periods
in the results set. If you want to lock multiple calendars consecutively, you can do so without running
another full model calculation as long as no further changes are made in the model.
Locked calculations can, however, be edited. Formulas for locked calculations can be changed, as long as
the calculation does not use accumulating partitioning. If the Accumulating Partitions feature is
selected, you cannot edit the calculation. Locked calculation results do not change; however, results for
any unlocked periods change to reflect any edits that were made to the calculation.
Although it is possible to unlock locked periods, avoid this action. The purpose of period locking is to
prevent accepted results from changing and to ensure that payments always match calculated results. If
you unlock a period, even to make a minor change, you might inadvertently change accepted payment
results beyond the change that you intended to make.

Tools 297
Locking a period
®
You can lock a period to prevent the results from being edited in IBM Incentive Compensation
Management.

Before you begin

Perform a calculation before you lock a period to ensure that all calculated results are up-to-date as of
the calendar locking.
A calendar lock is considered a change in the model. If you have more than one calendar and another
calendar was locked after the last calculation, another calculation is required before you can lock the
current calendar.
When you create a data table with more than one date field, you are prompted to select a locked-by date.
This is the date that is used when you lock periods.

Procedure
1. Click Admin > Calendars.
2. Place your cursor over the calendar that you want to lock and click the Lock icon.
The Time Locking Wizard shows all data tables that are affected by locking the selected calendar.
3. Click Next.
4. Select the period that you are locking through.
Tip: You cannot have open periods that exist before a locked period. For example, if you lock period 1
of 2016, all of 2015 is automatically locked as well.
5. In the Summary pane, verify the action.
6. Select one of the following options:
Option Description
Calculate and Lock Select this option to run a full model calculation before the calendar lock.
Lock Only Select this option if you have already run a full model calculation and want to
only lock the calendar. If any changes were made since the last calculation, this
option is not available.
7. Click Finish.
The Activity page shows the progress of the calendar locking process. After the process is complete, a
message that the calendar is locked is displayed in the Activity page.

Results
If you go back to Composer and open a data table, you can see that none of the rows with a date in a
locked month can be edited. However, you can still edit rows with dates in an unlocked period.

Unlocking a period
®
When you unlock periods in IBM Incentive Compensation Management, the results for these periods
become editable, and potential inconsistencies between payments and results become possible.

About this task

Although it is possible to unlock locked periods, avoid this action. The purpose of period locking is to
prevent accepted results from changing and to ensure that payments always match calculated results. If
you unlock a period, even to make a minor change, you might inadvertently change accepted payment
results beyond the change that you intended to make.
Unlocking a period is an irreversible operation. All adjustments for that period are deleted.

298 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Procedure
1. Click Admin > Calendars.
2. Place your cursor over the calendar that you want to lock and click the Lock icon.
3. Click Next.
4. Select a period before the current locked period, or select Unlock all periods.
5. Verify the action.
6. Click Finish.

Results
The Activity page shows the progress of the calendar unlocking process. After the process is complete, a
message that the calendar is unlocked is displayed in the Activity page.

Adding periods to a locked calendar

®
You should add periods to a calendar before you lock the final period in your IBM Incentive
Compensation Management model. However, you can add new periods to a locked calendar if necessary.

About this task

You can add periods to calendars after the periods are locked only if they contain at least three
hierarchies. You cannot add hierarchies to a locked calendar.

Procedure
1. Click Admin > Calendars.
2. Place your cursor over the locked calendar and click the Edit icon.
3. On the Add Year tab, add a year to the locked calendar.
Important: You can only add n-2 levels, where n is the number of hierarchies that you have. For
example, if you have four hierarchies (such as, Total, Years, Quarters, and Months), you can add only
two levels (Years and Quarters).
4. Click the Add Period tab, and complete the following steps:
a) Type a name for the period (such as 2011, Month 01).
b) Select a start and end date for the period.
c) Click Add.

Results
The new period moves to the newest level that you created.

Period locking and system functions

®
In IBM Incentive Compensation Management, system functions can affect period locking, and can be
affected by period locking.
The following table lists system functions and how they affect and are affected by period locking.

Table 56: System functions and period locking

System functions
Create a calculation
Change a calculation
Calculate
Effect of period locking
Partition can reference only unlocked periods.
Changes are not possible if the calculation includes locked periods. Copied
calculations begin in the first unlocked period.
If a calculation is performed on a compensation plan that includes locked
periods, the locked periods within the plan are not recalculated.

Tools 299
Table 56: System functions and period locking (continued)
System functions Effect of period locking
Add a member to a payee group New members can be added to a payee group at any time.
Modify a calender Cannot edit time periods that were locked.
Add a record to a table in Prohibited from adding a record that contains a date in a locked period.
Composer
Create a table Period locking does not affect the creation of a new table.
Import data Records containing dates in a locked period are not imported.
Edit Portal Access permissions Locked periods do not affect edit Portal Access permissions.
Change the Portal Access tree Editing Portal Access trees is still possible with locked periods.
Enable and disable a table for Tables can be enabled and disabled for web edit when periods are locked.
web edit
Edit web edit permissions Editing web edit permissions is still possible when periods are locked.

Because period locking freezes calculated results for prior periods, running a calculation to update results
normally does not calculate data in locked periods. If you mark a large amount of the total system data as
inactive, the number of active records included in a recalculation is reduced and, as a result, calculation
time speeds up. You might notice that as the number of locked periods in your model increases, your
calculation time decreases.

Period locking and calendar changes

®
Each calendar in IBM Incentive Compensation Management is locked independently so that different
companies or divisions can freeze their results at different times.
When you make calendar changes, you can move unlocked periods if the move does not cause a period to
go from locked to unlocked or vice versa. After a period is locked, it cannot be moved.
Additionally, any new periods that are added to the calendar must be unlocked, and a locked period can
never exist after an unlocked period.

Payee groups
®
In IBM Incentive Compensation Management, create payee groups to facilitate payee maintenance
through Task Manager and define payees in Scenarios workspaces.
Payees are frequently grouped by title. For example, if all salespeople receive five percent commission on
everything that they sell, every salesperson can be added simultaneously to a single payee group in the
system. It is helpful to consider which payees might be grouped together before you begin the model
creation process.

Adding payee groups

®
In IBM Incentive Compensation Management create payee groups to facilitate payee maintenance
through Task Manager and define payees involved in Scenarios workspaces.

About this task

A payee group can contain one or more payee members.

Procedure
1. Click Admin > Tools > Payee Groups.

300 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 2. Click Add new group at the bottom of the payee groups list.
3. Click the Edit icon and type a name for the payee group.
4. Add any tables to the Payee table to use as the source.
5. On the Restrictions tab, create restrictions to define exactly which members of the source participate
in the group.
For example, to create a payee group that contains only Account Executives, you can define a
restriction stating that only payees whose title ID = Account Executive can be included.
6. On the Members tab, select the payee group members.
Any members you have already selected through the restrictions window will automatically be shown
in the selected payees pane.
7. Select the start date and end date for the payee group.
8. Click Save.

Deleting a payee from a payee group

®
You can remove payees from a payee group in IBM Incentive Compensation Management.

About this task

This procedure removes the payee from the payee group, not from the system.

Procedure
1. Click Admin > Tools > Payee Groups.
2. Select a payee group.
3. Place your cursor over the payee and click the Delete icon.
Tip: Press Ctrl and click to select multiple payees to delete and click the Delete icon in the toolbar.

Editing effective dates for individual payee group members

®
In IBM Incentive Compensation Management, you can specific different effective dates for each member
in a payee group.

Procedure
1. Click Admin > Tools > Payee Groups.
2. Select the payee group.
3. Set the effective start and end date for the payee in the group.

Star schemas
®
In IBM Incentive Compensation Management, you can use star schemas to create OLAP cubes for
performance analysis.
Star schemas facilitate the export of information to an external analytical software solution. You can
create empty fact and dimension tables in Composer, and you can schedule imports in Scheduler. You
can view star schemas and their tables, and you can add or remove a star schema.
The star schema consists of a fact table that references any number of dimension tables. The fact table
holds the main data (for example, calculation results), and the dimension tables are joined to describe
each value of a dimension. The results of calculations can be analyzed along multiple dimensions. Each
dimension table has a single primary key. Fact tables have a compound primary key that consists of the
aggregate of relevant dimension keys.

Tools 301
Adding a star schema
®
You can add a star schema based on a fact table that references dimension tables in IBM Incentive
Compensation Management.

About this task

Star schemas are created with data stores as of version 8.0.4. If you are upgrading a model that contains
star schemas that were built with calculations, the star schemas will be deleted. You must re-create the
star schemas with data stores instead.

Procedure
1. Click Admin > Tools > Star Schema.
2. Click Add New Schema.
3. In the Star Schema name field, type a name for the star schema.
4. From the Data store drop-down list, select a data store.
5. Click Add.

302 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Chapter 32. Admin client management
®
In IBM Incentive Compensation Management, from the Admin menu, you can manage documents,
download files, send notifications to web users, and add external tools.

Managing documents
On the Manage Documents page, you can add any files that are associated with components, Presenter
®
reports, or are required for review on the IBM Incentive Compensation Management web client.

About this task

Any documents that are added on the Manage Documents page can be enabled for web client review
from Portal Access.

Procedure
1. Click Admin > Manage > Manage Documents.
2. Click Add a Document.
3. Select the file.

Results
The file is automatically encoded and saved in Incentive Compensation Management, and is available for
download at any time.

Downloads
®
Any saved import or saved publications can be saved from the Downloads page in IBM Incentive
Compensation Management.

Downloading saved imports

®
You can download any saved data imports from IBM Incentive Compensation Management.

Procedure
1. In the admin client toolbar, click your user name and select Downloads from the menu.
2. On the Imports tab, place your cursor over the saved import that you want to download.
3. Click the Download icon.
4. Save the file.

Downloading saved publications

®
You can download any saved publications from IBM Incentive Compensation Management.

Procedure
1. In the admin client toolbar, click your user name and select Downloads from the menu.
2. On the Publisher tab, place your cursor over the saved publication that you want to download.
3. Click the Download icon.
4. Save the file.

© Copyright IBM Corp. 2005, 2018 303

Deleting downloads
®
You can delete one or all available downloads in IBM Incentive Compensation Management.

Procedure
1. In the admin client toolbar, click your user name and select Downloads from the menu.
2. To delete a specific download, complete the following steps:
a) On the Publisher or Imports tab, place your cursor over the download that you want to delete.
b) Click the Delete icon.
3. To delete all the downloads, on the Publisher or Imports tab, click Delete All.

Web messages
®
Use web messages in IBM Incentive Compensation Management to create, edit, or delete messages for
the web client. Administrators can also notify all web users about messages.

Adding web messages

®
You can compose a message that you can then send to all IBM Incentive Compensation Management
web client users.

Procedure
1. Click Admin > Web Messages.
2. Click Add new web message.
3. Type a subject for the message.
4. Type a message.
5. Click OK.

Editing web messages

®
In IBM Incentive Compensation Management, you can make changes to web messages.

Procedure
1. Click Admin > Web Messages.
2. Place your cursor over the message that you want to edit, click the ellipsis and select Edit.
3. Make your changes.

Deleting web messages

®
You can remove a web message in the IBM Incentive Compensation Management client.

Procedure
1. Click Admin > Web Messages.
2. Place your cursor over the message that you want to delete, click the ellipsis and select Delete.

Sending notifications to all web users

®
You can send a message to all IBM Incentive Compensation Management web client users.

Procedure
1. Click Admin > Web Messages.
2. Place your cursor over the message that you want to send as a notification to all web users, click the
ellipsis and select Notify.

304 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 3. Click Yes to the confirmation question.

External tools
®
You can add tools that exist outside of IBM Incentive Compensation Management. An external tool is any
program that can be run from the command line.
External tools can then be run through Scheduler. For example, if you have a scheduled import or
calculation, you can schedule an external tool, such as Notepad, to run immediately after the import or
calculation finishes.

Adding external tools

®
Any external tools that you want to run through Scheduler must be added to IBM Incentive
Compensation Management.

Procedure
1. Click Admin > Manage > External Tools.
2. Click Add An External Tool.
3. Select the file.

External tools and Python scripts

You can upload Python 2.7 scripts and non-standard Python libraries through the External Tools page in
®
IBM Incentive Compensation Management. The scripts can then be run by the Scheduler module.

Uploading standard Python scripts using the admin web application

®
Standard Python scripts can be uploaded via the External Tools page in the IBM Incentive Compensation
Management admin web application.

Procedure
1. Click Admin > Manage > External Tools.
2. Click Add An External Tool.
3. Choose the Python script that you want to upload.

Results
The script is added to the /root/Scripts folder.

Uploading standard Python scripts using FTP

®
Standard Python scripts can be uploaded using FTP for use in the IBM Incentive Compensation
Management admin web application.

Procedure
1. Log in to your FTP client.
2. Navigate to the /root/Scripts folder.
3. Add the Python scripts to the folder.

Admin client management 305

Running Python scripts from Scheduler
®
You can run Python scripts that are uploaded to IBM Incentive Compensation Management from the
Scheduler module.

About this task

Python scripts must first be uploaded through the admin web application or uploaded using FTP to the /
root/Scripts folder.

Procedure
1. In Scheduler, select an existing process folder that you want to add the new task to, or create a new
process folder.
2. Click the Add icon.
3. From the Type drop-down list, select External Tool.
4. Set the time, day, and month that you want the script to run on.
5. From the Available external tools drop-down list, select the Python script.
6. In the Arguments field, specify the parameter.
For example, when an external tool runs, the working directory is /root. If you have
a script.py which takes in a file called config.json as an argument, and both files have been
uploaded to the Scripts folder, you must specify the full path as /root/Script/config.json in
the Arguments field.
7. Click Create.

What to do next
If you want to manually run the task after creation, select the External Tool task and, in the toolbar, click
Run. Only one external tool can be run at a time. View the Activities page and Scheduler log to see the
results of running the external tool.

Troubleshooting Python scripts run

®
If your Python script fails to run in IBM Incentive Compensation Management, you can open the
Scheduler log to view the details.

Procedure
Click Admin > Logs > Scheduler.
Full print statements and stack traces are displayed. If the script passes, no print statements are
displayed.
Tip: An external tool fails if it exits with a non-zero exit code or if an exception is thrown. As successful
external tools do not show print statements in the Scheduler log, you can produce a fake failure by
adding an exit(1) at the end of your script. This forces print statements to display in the Scheduler log so
that you can debug your script. After you have fixed you script so that it runs successfully, delete the
exit(1) statement.

Python script development

®
When developing Python scripts for use in IBM Incentive Compensation Management, there are a few
things that you should take into consideration.
For example, if your script needs to connect to a server, such as an SMTP server or an FTP server, or call
the ICM REST API, add a wait time of at least 10 seconds to the beginning of your script. When the

306 IBM Incentive Compensation Management Version 10.0.0 : User Guide

external tool runs, it needs some time to connect to the network. You can use the following command in
your script:

import time
time.sleep(10)

Packaging your Python program

®
The IBM Incentive Compensation Management external tool only run scripts located at the top level of
the Script folder. If you plan to have multiple Python scripts involving multiple files, then you must
organize them in the Script folder.

About this task

When your Python program has a complex structure with multiple modules, you can zip your script and
upload it to Incentive Compensation Management. Python allows running a ZIP file if it contains an entry
point __main__.py at the top level of the ZIP file. The following steps use the example of a program
packaged as myproject.zip and with the following structure:

myproject
- __main__.py
- requirements.txt
- modules
- foo.py

where, __main__.py is the entry point of your script.

Procedure
1. Zip the contents of myproject without including the folder myproject.
Note: Inside the ZIP file, a __main__.py must exist at the top level.
2. As __main__.py is the entry point of myproject.zip, run the script locally using the following
command:
python myproject.zip
3. Upload the ZIP file to the Script folder.

Using non-standard Python scripts

®
Although IBM Incentive Compensation Management does not allow scripts using non-standard Python
libraries to be uploaded as an external tool, you can use a different method to run these types of scripts in
the application.

About this task

Python has a set of standard libraries that can be used. In some cases, you might need to use non-
standard libraries, which can be installed using pip.
If you use many non-standard libraries, or need to develop multiple scripts that use different non-
standard libraries, you can use virtualenv from the beginning of development to make packaging your
requirements easier.

Procedure
1. If your script requires non-standard libraries, package each library as a ZIP file.
Tip: Add the requirements to the ZIP file so that, if you have other scripts that use the same
requirements, you will only need to upload them once.
2. Upload each ZIP file to the /root/Scripts folder.
Tip: As multiple scripts might use the same library, package each of your non-standard
libraries separately. For example, if you have a requests library and a beautifulsoup4 library,

Admin client management 307

 create a requests.zip file and a beautifulsoup4.zip file. This also gives you more visibility into
what libraries you have already uploaded into the Scripts folder.

Packaging your non-standard Python libraries

®
Your non-standard Python libraries can be packaged for use in IBM Incentive Compensation
Management.

About this task

If you have been using virtualenv and have been keeping a requirements.txt file, each line of your
requirements.txt file is a non-standard library. If you did not use a requirements.txt file to keep
track of your requirements, type pip freeze at the command prompt to display the libraries that you
currently have installed.

Procedure
1. Install each library that your script requires into a new directory by typing the following text at the
command prompt:
pip install --install-option="--prefix=/path/to/dir" library
where, path/to/dir is the path to the directory where the library is installed and library is the
name of your library.
The package is installed in the following directory: /path/to/dir/lib/pythonx.x/site-
packages
2. Navigate to the site-packages folder and zip the contents into library.zip.
Note: This is to ensure that the library is at the top level of the library.zip file.
3. When Python needs to import a library, it searches for it in the Python path, sys.path. Because this
library is packaged into the library.zip file, you must change your script so that is also searches for
libraries in the library.zip file. Edit your Python script to include the library.zip file in
the sys.path. This must be done before you import the library into Incentive Compensation
Management.
• If you are running the script directly as python script.py, include this line:

import sys
sys.path.insert(0,
os.path.join(os.path.dirname(os.path.realpath(__file__)),
"library.zip"))

#all other imports go below this line

Note: library.zip is in the same directory as script.py

• If you are running the script as python myproject.zip, include this line:

import sys
sys.path.insert(0, os.path.join(os.path.dirname(os.path.dirname
(os.path.realpath(__file__))), "library.zip"))

#all other imports go below this line

Note: library.zip is in the same directory as myproject.zip, and __main__.py is inside

myproject.zip
4. Test your script to make sure that it works locally.
Tip: To test it properly, make sure that the libraries are not installed locally. Otherwise, when you run
the script, it could pick up the local library instead of the script in the library.zip folder. To find out
if you already have library installed in your current environment, run the pip freeze command.

308 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 This should not return library. If it does, uninstall it. Another way to test your script is to create a
new virtual environment and activate it. Your environment will be empty at this point.
5. After you have tested your script, upload library.py and your script to the /root/Scripts folder.
6. Test the script in Scheduler.

ICM storage location

®
When files are uploaded to IBM Incentive Compensation Management, they can be saved in several
different locations.
For example, if you have a Python script that modifies an import file that has been uploaded using the
Import wizard, then you will need to know the directory in which the import file was saved so you can add
the file path to your script.
You can access files that were uploaded to Incentive Compensation Management through the following
locations:
• /root/Data - contains uploaded import files
• /root/Script - contains uploaded files through external tool
• /root/Image - contains uploaded image used in Presenter publish
• /root/Document - contains uploaded documents

Admin client management 309

310 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 33. Migration
®
If there are no conflicts, you can migrate IBM Incentive Compensation Management model objects, along
with dependent objects, between models of the same version number.
The following list contains the objects that you can select during migration:
• Composer
• Individual components
• Process lists
• Saved imports
• Portal Access trees
• Roles
• Users
• Workflow Manager workflows
• Web tabs
• Web form filters
• Calendars
Migration between models is done by pulling the data from the source model to your current working
model (target model).
The migration process migrates only the selected items, so you must use remapping to resolve
dependencies. During migration, you can remap items that are used outside of a component to matching
local items. If there is no matching local item, migration cannot proceed. You can choose to migrate all
dependencies instead.
Tip: Individual tables, reports, and calculations cannot be selected during migration. To migrate an
individual model object, wrap the item into a component and migrate the component.

General practice and rules for migration

®
In general, migration conflicts are determined and managed based on the name of an object in IBM
Incentive Compensation Management. If an object in the source model has the same name as an object in
the target model, the object exists in both models, regardless of the object's composition.
Here's a quick demonstration illustrating the rules for performing a migration:

https://youtu.be/A2fwp7fsQEw
The following list describes general practices and rules for migration:
• If an object from the source model does not exist in the target model, it is created in the target model
during migration.
• If an object with the same name exists in both models, and there are no conflicts, it can be migrated.
• If the target model has an item with the same name as an item in the source model and you choose to
replace conflicts, the target model item is overwritten by the source model item during migration.
• If an item exists in the target model, but does not exist in the source model, it is deleted during
migration. For example, if you are migrating a component that exists in both the target model and
source model, any objects inside the target model component that do not exist in the source model
component are deleted.

© Copyright IBM Corp. 2005, 2018 311

Rules for migrating Composer
®
In IBM Incentive Compensation Management, if you choose to migrate all of Composer, then Composer
in the target model will match Composer in the source model exactly after migration is complete.
Objects that were not present in the target model are added, and any objects that exist in the target
model but not in the source model are deleted. If you want objects in the target model that are not in the
source model to remain after migration, migrate specific components only and not the entire Composer
module.
• If the source and target model contain the same table in two different components, it produces a
conflict.
Important: If a table is global in both source and target models but exists in different components,
there is no conflict during migration. The global table stays in the same component in the target model
after migration completes.
• When you migrate all of Composer, calculations, web forms, and Presenter reports that exist in both
models remain in the same components as the source model after migration and overwrite any objects
with the same name in the target model.
• The migration process adds columns to tables if needed, but it does not add key columns or remove
columns. If key columns must be added to a table, the migration process produces a conflict.

Rules for migrating components

®
When you migrate components in IBM Incentive Compensation Management, you must follow certain
rules to ensure success.
The following list describes rules for migrating components:
• All sources for connections must exist somewhere in the target model. If the sources for the
connections in a component cannot be remapped to sources in the target model, there will be a conflict.
For example, if you try to migrate a component that contains only a report and the report source does
not exist in the target model, the migration cannot complete.
• When migrating specific components, any object that exists in the component in the source model but
exists in a different component in the target model is listed as conflicted. You can avoid this issue by
migrating a mutual parent component of both components, such as Composer.
• When you migrate a component that exists in both the source and target model, everything inside the
component in the target model is replaced with everything inside the component from the source
model. This process includes deleting objects in the target model component that do not exist in the
source model component.

Rules for migrating tables with pick lists

®
When you migrate tables with pick lists in IBM Incentive Compensation Management, you must follow
certain rules to ensure success.
The following list describes rules for migrating tables with pick lists:
• If a table with a pick list is migrated along with the structural table that it pick lists to, or the structural
table exists in the target model, migration completes successfully.
• If a table with a pick list is migrated without the structural table that it picks from, it can be migrated if
there is a corresponding structural table in the target model with the same column structure, even if the
table name is different. The migration process remaps the pick list to the new structural table as long as
it has the same global setting as the table in the source model and the same column structure.
• If a table with a pick list is migrated without its structural table and an appropriate structural table does
not exist in the target model, the structural table appears as a conflict.

312 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Rules for migrating global tables
®
When you migrate global tables in IBM Incentive Compensation Management, you must follow certain
rules to ensure success.
The following list describes rules for migrating global tables:
• If a table is local in the source model but global in the target model, it appears as conflicted during
migration.
• If a table is global in the source model but local in the target model, it is made global in the target
model. However, if the table is used by connections on the same level in the target model, it appears as
conflicted.
• If a component has a connection with the same name as a global table in the target model, the
connection appears as conflicted during migration.
• If a component exists in both the source and target model but the component in the target model
contains a global table, the global table is deleted unless objects outside the component use the table
as a source.
• If a global table exists in different components in the source and target model, the global table remains
in the same component as the target model after migration.

Rules for migrating web forms and Presenter reports

®
When you migrate web forms and Presenter reports in IBM Incentive Compensation Management, you
must follow certain rules to ensure success.
The following list describes rules for migrating web forms and Presenter reports:
• If a component is migrated that contains a Presenter report or web form that links to another report or
web form, the linked report or web form must exist in the target model or be part of the migration.
• If you migrate a component that will delete a Presenter report or web form in the target model
component that is linked to another report or web form, the report that would be deleted appears as
invalid.
• If you migrate a web form that passes a filter value to a Presenter report parameter that does not exist
in the target model's Presenter report, the report appears as invalid.

Rules for migrating web form filters

®
When you migrate web form filters in IBM Incentive Compensation Management, you must follow certain
rules to ensure success.
The following list describes rules for migrating web form filters:
• Web form filters do not overwrite web form filters with the same name in the target model.
• If the table that the web form filter uses does not exist anywhere in the target model or is not included
in the migration, the table that the web form filter uses is listed as conflicted.

Rules for migrating Portal Access items

®
When you migrate web tabs and Portal Access trees in IBM Incentive Compensation Management, you
must follow certain rules to ensure success.
The following list describes rules for migrating web tabs:
• Items that are used by web tabs are not deleted when you choose to replace conflicts (delta migration).
• Migrating web tabs from the source model always creates new tabs in the target model. Since web tabs
can have the same name, there is no conflict when a web tab with the same name as an existing web
tab is migrated into a model.
• Migrating web tabs does not automatically include items that are used by them. In this case, you can
choose to migrate dependent items.
• Web tabs can have the same name.

Migration 313
 Important: If you want to overwrite existing web tabs in the target model with web tabs with the same
name in the source model, you must delete the web tabs that you want to overwrite in the target model
before migration.
• Portal Access trees from the source model will overwrite Portal Access trees and with the same name
along with their associated Portal Access groups in the target model.

Rules for migrating process lists

®
When you migrate process lists in IBM Incentive Compensation Management, you must follow certain
rules to ensure success.
The following list describes rules for migrating process lists:
Delta migration of process lists (Replace Conflicts)
When you migrate a process list, if a process list of the same name exists in the target model and you
choose to replace conflicts, the process list in the destination model is overwritten. If two or more
process lists in the destination model have the same name as the process list that you are trying to
migrate (while replacing conflicts), no process list in the destination model is overwritten and an
invalid status is displayed. If you choose not to replace conflicts, a new process list is created and no
overwriting occurs.
Migrating process list links
When process list tasks are linked to other objects such as components, input forms, Presenter
reports, web forms, and tables, links are maintained during migration when possible. If the object that
the task links to is being created by the migration or exists in the destination model, the links are
maintained as expected. If the linked object does not exist in the destination model, it is then up to
you to remap the invalid links. When process lists link to objects, the following rules govern the
possible migration outcomes:
• If the object exists in the target model (same name, type) and that linked object is being migrated,
the link is maintained.
• If an object (that is linked to by a process list task) does not exist in the target model but will be
created by migration, the task link is maintained. In the remapping window, the task link appears
next to the object that it is linked to.
• If an object (that is linked to by a process list task) exists in the target model but will be deleted by
migration, or does not exist in the target model and will not be created by migration, the process
list's status appears as Needs Review. If you double-click the process list, the remapping window
opens. In the remapping window, any links to objects that exist in the source model that do not exist
in the target model appear in red. You can remap these links or finish the migration with invalid
links.
Important: Process list task links work based on name and object type only. When you migrate a
process list that has task links, the migration process tries to maintain those links by associating the
links with objects in the target model of the same name and type, regardless of component or
structure.
Remapping links during migration
During migration, you can remap a process list's task links from the process list page. When you
double-click any process list, a remapping page opens, regardless of status.
• On the remapping page, you can see a list of all of the tasks in the process list. Next to each task,
you can see the destination model object that the task is linked to.
• You can see a list of local sources and actions. From the Choose Task Link menu, you can filter the
list of local sources by selecting the type of source that you want to view. From the Choose Link
Actions menu, you can select the type of action that you want to be performed when the link is
clicked. You can then drag any object from the local sources list to associate that object with a
process list task.
• When migration completes, each process list task is linked to the object that it is mapped to on this
window, regardless of what the task was linked to in the source model.

314 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Removing links during migration
To remove a link during migration without having to remap it to a different task, click and hold the
invalid linked object (the one in red), and drag it to the pane. When the box that contains the name of
the linked object becomes empty, the link is cleared.
Remapping link actions during migration
During migration, you can remap the action that is selected for a process list's task link from the
process list page.

Rules for migrating Workflow Manager workflows

®
When you migrate Workflow Manager workflows in IBM Incentive Compensation Management, you
must follow certain rules to ensure success.
The following list describes rules for migrating Workflow Manager workflows:
• The target model must contain a Payee and Title table that has the same columns and global table
status as the Payee and Title in the source model.
• The Presenter reports that are associated with the workflows must be migrated along with the
workflows, or they must exist in the target model.
• Any Scheduler processes that are associated with process nodes in workflows can be remapped to
Scheduler processes that exist in the target model. If you double-click any process node, the
Remapping wizard opens, regardless of its status.
– On the remapping page, you can see a list of all the Scheduler folders.
– You can select the Scheduler folder that you want to associate with the process node.

Objects that cannot be migrated

®
Some objects in IBM Incentive Compensation Management cannot be migrated. These items must be
created manually in the target environment by following the same steps that were used to create them in
the source environment.
Portal Access tree assignments
Portal Access groups and trees can be migrated, but the assignment of the trees for web access
security, inquiries, or approvals must be done manually in Portal Access.
Portal Access group members
Because migration brings over structures and not data, Portal Access groups are not populated with
any members after a migration. However, if they were created with the Maintain this group in task
manager option selected, you can generate tasks in Task Manager and then run each task to add the
appropriate payees to their respective groups.
Web-enabled groups
After you use Task Manager to populate Portal Access groups with members, you might or might not
need to web-enable certain groups, depending on whether they were used to populate Portal Access
trees that define your web security.
Import connection strings
After imports are migrated, the connection strings for each import must be modified to reflect the
data sources of the new environment.
Import schedules
After imports are migrated and connection strings are modified, any scheduled imports must be
rescheduled in the Scheduler module.
Saved publications
Saved publications must be re-created and possibly rescheduled.
Admin options
Options that were selected in the Admin menu must be reconfigured manually in the target system.

Migration 315
Performing a migration
®
In IBM Incentive Compensation Management, you can select objects from a source model to move to a
destination model.

Before you begin

To perform a migration, you must have admin (all) access in the source model and Migrations > Edit and
Migrations > Execute permission in the destination model.

About this task

Here's a quick demonstration on how to perform a migration:

https://youtu.be/-PMTDGqNvaA

Procedure
1. Click Admin > Migration.
2. Select your source model.
3. Click Connect.
A list of available objects that can be migrated or pulled into your current model is displayed.
4. Select the objects to migrate.
5. You can click Select Dependencies to automatically select all items in the source model that an object
depends on. This step ensures that all dependent objects are migrated. If this option is not selected,
you must use remapping to resolve dependencies. During migration, you are prompted to remap items
that are used outside of a component to matching local items. If there is no matching, local item,
migration cannot proceed.
6. You can select the Replace Conflicts check box to overwrite objects with the same name in the target
model with those from the source model.
If this option is not selected, overwriting does not take place and migration cannot proceed if there are
conflicts. For example, if two calculations have the same name but their formulas are different, or if
they have different sources, the Replace Conflicts feature replace the calculations in the destination
model with the calculations in the source model.
7. Click Migrate.
8. The next series of windows display migration statuses for all components of the selected objects.

Table 57: Migration wizard screens

Migration Status Meaning
New The object does not exist in the destination model. The new object is migrated
from the source model to the destination model.
Exists The object exists in the destination model. There are no conflicts that prevent
migration.
Conflicted The object exists in the destination model and there are conflicts. Conflicts must
be resolved before the migration can take place. If a calculation is listed as
conflicted because the calculation in the target model is locked and has a different
start date than the calculation in the source model, you can choose to ignore the
conflict and proceed with the migration.
Overwriting The object exists in the destination model and is different from the source model.
The migration process replaces the object in the destination model with the
changed object in the source model. Overwriting occurs only if the Replace
conflicts option is selected.

316 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 57: Migration wizard screens (continued)
Migration Status Meaning
Deleting The object exists in the target model but not in the source model and is removed
during migration.
Needs Review This status is used for process lists only. The process list contains links to objects
that do not exist in the destination model. You can remap those links by double-
clicking the process list name or finish the migration with invalid links.

a) For an object to be eligible for migration, none of its objects can be labeled as Conflicted. If there is
a conflict, click the warning sign next to the item to view its cause and resolve it before migration
can continue.
b) For process list migration, if the status is labeled as Needs Review, click View next to the name of
the process list to remap links. On the remapping screen, links to objects that exist in the source
model but not in the target model appear in red. To remap, drag the item that you want to link to
from the Components column to the Imported Targets list.
• Components are objects that exist in the target model that process list tasks can link to.
• Imported Targets are objects from the source model that process list tasks will be linked to after
migration.
9. Click Finish to perform the migration.

Filtering and sorting columns in the Migration wizard

®
In IBM Incentive Compensation Management, you can filter and sort the columns in each step of the
migration.

About this task

You can sort the items in each window of the migration alphabetically in ascending or descending order.
You can filter the Status column to find all the New, Conflicted, or Overwriting items easily.

Procedure
1. Click Admin > Migration.
2. Select the source model.
3. Click Connect.
4. Select the objects to migrate.
5. Click Migrate.
6. Click the header of the Name column to sort the items alphabetically.
7. In the header of the Status column, click Filter and select the status by which you want to filter.

Migrating individual Composer objects

®
In IBM Incentive Compensation Management, you can move specific objects, such as Presenter reports,
calculations, and tables in Composer, from one model to another.

About this task

Here's a quick demonstration on migrating individual Composer objects:

https://youtu.be/xjWt7zFcsMY

Migration 317
 Procedure
1. In the source model, select the Presenter report, calculation, or table that you want to migrate to the
target model, and click the Wrap icon.
Important: Web forms cannot be wrapped without also wrapping their sources.
2. Name the component and click OK.
3. In the target model, click Admin > Migration.
4. Select the source model and click Connect.
5. Expand Composer.
6. Select the component that contains the object that you want to migrate.
7. Select the Replace Conflicts check box.
8. Click Migrate.

Migration methodology and approach

®
Plan migrations properly in IBM Incentive Compensation Management to reduce the risk of failed or
incomplete migrations. After migrations are complete, validate to ensure that the migration was
successful.
Do not assume that a migration is successful without testing and verifying.
You must follow several main steps for each phase of the migration:
1. Plan
• Determine migration requirements.
• Identify migration environments.
• Create a migration plan.
• Create migration procedures.
• Create a migration schedule.
• Create a Migration log.
• Develop a test plan.
2. Migrate
• Communicate the migration and deployment plan.
• Customize migration procedures.
• Run a pre-validation test.
• Back up both source and target models.
• Perform the migration.
3. Validate
• Verify the migration completion with the Migration log.
• Run a post-migration test.
• Communicate project information.
• Conduct a migration closeout meeting.
• Perform knowledge transfer.

Planning phase
®
Follow certain steps to plan a migration in IBM Incentive Compensation Management.
At a high level, the following steps describe how to plan a migration:
1. Determine migration requirements.

318 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 2. Identify migration environments.
3. Create migration plan.
4. Create migration procedures.
5. Create a migration schedule.
6. Create Migration log.
7. Develop test plan.
The amount of planning depends on the size and scope of the migration. The planning process generally
involves determining the requirements of the migration, identifying the source and target environment,
and documenting the migration plan. During the planning stage, a determination of the migration
requirements includes identifying the environments that are involved in the migration. If there are more
than two environments, there must be a determination of which environments act as sources to the other
environments and in which order the migration must occur. The user who has the correct role and
privileges to run the migration between the environments also must be identified.
The migration procedure details the steps to take to accomplish the migration. This procedure involves
taking screen captures of the Migration wizard and listing which items to select and in which order. The
migration procedure must also include any manual steps that are needed to complete the migration.
Some items cannot be migrated by using the migration tool. List out these items to make sure that they
are accounted for in your deployment plan, with specific manual steps to replicate them in the source
system.
Migration planning can also help define which items to migrate first, whether it is necessary to take
applications offline, and which internal and external audiences must be informed regarding the migration.
Proper migration planning involves more than just the information technology (IT) staff. The business
owners of the applications must also be included, particularly because the IT organization determines
how important a particular application or set of data is to the business.
In planning a migration, it is important to understand migration requirements such as source and target
environments, time schedule, users who are involved, and the configuration of the software. In looking at
the time schedule, the IT organization must create estimates for planning, setup time, migration time, and
production cutover. Planning typically accounts for 25 percent of the total schedule.

Table 58: Example of migration plan

Action item Assigned to Status Date
Establish a migration management team.
Gather availability and production schedules.
Document change control procedures so that they can be
incorporated into the migration procedures and plans.
Document the timeline for activities for both hardware
changes and data migration.
Announce the migration at least 30 days before the
intended target migration date.
Create a technical migration team.
Inform the security and compliance groups about the
migration.
Schedule a pre-migration rehearsal that includes all the
members of the migration team and a data sampling that
helps the application groups to conduct the pre-migration
and post-migration verification process.
Follow the required change control process.

Migration 319
Table 58: Example of migration plan (continued)
Action item Assigned to Status Date
Establish a migration status call-in process.
Use a migration planning checklist to ensure that all the pre-
migration planning steps are completed.

The following schedule is an example for a simple data migration:

• Planning: two days
• Setup: two hours
• Migration: two hours and 30 minutes for one server
• Production cut over: minimal, performed in offline mode
• Migration team on site: eight hours
• Post-migration validation: two hours
A Migration log identifies objects that must be migrated to the target system and that were tested during
and after development by using standard development life cycles and methodology. For example, if you
are developing 10 new plans and five new reports for a new fiscal year, you must have a log that identifies
those 15 new objects, their names, if they were fully tested, when they passed testing, and who created
or tested those objects. This list is used as a checklist for post-migration validation.

Table 59: Example of Migration log

Item to be migrated Assigned to Status Date
Component: Quarterly Sales Bonus Ready to
Migrate
Component: Annual MBO Bonus Ready to
Migrate
Report: Finance Accruals Ready to
Migrate
Saved Imports: Payee Promotion History Ready to
Migrate
Web Form: Revenue Split Approval Ready to
Migrate

You must develop a test plan to validate that all migrated objects are integrated properly into the new
target environment and that they work. This test plan is similar to a system integration test (SIT), but at a
more granular level for each item that is migrated.

Migration phase
®
Follow certain steps to perform a migration in IBM Incentive Compensation Management.
At a high level, the following steps describe how to perform a migration:
• Communicate the migration and deployment plan.
• Customize any migration procedures.
• Run pre-validation test.
• Back up both source and target models.
• Perform the migration.
During the migration phase, the migration team must communicate its plans; review and customize
migration procedures, such as manual steps that are or are not required because of migration limitations;

320 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 back up all source and target systems; and perform the actual migration. Run a pre-migration validation
test and a post-migration validation test. These tests confirm that the objects that are being migrated are
in the same state after the migration as they were before.
The most important part of this stage is the migration itself. In addition to using the migration tool, follow
the deployment plan step-by-step to ensure a successful migration. The migration tool automates
migration of most objects within the model, but the key steps to emphasize in the deployment plan are
the items that are not automatically migrated by the tool. These items must be replicated manually in the
target model.
If this is not the first time that you are migrating from one environment to another, some of these manual
items might have been migrated in the past and might not have changed, or are not items that are
identified in the Migration log to be migrated. This is where customization of the migration procedure in
the deployment plan is necessary. You must identify what items to remove or add to account for objects
that cannot be migrated.

Validation phase
®
Follow certain steps to validate a migration in IBM Incentive Compensation Management.
At a high level, the following steps describe how to validate a migration:
• Verify migration completion with the Migration log.
• Run a post-migration test.
• Communicate project information.
• Conduct a migration closeout meeting.
• Perform knowledge transfer.
The items that are being migrated from the source systems must be tested before you plan a migration.
Also, a test plan must be in place post-migration that involves validating that the items from the Migration
log were migrated and that each one is integrated properly into the new environment.
Testing is especially critical in production environments where poorly tested migrations might cause
trouble for users. When you migrate to a UAT environment that is mirrored with a production environment,
you can do proper testing and catch any processes from the migration plan that were missed.
After the migration is complete, the team should compile migration statistics and prepare a report to
highlight what worked, what did not work, and lessons learned. The report should be shared with all
members of the migration team. These types of reports are critical in building a repeatable and consistent
process through continuous process improvement-building on what worked and fixing or changing what
did not work. Further, documenting the migration process can help train staff and simplify or streamline
the next migration, reducing both expense and risk.

Configuration-only models
A configuration-only model is an intermediate model between the source environment and the target
®
environment in IBM Incentive Compensation Management. It is a dedicated model that is used for
migrations only.
The purpose of the configuration-only model is to validate the migration process. This model contains
only build components such as Composer, Portal Access, Scheduler, and Saved Imports. There is no
transaction data in this model, and it might or might not have minimal supporting data, such as populated
reference tables that are identical and static in all environments.
In some large and complex enterprise models, having a configuration model is the only way to ensure a
clean and controlled migration process. For example, the configuration-only model sits between the
source development environment and the target environments (UAT, SIT, Performance, Data Integration,
and Production).

Migration 321
Pros and cons of configuration-only models
®
There are pros and cons to working with configuration-only models in IBM Incentive Compensation
Management.
The following examples are some of the pros of a configuration-only model:
• Clean controlled migration process
• Portability: database footprint is small and easy to send to support for troubleshooting in case of failed
migration
• Seed environment: creation of a model is fast and easy and great as a seed for other environments
• A clean model is maintained
The following examples are some of the cons of a configuration-only model:
• Overhead: extra time is required for migration process and creation of initial support data
• One extra model for maintenance

Keys for success

®
Using the configuration-only model in IBM Incentive Compensation Management requires careful
planning and practice to ensure success.
Migration plans and procedures must be developed and reviewed periodically for completeness.
Developing a plan and list of procedures is required for migrating to the configuration-only model, and
also from the configuration-only model to other target models. Discipline in this process and
communication to the teams involved are the main criteria for success.

Change management
®
After IBM Incentive Compensation Management is implemented and all the environments are
synchronized, you must manage future changes to all the environments.
The following scenarios describe the locations where change is typically required.

Table 60: Change management

Scenario Required changes
New year, new plans New plans are designed by management for the new year and must be
implemented.
Compensation business rules change.

Build in development Data structures are validated for new rules.

Design of calculations and additional components and reports.
Build new components and items.

Migrate to configure-only model Prepare migration validation test plan and scripts.

Prepare migration plan and procedures.

Communicate to migration team.
Migrate and run validation test.

322 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Table 60: Change management (continued)
Scenario Required changes
Migrate to QA or UAT Prepare migration validation test plan and scripts.
Prepare migration plan and procedures.
Communicate to migration team.
Migrate and run validation test.

Migrate to production Prepare migration validation test plan and scripts.

Prepare migration plan and procedures.
Communicate to migration team.
Migrate and run validation test.

Communication Communicate changes to sales field.

Train necessary support team and users.

Migration 323
324 IBM Incentive Compensation Management Version 10.0.0 : User Guide
Chapter 34. Command Line Tool
®
Use the IBM Incentive Compensation Management Command Line Tool to perform actions such as,
import or overwrite saved import files that are stored in ICM storage.
When you choose to save an import file, the file is saved to the Incentive Compensation Management on
Cloud storage. You can use this tool to overwrite the saved import file in ICM storage with a new file or
upload a new import file.
The IBM ICM Command Line Tool can also be used to run calculations, optimize the model, and enable
web users.
Note: The CLI tool only runs in Microsoft Windows.

Command Line Tool security

®
Authentication and security for the Command Line Tool are equivalent to the IBM Incentive
Compensation Management admin client.
File transfer using the tool is done through HTTPS via the REST API. All file contents are 64-bit encoded.
The following security features are used by both the Command Line Tool and the REST API
implementation:
• API authentication using a JSON Web Token
• the connection is HTTPS using a public SHA-256 RSA 2048-bit SSL certificate
• passwords are stored via PBKDF2 one-way hash

Using the command-line interface to connect to a model

®
To use the IBM Incentive Compensation Management command-line interface (CLI) to connect to a
model, you must know the model name, user name, and password (if a password was set).

Procedure
1. Open the command prompt window.
2. Navigate to the directory where the CLI is located.
For example, type cd C:\Program Files\IBM ICM\CLI.
3. From the command line, type the following command:
IBM ICM Command Line Tool.exe -host <host name> -model <model name> -user
<username> -pass <password>
Where
<host name> is the name of the location of the Incentive Compensation Management application.
<model name> is the name of the database that contains the model.
<username> is the user name that is used to log in to the model.
<password> is the password that is used to log in to the model. If no password is set up for the user,
omit the <password> component.

© Copyright IBM Corp. 2005, 2018 325

Command-line interface commands
®
You can use the IBM Incentive Compensation Management command-line interface (CLI) to run several
processes in the client.
You can use the following commands. All CLI commands are case-sensitive.
calcall
Calculate all objects in the model.
runproc <main folder/sub folder/process>
Run a saved process that is named <process>. The full path to the process must be provided in order
to run it. For example, main folder/sub folder/process.
enablewebuser "true" -payeeid <"payeeID of web user to enable"> -webpw <"web
user's password">
Enable a user for the Incentive Compensation Management web client.
enablewebuser "false" -payeeid <"payeeID of web to disable">
Disable a web user.
changewebuserpassword -payeeid <"payeeID of web user to change password for"> -
webpw <"web user's password">
Change a web user's password.
optimize
Optimizes the model. This command is used to ensure favorable calculation time after data is updated
in the model.
enabledto "true"
Enables the data tier performance optimization feature. To disable the feature, use the enabledto
"false" command.
The command must be typed after the model connection information.
The following command connects to the SoftCo model and calculates all objects in the model:
IBM ICM Command Line Tool.exe -host "https://icm.ibmcloud.com" -model "SoftCo"
-user admin -calcall
The following command connects to the SoftCo model and calculates all objects in the model and run a
saved process that is called Imports:
IBM ICM Command Line Tool.exe -host "https://icm.ibmcloud.com" -model "SoftCo"
-user admin -pass secret -runproc main process/sub process/Imports
The following command connects to the SoftCo model and enables a user for the Incentive
Compensation Management web client in the model:
IBM ICM Command Line Tool.exe -host "https://icm.ibmcloud.com" -model "SoftCo"
-user admin -pass secret -enablewebuser "true" -payeeid "E1000" -webpw "1234"
The following command connects to the SoftCo model and disables a Incentive Compensation
Management web client user in the model:
IBM ICM Command Line Tool.exe -host "https://icm.ibmcloud.com" -model "SoftCo"
-user admin -pass secret -enablewebuser "false" -payeeid "E1001"
The following command connects to the SoftCo model and changes a user's password for the Incentive
Compensation Management web client in the model on a server named MyServer:
IBM ICM Command Line Tool.exe -host "https://icm.ibmcloud.com" -model "SoftCo"
-user admin -pass secret -changewebuserpassword -payeeid "E1000" -webpw "4321"
The following command connects to the SoftCo model and optimizes the model:
IBM ICM Command Line Tool.exe -host "https://icm.ibmcloud.com" -model "SoftCo"
-user admin -pass secret -optimize

326 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 The following command connects to the SoftCo model and enable the data tier Performance
Optimization feature in the model:
IBM ICM Command Line Tool.exe -host "https://icm.ibmcloud.com" -model "SoftCo"
-user admin -pass secret -enabledto "true"
The following command connects to the SoftCo model and disables the data tier Performance
Optimization feature in the model:
IBM ICM Command Line Tool.exe -host "https://icm.ibmcloud.com" -model "SoftCo"
-user admin -pass secret -enabledto "false"

Return code from the command-line interface

®
To determine the result of running the IBM Incentive Compensation Management command-line
interface (CLI), you can check the value that is returned to the caller, either the operating system or
another process or tool.
The third-party tool that is used to call Incentive Compensation Management through the CLI might need
to know whether the called process was able to complete successfully. The following values can be
returned:
• A value of 0 (integer) indicates a successful execution
• A value of -1 (integer) indicates failed execution
The procedure for collecting a return code depends on the method that is used to start the Incentive
Compensation Management application. It is up to the caller of Incentive Compensation Management CLI
to capture these values so that this information can be used to take further action.

Using the CLI tool to upload import files

®
Use the CLI tool to upload import files to IBM Incentive Compensation Management on Cloud storage.

Before you begin

You must extract the IBM ICM Command Line Tool from the zip folder that came with your release.
This command imports a file to ICM storage. The command should be used when there is no file in ICM
storage that has the same filename. A new file is uploaded and the file is assigned a new file ID.

Procedure
1. Open the command prompt.
2. Navigate to the directory in which the import tool is stored.
3. From the command-line, type the following at a command prompt to upload an import file:
IBM ICM Command Line Tool.exe --host "<ICM address>" --username <ICM login
name>
--password <ICM login password> --model <name of your model>
--function importupload --name <filename> --filepath "<file path>"
where, name is the name of the file as you want it to be displayed in ICM storage and filepath is the
location of the file that you want to import.
Important: Enclose the parameters with quotation marks ("") so you do not run into problems with
spaces in names. You must update your passwords in the command every time you update your admin
client password.

Command Line Tool 327

 Results
The file uploads in small batches. If the tool runs successfully, it will return an exit code of 0. If it fails, the
tool will return a non-zero exit code. If there was an error, you can rerun the import command and it will
resume uploading at the batch it stopped at.

Using the CLI tool to overwrite saved imports

®
Use the CLI tool to overwrite a saved import file located in IBM Incentive Compensation Management on
Cloud storage.

Before you begin

You must extract the IBM ICM Command Line Tool from the zip folder that came with your release.
The overwrite parameter overwrites a saved import in ICM storage. The parameter should be used when
there is an existing file in ICM storage with the same filename. It reuses an existing file ID. If the filename
does not exist in ICM storage, the tool will create it. If the filename does exist, the tool will clear the
content of the file and overwrite it with the new content.

Procedure
1. Open the command prompt.
2. Navigate to the directory in which the import tool is stored.
3. From the command-line, type the following at a command prompt to overwrite a saved import file:
IBM ICM Command Line Tool.exe --host "<ICM address>" --username <ICM login
name>
--password <ICM login password> --model <model name> --function
importupload
--name <filename> --filepath "<file path>" --overwrite
where, name is the name of the file that you want to overwrite and filepath is the location of the file
that you want to import.
Important: Enclose the parameters with quotation marks ("") so you do not run into problems with
spaces in names. You must update your passwords in the command every time you update your admin
client password.

Results
The file uploads in small batches. If the tool runs successfully, it will return an exit code of 0. If it fails, the
tool will return a non-zero exit code. If you rerun the overwrite command, it will clear the content of the
file in ICM storage and overwrite it again.

Using the CLI tool to download saved publications

®
Use the CLI tool to download saved publications located in the IBM Incentive Compensation
Management database.

Before you begin

You must extract the IBM ICM Command Line Tool from the zip folder that came with your release.

Procedure
1. Open the command prompt.
2. Navigate to the directory in which the import tool is stored.
3. From the command-line, type the following at a command prompt to download all saved publications:

328 IBM Incentive Compensation Management Version 10.0.0 : User Guide

IBM ICM Command Line Tool.exe --host "<ICM address>" --username <ICM login
name>
--password <ICM login password> --model <name of model>
--function downloadpublication --filename "<file path>"
where, filename is location that you want the publications to be saved to. If the filename already
exists, it will be overwritten by the new downloaded file.
The following optional parameters can be used to download saved publications:

Parameters Description

limit The maximum number of files that you want to download. By default, all files are
downloaded.
For example, IBM ICM Command Line Tool.exe --host "https://
spm.ibmcloud.com" --username user1@ibm.com --password secret --
model mymodel --function downloadpublication --filename
"C:\publish.zip" --limit 1 downloads the most recent saved publication.

startdate Downloads all files published on this date and after. Must be in the format yyyy-mm-
dd
For example, IBM ICM Command Line Tool.exe --host "https://
spm.ibmcloud.com" --username user1@ibm.com --password secret --
model mymodel --function downloadpublication --filename
"C:\publish.zip" --startdate "2016-07-26"

starttime Downloads all files published at this time and after. Must be used with startdate
parameter. Must be in the format hh:mm:ss.zzz
For example, IBM ICM Command Line Tool.exe --host "https://
spm.ibmcloud.com" --username user1@ibm.com --password secret --
model mymodel --function downloadpublication --filename
"C:\publish.zip" --startdate "2016-07-26" --starttime
"14:54:33.934"

prefix Downloads all files that start with this string. Prefixes are added when creating saved
publications in the admin client.
For example, IBM ICM Command Line Tool.exe --host "https://
spm.ibmcloud.com" --username user1@ibm.com --password secret --
model mymodel --function downloadpublication --filename
"C:\publish.zip" --limit 1 --prefix calc1 downloads the most recent
saved publication that has the "calc1" prefix.

sortasc Downloads oldest files first. By default, publications are sorted by most recent first.
For example, IBM ICM Command Line Tool.exe --host "https://
spm.ibmcloud.com" --username user1@ibm.com --password secret --
model mymodel --function downloadpublication --filename
"C:\publish.zip" --limit 1 --sortasc downloads the oldest saved
publication.

Important: Enclose the parameters with quotation marks ("") so you do not run into problems with
spaces in names. You must update your passwords in the command every time you update your admin
client password.

Command Line Tool 329

 Results
If the tool runs successfully, it will return an exit code of 0. If it fails, the tool will return a non-zero exit
code. If there was an error, you can rerun the download command again, and if the filename exists, it will
replace it with new downloaded file.

330 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Appendix A. Accessibility features
IBM Incentive Compensation Management has accessibility features that help users who have a physical
disability to use the product.

Keyboard shortcuts
IBM Incentive Compensation Management includes keyboard shortcuts to help you navigate the product
and perform tasks.
The following keyboard shortcuts are based on U.S. standard keyboards.
This table outlines the keyboard shortcuts that can be used in the Incentive Compensation Management admin
and web client.

Table 61: General keyboard shortcuts in the Incentive Compensation Management admin and web client
Applies to Action Shortcut keys
General Perform the command for an active command button. Enter
General Move forward to the next item in the tab index order. Tab
Cycle to the first tab index when at the end.
General Move backward to the previous item in the tab index Shift+Tab
order. Cycle to the last tab index when at the beginning.
Check boxes Select or clear the check box. Spacebar
Menus Navigate down a menu and select a menu item. Down arrow and then Enter
Menus Navigate up a menu and select a menu item. Up arrow and then Enter
Scrolling Scroll down. Down arrow
Scrolling Scroll up. Up arrow
Zooming Zooming in. Ctrl and +, or Ctrl+Mouse
wheel up
Zooming Zooming out. Ctrl and -, or Ctrl+Mouse wheel
down
Zooming Return to default zoom level. Ctrl+0
Navigation Reload the current page. F5
Navigation Move backward to the previously opened page. Alt+Left Arrow, Backspace
Navigation Move forward to the previously opened page. Alt+Right Arrow, Shift
+Backspace
Navigation Stop a page from loading. Escape
Search Open a search box to perform a search on the current Ctrl+F, F3
page.
Search Find the next match of the searched text on the current Ctrl+G, F3
page.
Search Find the previous match of the searched text on the page. Ctrl+Shift+G, Shift+F3

© Copyright IBM Corp. 2005, 2018 331

IBM and accessibility
See the IBM Accessibility Center for more information about the commitment that IBM has to
accessibility.
The IBM Accessibility Center (http://www.ibm.com/able) is available online.

332 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Notices

This information was developed for products and services offered worldwide.
This material may be available from IBM in other languages. However, you may be required to own a copy
of the product or product version in that language in order to access it.
IBM may not offer the products, services, or features discussed in this document in other countries.
Consult your local IBM representative for information on the products and services currently available in
your area. Any reference to an IBM product, program, or service is not intended to state or imply that only
that IBM product, program, or service may be used. Any functionally equivalent product, program, or
service that does not infringe any IBM intellectual property right may be used instead. However, it is the
user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.
This document may describe products, services, or features that are not included in the Program or
license entitlement that you have purchased.
IBM may have patents or pending patent applications covering subject matter described in this document.
The furnishing of this document does not grant you any license to these patents. You can send license
inquiries, in writing, to:

IBM Director of Licensing

IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property
Department in your country or send inquiries, in writing, to:

Intellectual Property Licensing

Legal and Intellectual Property Law
IBM Japan Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any other country where such
provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION
PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of
express or implied warranties in certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors. Changes are periodically
made to the information herein; these changes will be incorporated in new editions of the publication.
IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for convenience only and do not in
any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of
the materials for this IBM product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it believes appropriate without
incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose of enabling: (i) the
exchange of information between independently created programs and other programs (including this
one) and (ii) the mutual use of the information which has been exchanged, should contact:

© Copyright IBM Corp. 2005, 2018 333

 IBM Software Group
Attention: Licensing
3755 Riverside Dr.
Ottawa, ON
K1V 1B7
Canada

Such information may be available, subject to appropriate terms and conditions, including in some cases,
payment of a fee.
The licensed program described in this document and all licensed material available for it are provided by
IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or any
equivalent agreement between us.
Any performance data contained herein was determined in a controlled environment. Therefore, the
results obtained in other operating environments may vary significantly. Some measurements may have
been made on development-level systems and there is no guarantee that these measurements will be the
same on generally available systems. Furthermore, some measurements may have been estimated
through extrapolation. Actual results may vary. Users of this document should verify the applicable data
for their specific environment.
Information concerning non-IBM products was obtained from the suppliers of those products, their
published announcements or other publicly available sources. IBM has not tested those products and
cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM
products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of
those products.
All statements regarding IBM's future direction or intent are subject to change or withdrawal without
notice, and represent goals and objectives only.
This information contains examples of data and reports used in daily business operations. To illustrate
them as completely as possible, the examples include the names of individuals, companies, brands, and
products. All of these names are fictitious and any similarity to the names and addresses used by an
actual business enterprise is entirely coincidental.
If you are viewing this information softcopy, the photographs and color illustrations may not appear.
This Software Offering does not use cookies or other technologies to collect personally identifiable
information.

Trademarks
IBM, the IBM logo and ibm.com are trademarks or registered trademarks of International Business
Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be
trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "
Copyright and trademark information " at www.ibm.com/legal/copytrade.shtml.
The following terms are trademarks or registered trademarks of other companies:
• Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or
trademarks of Adobe Systems Incorporated in the United States, and/or other countries.
• Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the
United States, other countries, or both.
• Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or
its affiliates.

334 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Glossary
This glossary includes terms and definitions for IBM Incentive Compensation Management.
The following cross-references are used in this glossary:
• See refers you from a term to a preferred synonym, or from an acronym or abbreviation to the defined
full form.
• See also refers you to a related or contrasting term.
To view glossaries for other IBM products, go to www.ibm.com/software/globalization/terminology
(opens in new window).

A
Active Directory (AD)
A hierarchical directory service that enables centralized, secure management of an entire network,
which is a central component of the Microsoft Windows platform.
AD
See Active Directory.
administrator
A person responsible for administrative tasks such as access authorization and content management.
Administrators can also grant levels of authority to users.
aggregate
A calculation that returns a single result value from several relational data rows or dimensional
members. Typical examples are total and average.
allocated adjustment
An adjustment to the results of the difference between the original value calculated for a closed
period and the value that would be currently calculated based on the new data.
application server
A server program in a distributed network that provides the execution environment for an application
program.
attribute
In markup languages such as SGML, XML, and HTML, a name-value pair within a tagged element that
modifies features of the element.

C
calculation
The process used to transform a series of records into a new result. Typically a calculation is
mathematical, but may also include sorting, shifting, or adding to a prior result. Calculations enable
the model admin to select records from their source data, perform operations on the data, segment
results, and begin another calculation based on those results.
certificate
In computer security, a digital document that binds a public key to the identity of the certificate
owner, thereby enabling the certificate owner to be authenticated. A certificate is issued by a
certificate authority and is digitally signed by that authority.
component
A container that is used to organize a model. When creating a new model, components should be
created first, in order to give the model a framework and ensure that it is easy to navigate. Once
components have been created, model elements, such as tables, calculations, and plans can be built.

© Copyright IBM Corp. 2005, 2018 335

 configuration file
A file that specifies the characteristics of a program, system device, system, or network.

D
database (DB)
A collection of interrelated or independent data items that are stored together to serve one or more
applications. See also database server.
database server
The server on which the database application and database are installed.
DB
See database.
delimiter
A character, such as comma or tab, used to group or separate units of text by marking the boundary
between them.
digital certificate
An electronic document used to identify an individual, a system, a server, a company, or some other
entity, and to associate a public key with the entity. A digital certificate is issued by a certification
authority and is digitally signed by that authority.
dimension table
The representation of a dimension in a star schema. Each row in a dimension table represents all of
the attributes for a particular member of the dimension.

F
fact table
A relational table that contains facts, such as units sold or cost of goods, and foreign keys that link the
fact table to each dimension table.

I
inbound connection
A resource that is used to import data from selected outbound connections to a component. They are
created to specify which component the selected outbound component should connect to.

J
join
An action that combines records from two or more tables or calculations based on a point of
commonality. Joins are produced by adding columns to the initial data source.

L
LDAP
See Lightweight Directory Access Protocol.
left outer join
A join whose result consists of the matched rows of the two tables that were joined and the
unmatched rows of the first table. See also join.

336 IBM Incentive Compensation Management Version 10.0.0 : User Guide

 Lightweight Directory Access Protocol (LDAP)
An open protocol that uses TCP/IP to provide access to directories that support an X.500 model and
that does not incur the resource requirements of the more complex X.500 Directory Access Protocol
(DAP). For example, LDAP can be used to locate people, organizations, and other resources in an
Internet or intranet directory.

M
manual adjustment
A one-time change to a value that is applied in specific scenarios. Administrators can add manual
adjustments to any payee for any open period.

O
optimization
The process of achieving improved runtime performance or reduced code size of an application.
Optimization can be performed by a compiler, by a preprocessor, or through hand tuning of source
code.
outbound connection
A resource that is used to export calculation results or table data from a component. They are created
from tables, calculations, and other sources.

P
parameter (parm)
A value or reference passed to a function, command, or program that serves as input or controls
actions. The value is supplied by a user or by another program or process. See also configuration file.
parm
See parameter.
partition
The division of a single calculated result into sub-results. Partitions are used to define how the results
of the calculation will be displayed. For example, if the partitioning is by payee ID, the calculation
results will show the calculated amount for each payee.
payee
An individual who is being compensated or is approving the compensation results.
period
A date interval that reported values are saved in. An example of a period is December 2000.
pick list
A list of cell values available to a user when entering data into a cell.
primary key
An object that uniquely identifies an entity bean of a particular type.

Q
query
A request for information from a database that is based on specific conditions: for example, a request
for a list of all customers in a customer table whose balances are greater than USD1000.

Glossary 337
R
root certificate
The certificate (proof of identity and keys) of the original trusted signer or certificate authority that
certifies the authenticity of the end user/entity (or of intermediate signers).

S
server
A software program or a computer that provides services to other software programs or other
computers.
server certificate
An electronic stamp stored in the server's key ring file that contains a public key, a name, an
expiration date, and a digital signature. The server certificate uniquely identifies the server.
servlet container
A web application server component that invokes the action servlet and that interacts with the action
servlet to process requests.
single sign-on (SSO)
An authentication process in which a user can access more than one system or application by entering
a single user ID and password.
SQL
See Structured Query Language.
SSO
See single sign-on.
Structured Query Language (SQL)
A standardized language for defining and manipulating data in a relational database.

V
validation rule
A rule defined on an attribute definition that specifies the criteria that must be met by the data stored
in an instance of this attribute for that attribute to be valid.
view
A virtual table that is created by joining two or more tables together. Views can also include the results
of calculations.

W
web application server
The runtime environment for dynamic web applications. A Java™ EE web application server
implements the services of the Java EE standard.
web client
An interface where payees can review and approve their compensation payments via a web browser.
The Incentive Compensation Management web client runs on a variety of servlet containers.
web server
A software program that is capable of servicing Hypertext Transfer Protocol (HTTP) requests.
workflow
The sequence of activities performed in accordance with the business processes of an enterprise.

338 IBM Incentive Compensation Management Version 10.0.0 : User Guide

Index

A Audit log (continued)

viewing workflow events in 206
access Audit logs
web tabs 210 security overview 281
access to features, See security Audit module
action nodes overview 249
force approving or rejecting pending 207 permission to edit 281
Action nodes permission to view 281
adding 201 auto join
activities disabling 90
canceling 179
filtering 179
overview 179
B
viewing details 179 base URLs
Activity setting for web client 292
viewing Computation logs 252 BPM, See Workflow Manager
Activity tab breadcrumbs 19
overview 179
administration
permission to add documents to the Manage Documents C
window 286
calculate
permission to delete saved imports 284
canceling 103
permission to delete saved publications 285
Composer 76
permission to delete saved transformations 285
overview 103
permission to edit administrative options 283
security overview 283
permission to edit saved imports 284
starting 103
permission to edit saved publications 284
troubleshooting 105
permission to edit saved transformations 285
viewing details for 104
permission to run saved imports 284
calculated values
permission to run saved publications 284
adding 118
permission to view administrative options 283
calculations
permission to view saved transformations 285
adding category 71
security overview 283
adding sort 70
Adobe Acrobat, See PDF files
adding sources by columns 82
Alert nodes
adding time shift 71
adding 200
adding user-defined 69
alerts
copying 75
activating for payees 239
copying data to clipboard 74
configuring the Report Name with Link variable in an
creating a left outer join in 73
alert node 201
creating formulas 101
disabling for payees 239
editing 74
overview 239
editing locked 78
permission to add 281
enabling incremental 104
AND or OR groups
exporting results from 74
adding 91
exporting results to .csv file 74
overview 91
filtering 76
audit
finding 7
tenant log 255
formatting formulas 102
Audit log
importing categories from excel 73
actions and events 249
importing categories from text files 72
exporting 251
improving speed of with Data Tier Performance
filtering results 250
Optimization 105
overview 249
increasing speed of 104
permission to use as source in Presenter 279
moving sources 84
Scheduler errors 231
overview 69
setting options 251
previewing 76
viewing details of table edits 251
publishing overview 173

339
calculations (continued) components (continued)
publishing to Microsoft Excel file 173 columns between in tables 33
publishing to PDF file 173 copying 22
publishing to Salesforce.com 175 data flow between 20
publishing to text file 174 deleting 22
purging data 77 finding 7
refreshing data in 75 inbound and outbound connections in 20
replacing data sources 80 migrating 312
types 69 organizing 19
viewing current values 76 overview 19
viewing history of 77 permission to delete 270
viewing sources that use 77 permission to edit 270
viewing sources used by the calculation 78 permission to view 269
calendars renaming 21
adding 296 security overview 269
adding periods to locked 299 setting color for 21
editing 296 unwrapping 23
effect of period locking on 300 viewing 19
multiple 296 wrap and unwrap overview 22
overview 295 wrapping 22
permission to edit 286 Composer
permission to lock 287 adding objects as favorites 15
permission to view 286 adding Producer Lifecycle and Credential Management
category calculations, See calculations objects in 67
change sets adding Territory Management objects in 65
changing the order of 245 arranging components and objects 13
overview 244 components 19
overwrite 244, 246 connections 23
transform 245, 246 hiding objects 14
charts migrating 312
adding charts with no axes to Presenter reports 153 migrating objects in 317
adding multi-series to Presenter reports 154 multi-edit mode 16
adding single series to Presenter reports 151 Navigation tab 14
CLI overview 13
connecting to models with 325 Palette tab 14
return codes 327 permission to edit 269
running commands 326 permission to view 268
cli tool purging calculation data 77
security 325 purging table and calculation data 40
CLI tool purging table history 49
overview 325 security overview 268
overwriting imports 327 selecting objects in 17
overwriting saved imports 328 setting color of components 21
saving imports 327 showing objects 14
using to download saved publications 328 single-edit mode 16
client tables 29
changing theme to match Salesforce.com 222 viewing data and results of tables or calculations 14
enabling Data Tier Performance Optimization in 105 viewing overview of 16
overview 3 viewing sidebar 14
publishing Presenter reports from 176 viewing sources for objects 14
Client Success portal 7 zooming in 17
Cognos Territory and Quota Management Composer diagram
adding objects 65 exporting 17
imports from 65 permission to view 268
loading data manually into 66 viewing 16
switching reports associated with 66 Computation log
colors disabling the generation of 252
publishing preferences 175 enabling the generation of 252
setting for components 21 generating 252
setting for gauges 156 overview 103, 251
components viewing 252
adding 20 conditional formatting
adding documents to 21 setting up in Presenter reports 147
breadcrumbs 19 Conditional nodes

340
Conditional nodes (continued) data imports (continued)
adding 203 importing replacement characters 64
configuration-only models managing 68
keys for success 322 merging fields for mapping columns 63
overview 321 overview 57
pros and cons 322 permission to delete 284
connections permission to edit 284
adding 24 permission to import 272
deleting 26 permission to manage saved 284
editing 25 permission to overwrite 273
editing mapping for 25 permission to use advanced settings when importing
globalizing 36 273
inbound and outbound 20 permission to view 273
names 24 security overview 272
overview 23 selecting Microsoft Excel files as data source 58
renaming 24 selecting Salesforce.com as data source 61
replacing for global tables 36 selecting XML files as data source 59
replacing with global tables 26 tracking import progress in the Activity module 65
viewing current values in 27 types of 57
viewing the flow of data through 27 viewing log 253
workflow nodes 204, 205 data source
constant values renaming joined source 84
adding 118 data sources
custom tables 31 adding 79
adding columns 80
adding data sources by rows 86
D adding rows 85
dashboards, See workflow dashboards adding sources by columns 82
data grids anchor feature 84
adding editable columns to Presenter reports 139 defining restrictions for sources 89
adding pagination 145 multiple sources 80
adding section breaks to 138 overview 79
adding templates to Presenter reports 150 previewing 87
adding to Presenter reports 132 data stores
adding validation rules for values in Presenter reports adding 107
140 adding sources by columns 82
adding with input rows to Presenter reports 133 copying data to clipboard 108
applying a template for Presenter reports 151 exporting data from 108
editing templates in Presenter reports 151 exporting data to .csv file 108
enabling copy of data grid rows into inquiries 145 exporting to Watson Analytics 110
enabling text wrapping in data grids 148 overview 107
expanding 135 permission to delete 276
freezing header row 144 permission to edit 276
renaming data grid columns for Presenter reports 145 permission to view 276
reordering columns in 142 security overview 276
resetting the name of data grid columns for Presenter Data table
reports 146 adding 35
selecting columns 136 overview 31
setting the sort order for 138 Data Tier Performance Optimization
setting the width of data grid columns for Presenter enabling in client 105
reports 146 database
showing or hiding columns in web client 143 importing into tables 60
templates 150 dates
data imports adding to Presenter reports 132
adding sub-items for mapping columns 61 specifying for tasks 237
category calculations 72, 73 deferrals
changing import escape character 64 canceling 238
CLI tool 325 dependencies
data from data stores to Watson Analytics 110 viewing 15
effective date tables 64 Dependency Viewer
from Cognos Territory and Quota Management 65 copying text from 15
from Producer Lifecycle and Credential Management 67 deleted components 22
importing from database files 60 viewing 37
importing from text files 57 diagram, See Composer diagram

341
display columns F
accumulating partitions 96
defining in calculations 94 favorites
empty partitions 94 adding objects to list 15
including empty partitions 95 overview 14
documents permission to view Composer module in list 268
adding links to Presenter reports 130 permission to view table structure in list 270
adding to components 21 features
managing 303 making requests for 8
permission to add to the Manage Documents window filters
286 Audit log results 250
downloads calculation data 76
saved imports 303 custom 163
saved publications 303 Home page 7
migrating web forms 313
Navigation tab 14
E pick lists 34
effective dates Portal Access 162
adding data to tables with 47 saved web forms 164
adding end dates to records in tables with 47 simple 161
adding tables with 45 table data 42
converting tables to 45 web form 161
deleting multiple versions of records in tables with 48 workflow errors, actions, and history 207
mapping columns to import dates 64 fixed grids
overview 44 adding to Presenter reports 134
viewing data in tables with 46 fonts
viewing multiple versions of data in tables with 46 editing in Presenter reports 127
elements, See objects setting alternating in Presenter reports 142
emails setting in charts 151
adding notifications 239 setting in data grids 132
announcing available documents 217 setting in multi-series charts 154
errors from Scheduler 231 setting in Presenter reports 129
notifications from Alert nodes 200 setting in web forms 166
notifications from Scheduler 225 formulas
passwords from Task Manager 237 computed columns in Presenter reports 136
publications from Scheduler 169 computed rows in Presenter reports 137
sending about inquiries to all members of group 221 creating 101
sending about sign off process to all members of one enforcing single row 104
group 218 formatting 102
sending to pending payees about inquiries 220 functions 97
sending to pending payees about sign off process 218 locked calculations 78
sending to users when a sign off is pending 219 null values 149
sending to users when an inquiry is pending 221 overview 97
setting address for Request Assistance link on the web single row 104
292 user-defined calculations 69
escape character
changing 64 G
Excel, See Microsoft Excel
Export log gauges
viewing 252 adding to Presenter reports 156
exports global actions
Audit logs 251 restrictions 5
category calculations 71 global tables
Composer diagram 17 adding 36
data grids to Microsoft Excel 132 replacing connections for 36
defining taglines 169 glossary 335
viewing logs 252 graphics, See images
web forms to PDF 177 groups
workflow errors, actions, and history to Microsoft Excel AND or OR 91
208 category calculations 71
external tools payees 300
adding 305 Portal Access 211
sending emails about inquiries to all members of 221
web tabs 210

342
H inquiries (continued)
viewing details assigned to administrator 222
headers viewing details from a group 221
enabling custom 223
hiding in data grids 144
inserting images for PDF files 170, 177
J
help JavaScript
accessing 8 adding to web forms 165
accessing video tutorials 8
Client Success portal 7
Hierarchy table 30 L
Home
layout tables
adding items to watch list on 7
editing alignment in Presenter reports 127
Home page
editing borders in Presenter reports 127
Client Success portal 7
editing padding in Presenter reports 127
finding components, tables, Presenter reports, and web
overview 125
forms in 7
left outer joins 84
Online pane 7
links
overview 7
in Presenter reports 128
locked calculations, See calculations
I login
forcing web users to change passwords on first login
ICM storage 309 292
illustrations, See images forcing web users to change passwords on next login
images 213
adding to Presenter reports 130 logos, See images
inserting into headers for PDF files 170, 177 logs
publishing preferences 175 Audit 231, 249
import escape character Computation 103, 251
changing 64 Import 253
Import log Migration 318
viewing exceptions 253 Node Errors 206
imports, See data imports permission to purge history 271
incremental calculations 104 permissions 258
input forms Scheduler 232
adding 53 Signature 254
adding rows to 55 viewing Export 252
adding validation rules to 54 viewing Performance 254
assigning users to 54 viewing Scheduler 253
editing rows in 56 viewing Task 253
importing data into 55
overview 53
permission to add 274 M
permission to add rows to 275
Microsoft Excel
permission to delete 274
exporting workflow errors, actions, and history to 208
permission to delete rows from 275
publishing calculations to 173
permission to edit 274
publishing tables to 170
permission to edit data in 275
selecting as data source 58
permission to view history of 275
migration
security 54
components 312
security overview 274
Composer 312
viewing 53
Composer objects 317
inquiries
configuration-only models 321, 322
adding categories 222
filtering 317
allowing web client users to copy data grid rows into
global tables 313
145
main step to perform a migration 320
disabling 220
main steps for testing and verifying 318
editing categories 222
main steps to plan 318
enabling 220
main steps to validate 321
overview 220
managing future changes 322
sending emails to all member of one group 218
migration phase 320
sending emails to pending payees 220
objects that cannot be migrated 315
sending emails to users when pending 221
overview 311
viewing details 221

343
migration (continued) objects (continued)
performing 316 selecting in Composer 17
permission to perform 288 switching reports from Cognos Territory and Quota
planning 322 Management 66
planning phase 318 unwrapping 23
Portal Access trees 313 wrap and unwrap overview 22
Presenter reports 313 wrapping 22
process lists 314 ODBC Compliant Database
tables with pick lists 312 permission to use advanced settings when importing
validation phase 321 273
web forms 313 OLAP cubes
web forms filters 313 star schemas 301
web tabs 313 Online pane 7
workflows 315 optimization
Migration log 318 models 295
model permission to optimize models 286
viewing maintenance 5 overwrite change sets
models adding 244
connecting with CLI 325 editing properties for 246
migrating configuration-only 321, 322 overview 244
optimizing 295
permission to optimize 286
viewing summary 5
P
modules pagination
overview 6 adding to data grids on the web client 145
Palette tab
N viewing 14
partitions
naming conventions overview 93
Presenter 114 passwords
Navigation tab changing for users 291
viewing 14 forcing payees to change 213
Node Errors log 206 forcing web users to change passwords on first login
nodes 292
Action 201 payee groups
alert 201 adding payees to 300
Alert 200 deleting payees from 301
Conditional 203 editing effective dates for payees in 301
connecting 204 overview 300
copying 203 permission to view 287
cutting 203 payees
deleting connections between 205 activating alerts for 239
editing 203 adding to payee groups 300
overview 199 adding to Portal Access groups for web client 212
pasting 203 adding to workflows 197
Process 202 deleting from payee groups 301
resolving errors 206 disabling alerts for 239
Start 200 permission to edit groups 287
numeric values sending emails to pending about inquiries 220
adding to Presenter reports 131 sending emails to pending about sign off process 218
how null values are handled in Presenter reports 149 PDF files
null values in Presenter reports 149 publishing calculations to 173
publishing tables to 170
publishing web forms to 177
O Performance log
objects comparing computations 254
adding in Producer Lifecycle and Credential viewing 254
Management 67 period accuracy
adding Territory Management 65 overview 297
loading data manually into Cognos Territory and Quota period locking
Management 66 calendar changes 300
loading data manually into Producer Lifecycle and locking 298
Credential Management 67 overview 297
procedure 297

344
period locking (continued) Presenter report layout (continued)
relationship to system functions 299 adding multi-series charts 154
unlocking 298 adding numeric values 131
permissions, See security adding pagination to data grids on the web client 145
PGP encryption adding pick lists 158
automation 233 adding signature control 159
prerequisites 233 adding single series charts 151
scheduling 233 adding tables 125
pick lists adding text 129
adding to Presenter reports 158 adding text controls 159
defining in tables 34 adding text values 130
displaying a description field for 41 adding validation rules for data grid values 140
pictures, See images adding workflow dashboards 135
Portal Access allowing web client users to copy data grid rows into
adding groups for 211 inquiries 145
adding payees to groups for web client 212 applying a data grid template 151
ending a sign off 218 data grid templates 150
forcing sign off approval 219 deleting contents 126
forcing users to change passwords 213 deleting tables 126
granting access to Pulse reports 191 editing data grid templates 151
inquiries on Presenter reports 119 editing tables 126
inquiry process 220 enabling text wrapping in data grids 148
main steps to create hierarchy 211 expanding data grids 135
overview 209 formatting columns 147
permission to edit 280 formatting data grid rows 141
permission to view 280 freezing the header row in data grids 144
security overview 279 hiding data grid headers 144
sending emails about inquiries to all members of group null numeric values 149
221 optional null numeric values 149
sending emails about sign off process to all members of renaming data grid columns in 145
one group 218 resetting column names in data grid 146
sending emails to pending payees about inquiries 220 resizing cells in tables 127
sending emails to pending payees about sign off process selecting columns in data grids 136
218 setting alternating row fonts 142
sign offs 217 setting column widths 146
starting a sign off 218 setting conditional formatting 147
trees 213 setting the default font 129
validating tree assignments 217 showing date in 148
viewing sign off status for group members 219 showing grid lines 142
web tabs 209 showing or hiding columns in web client 143
Portal Access trees showing time in 148
adding 214 swapping components 126
adding web adjustments 216 Presenter reports
assigning 216, 217 adding 114
defining hierarchies for sign off 215 adding aggregate transformations 120
migrating 313 adding calculated values 118
overview 213 adding computed columns 121
Port Access Tree Builder 214 adding constant values 118
Presenter report adding parameters 115
links 128 adding row form sources 123
Presenter report layout adding sources 119
adding a Submit button 158 adding stored values 117
adding charts with no axes 153 adding transposes 121
adding computed columns 136 components 113
adding computed rows 137 data components 113
adding current date 132 editing alignment in layout tables 127
adding data grid templates 150 editing borders in layout tables 127
adding data grids 132 editing fonts 127
adding data grids with input rows 133 editing padding in layout tables 127
adding document links 130 finding 7
adding editable columns to data grids 139 linked parameters 116
adding fixed grids 134 linking to other reports 128
adding gauges 156 linking to web forms 128
adding images 130 linking to web pages 129

345
Presenter reports (continued) Pulse (continued)
main steps to create link 116 adding plans 181
migrating 313 creating admin reports 188
naming conventions 114 creating earnings reports 189
overview 113 creating team performance reports 190
parameters 115 creating team rankings reports 190
permission to edit 278 creating transaction reports 188
permission to use Audit log as a source 279 data sources 183
permission to view in Composer 278 editing plans 183
Portal Access Inquiries sources 119 granting access to 191
previewing 160 overview 181
publishing from client 176 permission to edit 279
renaming 114 permission to view 279
row form sources 122 reporting hierarchy 181
security overview 278 reports 183
selecting publishing preferences 175 security overview 279
sources 118 setting the calendar 182
stored value examples 117 viewing plans 183
transformations 120 Python scripts
values 117 development 306
Work Form IDs 119 ICM storage 309
primary keys 33 packaging 307
process lists packaging non-standard libraries 308
adding 9 running in Scheduler 306
adding subtasks to 11 troubleshooting 306
adding tasks to 10 uploading using FTP 305
changing the order of tasks in 12 uploading using the admin web application 305
copying 11 using non-standard Python libraries 307
deleting links from 12
deleting tasks from 12
editing 12
Q
marking tasks as complete in 12 Quick Navigation pane
migrating 314 finding components, tables, Presenter reports, and web
overview 9 forms in 7
permission to add 267
permission to delete 268
permission to edit 268 R
permission to view 267
reports
security overview 267
data components 130
viewing 9
finding 7
Process nodes
Presenter reports 113
adding 202
scenario 246
rerunning 207
switching objects associated with Cognos Territory and
processes
Quota Management 66
disabled 228
restrictions
enabled 228
adding AND or OR groups 91
Producer Lifecycle and Credential Management
defining for sources in calculations 89
adding objects in 67
defining global 91
imports from 67
deleting 92
loading data manually into 67
disabling automatic joins 90
publications
moving sources in calculations 92
managing 169
overview 89
permission to delete 285
using AND or OR groups 91
permission to edit 284
roles
permission to run 284
adding 257
sending through email 169
assigning to input forms 54
Publisher
assigning to users 291
overview 169
copying 258
publishing calculations 173
deleting 258
publishing tables 170
example 290
publishing tables to Microsoft Excel 170
exporting 258
pulse
permission overview 258
plans 181
security overview 257, 258
Pulse

346
rules security (continued)
adding 237 administration 283
tasks 237 approving web data edits 51
validation 54, 140, 164 assigning users to input forms 54
Audit logs 281
calculate 283
S cli tool 325
Salesforce.com components 269
changing theme of client to match 222 Composer 268
changing theme to 223 data imports 272
publishing calculations to 175 data stores 276
publishing tables to 172 defining accessible information in tables 50
selecting as data source 61 enabling direct table editing through web client 51
saved imports input forms 54, 274
downloading 303 overview 257
saved publications Portal Access 279
downloading 303 Presenter reports 278
scenarios publishing report 293
adding 243 Pulse 279
adding items to 243 restricting visible rows in tables 50
adding overwrite changes sets for 244 roles 257
adding transform change sets for 245 roles access 258
adding workspaces for 242 scenarios 277
calculating workspaces 243 Scheduler 280
changes sets for 244 tables 270
changing the order of change sets 245 Task Manager 281
deleting workspaces 242 tools 286
editing properties for overwrite changes sets 246 users 288
editing properties for transform changes sets 246 web forms 278
editing workspaces 242 web users 291
generating reports 246 Workflow Manager 282
moving items 244 sidebar
overview 241 viewing 14
permission to add 277 sign offs
permission to create workspaces 277 ending 218
permission to promote 277 forcing approvals 219
permission to view 277 overview 217
previewing transform change sets 246 sending emails to pending payees 218
promoting 247 sending emails to users when pending 219
security overview 277 viewing status for group members 219
workspaces 242 signature controls
Scheduler adding to Presenter reports 159
adding processes 227 Signature log
adding subfolders 227 overview 254
adjusting timing 231 viewing 254
copying and pasting processes 227 sort calculations, See calculations
error notifications 231 sources
overview 225 moving sources in calculations 84
permission to edit 281 star schemas
permission to view 280 adding 302
PGP encryption 233 overview 301
process-level properties 226 permission to edit 287
properties 225 permission to view 287
running items 231 Start nodes
security overview 280 editing 200
sending publications through email 169 stored values
tasks 228 adding 117
time conflicts 231 examples 117
viewing logs 253 Structural table 31
viewing schedule history purges 230 Submit buttons
Scheduler log adding to Presenter reports 158
viewing 232, 253 swim lanes
schemas, See star schemas adding 198
security adding columns to 199

347
swim lanes (continued) tables (continued)
deleting 199 publishing to Microsoft Excel 170
form initiators 198 publishing to PDF 170
overview 197 publishing to Salesforce.com 172
removing columns from 199 publishing to text file 171
System tables 29 purging calculation data in 40
purging history in 49
refreshing data in 65
T replacing connections with global 26
tables replacing data in 43
adding 34 restricting visible rows in 50
adding data to 38 security overview 270
adding data to records with effective dates 47 Structural 31
adding Data type 35 System 29
adding effective dates 45 Turning off warning message when deleting rows in 40
adding end dates to records with effective dates 47 types 29
adding global 36 View 32
adding View type 35 viewing data in 38
approving web data edits 51 viewing data in tables with effective dates 46
clearing contents of 41 viewing dependencies 37
column types 33 viewing multiple versions of data in tables with effective
columns between components in 33 dates 46
copying 37 viewing structure of 36
copying data to clipboard 44 taglines
copying multiple rows in 39 defining 169
copying text from Dependency Viewer 15 task lists
custom 31 generating 237
Data 31 Task log
defining accessible information in 50 viewing 253
defining pick list field types for 34 Task Manager
deleting 37 activating payee alerts 239
deleting multiple rows in 40 adding email notifications 239
deleting multiple versions of records in tables with adding groups 235
effective dates 48 adding rules 237
disabling history collection for a specific table 49 administering tasks 237
disabling history collection for all future tables 49 alerts 239
disabling history collection for tables 48 canceling deferrals 238
displaying description in pick list columns 41 deferring tasks 238
editing a View table 37 deleting tasks 238
editing data in 38, 39 disabling payee alerts 239
editing default edit date for records in 39 generating task lists 237
editing multiple rows in 39 groups 235
editing structure of 36 organizing groups 236
effective dates 44 organizing rules 237
enabling direct editing through web client 51 overview 235
exporting data from 44 permission to add alerts 281
exporting data to .csv file 44 permission to add tasks 281
filtering data in 42 rules 236
finding data in 43 running tasks 238
Hierarchy 30 security overview 281
history in 48 tasks
keys 33 adding to process folders 230
migrating 312 adding to process lists 10
migrating global 313 administering 237
navigating between 42 changing the order of in process lists 12
overview 29 deleting from process lists 12
permission to add Views 272 deleting links from process lists 12
permission to delete 271 disabled 228
permission to edit structure 271 enabled 228
permission to enable web data edit for 272 marking as complete in process lists 12
permission to purge change log history 271 tenant log
permission to view structure 270 exporting 255
primary keys 33 viewing 255
publishing overview 170 text controls

348
text controls (continued) users (continued)
adding to Presenter reports 159 setting email address for Request Assistance link on the
text files web 292
importing into tables 57
publishing calculations to 174
publishing tables to 171
V
text values validation
adding to Presenter reports 130 adding rules to input forms 54
themes View table
changing 223 adding 35
changing client to match Salesforce.com 222 editing 37
time shift calculations, See calculations overview 32
tools Viewer
overview 295 viewing data and results of tables or calculations 14
permission to edit calendars 286
permission to edit payee groups 287
permission to edit star schemas 287 W
permission to lock calendars 287
WAR file
permission to optimize models 286
setting base URLs with 292
permission to perform a migration 288
watch list
permission to view calendars 286
adding items to 7
permission to view payee groups 287
Watson Analytics
permission to view star schemas 287
exporting data from data store to 110
security overview 286
registering 109
transform change sets
troubleshooting 111
adding 245
using Postman for development and testing 111
editing properties for 246
web client
overview 244
adding payees to Port Access group for 212
transformations
approving web data edits in 51
aggregate 120
changing theme for 223
computed columns 121
disabling message center 223
managing 43
enabling direct table editing through 51
overview 120
forcing users to change passwords on first login 292
permission to delete 285
security for user login 291
permission to edit 285
setting email address for Request Assistance link 292
permission to view 285
setting the base URL for 292
transposes 121
showing or hiding columns in Presenter reports 143
Workflow Manager 208
U web data
approving edits 51
URLs defining accessible information for 50
setting the base URL for web client 292 enabling direct editing for 51
user-defined calculations, See calculations restricting visible rows in tables for 50
users web forms
adding 288 adding 161
assigning roles tor 291 adding admin forms to 165
changing passwords for 291 adding JavaScript to 165
concurrent 288 adding row forms to 164
defining accessible table information for 50 adding saved filters to 164
enabling direct table editing through web client 51 adding sources to 163
environment roles 290 adding validation rules to 164
forcing to change passwords 213 adding web resources to 165
forcing web users to change passwords on first web copying cells in 166
login 292 defining custom filters for 163
global action restrictions 5 defining Portal Access filters for 162
publishing permissions report 293 defining simple filters for 161
restricting visible rows in tables for 50 filters 161
security options on web 291 finding 7
security overview 288 format 166
sending emails about inquiries to all members of group formatting 166
221 linking to Presenter reports 128
sending emails about sign off process to all members of migrating 313
one group 218 migrating filters for 313

349
web forms (continued) workflows (continued)
overview 161 setting default parameters for 196
pasting cells in 166 starting 196
permission to edit 278 viewing errors 206
publishing 177 viewing events in Workflow Manager 206
security overview 278 viewing pending actions 207
setting cell spans in 166 viewing workflow events in Audit log 206
setting options in 166 workspaces
setting preferences in 167 adding for scenarios 242
sources 163 calculating 243
web messages deleting 242
adding 304 editing 242
deleting 304 scenarios 243
editing 304
overview 304
sending to all users 304
X
web pages XML files
linking to Presenter reports 129 selecting as data source 59
web tabs
access 210
adding 209 Z
adding groups for 210
zooming in Composer 17
deleting 210
editing 210
migrating 313
moving 210
overview 209
Work Form IDs
overview 119
workflow dashboards
adding to Presenter reports 135
Workflow Manager
main steps to create 193
nodes 199
overview 193
permission to create workflows 282
permission to edit workflows 282
permission to start workflows 283
permission to view Workflow Manager 282
permission to view workflows 282
security overview 282
swim lanes 197
viewing events in 206
web client 208
workflows 193
workflow nodes, See nodes
workflows
adding 194
adding payees to 197
clearing history 208
copying 196
deleting 195
editing 195
enabling pending 205
errors 205
exporting errors, pending actions, or history 208
filtering errors, pending actions, or history 207
finding 197
force approving or rejecting pending actions 207
migrating 315
organizing 197
overview 193, 208
pending state 205
rerunning Process nodes 207

350
IBM®