OrgAudit VSN43 Admin en

Visualization Solutions by Nakisa 4.
Nakisa OrgAudit
Administrator Guide
1/14/2015
Legal Notice
Copyright Nakisa Inc. 2014. All rights reserved.
The information contained in this document represents the current view of Nakisa on the issues dis-
cussed as of the date of publication. Because Nakisa must respond to changing market conditions, it
should not be interpreted to be a commitment on the part of Nakisa, and Nakisa cannot guarantee the
accuracy of any information presented after the date of publication.
This document is for informational purposes only. NAKISA MAKES NO WARRANTIES, EXPRESS OR
IMPLIED, AS TO THE ACCURACY OF THE INFORMATION IN THIS DOCUMENT. This document
should be read in conjunction with any applicable Professional Services Agreement that may be in effect.
Complying with all applicable copyright laws is the sole responsibility of the user. Without limiting the
rights under copyright, which are hereby expressly reserved, no part of this document may be copied,
reproduced, stored in or introduced into a retrieval system, distributed or transmitted in any form or by any
means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the
express written permission of Nakisa Inc.
Nakisa may have patents, patent applications, proprietary information, trade secrets, trademarks, copy-
rights, or other intellectual property rights (“the Nakisa IPR”) covering subject matter in this document.
Except as expressly provided in any written license agreement formally executed by Nakisa, the fur-
nishing of this document does not proffer any rights (license or otherwise) to the Nakisa IPR.
The example companies, organizations, products, people and events depicted herein are fictitious. No
association with any real company, organization, product, person or event is intended or should be
inferred.
Nakisa, Nakisa OrgManagement Series, Nakisa Talent Management Series, OrgChart, SocialLink, Dir-
ectory, OrgModeler, OrgAudit, OrgHub for HR & Executives, OrgHub for Managers, OrgHub for Employ-
ees, TalentHub for HR & Executives, TalentHub for Managers, TalentHub for Employees,
TalentFramework, TalentDashboard, TeamManager, FloorPlan, Nakisa Edit, Nakisa SelfService, Visu-
alize What Matters Most, Visualisez l’essentiel are either registered trademarks or trademarks of Nakisa
Inc. in the United States and/or other countries.
SAP Talent Visualization by Nakisa is a trademark of SAP AG.
The names of actual companies and products mentioned herein may be the trademarks of their respective
owners, and Nakisa makes no representations as to the right of any person or entity to use said trade-
marks.
i www.nakisa.com
Contents
1 Welcome 1
1.1 About Nakisa 2
1.2 About the Application 2
1.3 What's New 3
1.4 Related Documentation 4
1.5 Technical Support 4
2 Getting Started 5
2.1 Application Overview 6
2.2 Launching the Nakisa AdminConsole 6
2.3 Uploading the Serial File 7
2.4 Using the Interface 7
2.5 Saving and Publishing a Build 8
2.6 Launching the User Console 9
3 SAP Connection and Authorization 11

3.1 Connection String 12
3.2 User Types 13
3.3 Authorization Objects 13
3.4 Emergency User 18
4 Security Settings 20
4.1 Securing Nakisa AdminConsole 21
4.2 Defining Roles 23
4.2.1 About Defining Roles 23
4.2.2 Securing Items for Roles 23
4.2.3 Granting Access per Role 24
4.2.4 Set Role Priority 25
4.2.5 Creating a New Role 25
4.2.6 Setting Default Roles 25
4.2.7 Denying Access 26
4.2.8 Managing Role Permissions 26
4.2.9 Deleting a Role 26
4.3 Setting User Authentication 27
4.3.1 About Setting User Authentication 27
4.3.2 Logon Screen 27
4.3.3 Single Sign-on with User ID 28
4.3.4 Single Sign-on with Logon Tickets 28
4.3.5 Anonymous Access 29
4.3.6 Setting iView Credentials 29
ii www.nakisa.com
4.3.7 Setting the Authentication Source 29
4.3.8 Setting Employee Source 30
4.3.9 Mapping Roles 30
4.4 Confirm and Submit Settings 31
4.5 Communication Channel Encryption 31
5 Application-wide Settings 33
5.1 Configuring General Settings 34
5.2 Defining Print and Export Settings 34
5.3 Managing Validations 36
5.3.1 About Managing Validations 36
5.3.2 Adding a Simple Validation 36
5.3.3 Adding a List Validation 38
5.3.4 Adding a DB List Validation 39
5.3.5 Adding a Popup Validation 40
5.3.6 Adding an Auto-Complete Validation 42
5.3.7 Adding an Auto-Complete Popup Validation 43
5.3.8 Editing Validations 44
5.4 Customizing Error Messages 45
5.5 Using Caption Editor 45
5.6 Exporting and Importing Captions 46
5.7 Using the Admin Activity Manager 47
5.8 Enabling Org Chart Box Notes 48
5.9 Resource Bundle Configuration 49
6 Debug Tools 52
6.1 Debug Tools Overview 53
6.2 Viewing and Exporting System Information 53
6.3 Log Manager 54
6.4 Network Diagnostic 54
7 SAPExtractor 55
7.1 SAPExtractor Overview 56
7.2 Setting Up Extraction 56
7.2.1 About Setting Up Extraction 56
7.2.2 SAP Source Connection 56
7.2.3 Destination Database 57
7.2.4 Table Details 57
7.2.5 Keywords 58
7.2.6 Table Fields 59
7.2.7 Confirm and Submit Settings 59
7.3 Starting Extraction 59
7.4 Scheduling Extractions 60
Nakisa Inc. iii

8 Audit Configuration 63
8.1 Setting Up the Staged Database 64
8.2 Configuring Staged Database Connections 64
8.3 Extracting Audit Data 66
8.4 Creating Template Rules 67
8.4.1 About Creating Template Rules 67
8.4.2 Download SAP Infotype 67
8.4.3 Rule Logic 70
8.4.3.1 About Rule Logic 70
8.4.3.2 Basic Rule Logic Form 70
8.4.3.3 Advanced Rule Logic Form 72
8.4.4 Default Rule Parameters 73
8.4.5 Sync Configurations 75
8.4.6 Example Template Rule Creation 75
8.5 Editing Template Rules 79
8.5.1 About Editing Template Rules 79
8.5.2 Select Template Rule 79
8.5.4 Rule Logic 82
8.6 Deleting Template Rules 85
8.7 Adding Rules 86
8.8 Modifying Rules 89
8.9 Running Audits 90
8.10 Managing Audit History and Rules 92
8.11 Scheduling Extraction and Audit Runs 92
9 Data Center 99
9.1 Data Center Overview 100
9.2 Managing Data Connections 100
9.3 Creating Data Elements 103
9.3.1 About Creating Data Elements 103
9.3.2 Merge Two Data Elements 103
9.3.3 Data Element for RDBMS Structure 104
9.3.4 Data Element with Custom Integration Class 106
9.4 Resetting the RFC Cache 109
10 Details Designer 110

10.1 Details Designer Overview 111
10.2 Create Top-Level Details 112
10.3 Modifying the Design 112
10.3.1 About Modifying the Design 112
iv www.nakisa.com
10.3.2 Creating Linked Details 114
10.3.3 Creating Joined Details 115
10.3.4 Adding Detail Title 116
10.3.5 Creating Table Layout 117
10.3.6 Adding Collapsible Panels 118
10.3.7 Adding Tabs 119
10.3.8 Adding Sections 120
10.3.8.1 About Adding Sections 120
10.3.8.2 XHTML Sections 121
10.3.8.3 Custom Sections 123
10.3.9 Moving Elements 123
10.3.10 Removing Elements 124
10.3.11 Style Properties 125
10.4 Layout Element and Section Reference 125
10.4.1 Section Definitions 125
10.4.2 Layout Element and Section Reference 129
10.4.3 Basic Layout Elements and Sections 130
10.4.4 Static Layout Elements and Sections 136
10.4.5 Pre-defined Sections 140
10.5 Linking Details to Hierarchies 142
10.6 Linking Org Charts to Details 143
10.7 Linking Details to Listings 144
11 Org Charts 145

11.1 Org Chart Overview 146
11.2 Org Chart Configuration 148
11.2.1 Enable/Disable 148
11.2.2 Assistant and Council Display Settings 148
11.2.3 Print and Export Templates 149
11.3 Hierarchy Configuration 150
11.3.1 Data Connection 150
11.3.2 Fields 151
11.3.3 Root Hierarchies 152
11.3.4 Linked Hierarchies 153
11.3.5 Assistant and Council Filters 155
11.3.6 Subcategory Groups 156
11.3.7 Selected Item Fields 157
11.3.8 Sort Fields 157
11.3.9 Select Details 158
12 View Designer 159

12.1 View Designer Overview 160
12.2 Accessing the Views Designer 160
Nakisa Inc. v
12.3 Enabling and Disabling Views 160
12.4 View Caption 160
12.5 Table Layout 161
12.6 Sections 162
12.7 Box Size 163
12.8 Box Color 164
12.9 Color Mapping 164
12.10 Hidden Sections 165
12.11 Condensed Style 165
12.12 Preview Mode 165
12.13 Remove Controls 166
13 Listings and Searches 167

13.1 Listing Overview 168
13.2 Enable/Disable 169
13.3 Data Connection 170
13.4 Fields 171
13.5 Directory Filter 171
13.6 Selected Items Fields 172
13.7 Listing Columns 172
13.8 Search Form 173
13.9 Advanced Search Form 174
13.10 Select Details 174
14 Custom Listings 176

14.1 Custom Listing Overview 177
14.2 RDBMS and LDAP Data Element Listings 177
14.2.1 About RDBMS and LDAP Data Element Listings 177
14.2.2 Select a Listing 177
14.2.3 Listing Information 178
14.3 Remove Listings 178
15 ChartBook 180
15.1 ChartBook Overview 181
15.3 ChartBook Templates 182
15.4 ChartBook Server Settings 183
15.5 Clustered Environments 183
15.6 ChartBook Captions 184
16 User Preferences 186
vi www.nakisa.com
16.1 Enabling and Disabling Preferences 187
16.2 Storing User Preferences 187
16.3 Cleaning the Swap File 189
16.4 Default User Console Settings 189
16.4.1 About Default User Console Settings 189
16.4.2 Application Languages 190
16.4.3 Themes 190
16.4.4 Date Format 190
16.4.5 Default Layout 191
16.4.6 Org Chart Modes 191
16.4.7 Accessibility Mode 192
17 Build Management 193

17.1 Build Folder Structure 194
17.2 Exporting Builds 195
17.3 Importing Builds 196
17.4 Exporting Configurations 197
17.5 Uploading Content 197
17.6 Resetting Builds 198
17.7 Deleting Builds 199
17.8 Adding Comments to Builds 199
18 Backing Up and Restoring 200

18.1 Backing Up and Restoring Builds 201
18.2 Backing Up and Restoring the Staged Database 201
19 Add-On Manager 202

19.1 Add-On Manager Overview 203
19.2 Activate an Add-On 203
19.3 Create an Instructions File 204
19.4 Enable an Inactive Add-On 205
19.5 Disable an Add-On 205
19.6 Remove an Add-On 206
20 Application Logs 207

20.1 Application Log Overview 208
20.2 Enabling Administrator and Error Logs 210
20.3 Enabling AdminConsole Activity Logs 210
20.4 Changing Error Log Settings 210
20.5 Viewing Error Logs 211
20.6 Viewing AdminConsole Activity Logs 212
20.7 Exporting Error and AdminConsole Activity Logs 212
20.8 Generating Performance Reports 212
Nakisa Inc. vii

20.9 Creating Error Logs 213
20.10 Logs and SAP NetWeaver 214
20.11 Trace Application Errors 214
20.12 Remote Support 215
21 Troubleshooting 216
21.1 Error Message: Could not read properties 217
21.2 Error Message: Invalid JAVA_HOME 217
21.3 Cannot extract data to DB2 database 218
21.4 Published changes are unavailable to users 219
21.5 User login screen does not load 219
21.6 User interface does not display correctly 220
21.7 Cannot load the Print and Export wizard 221
21.8 Error Message: Internal Error 221
21.9 Org Chart diagram is missing 222
21.10 Error Message: Invalid login 222
21.11 Unable to navigate through AdminConsole wizards 223
22 Glossary 224
23 Index 229
viii www.nakisa.com
1 Welcome
1
Learn about Nakisa, obtain general information about the application, and this administrator guide.
1.1 About Nakisa 2

1.2 About the Application 2
1.3 What's New 3
1.4 Related Documentation 4
1.5 Technical Support 4
1 Welcome
1.1 About Nakisa

Nakisa® Inc. is a leading Organization and Talent Management software company, providing the world's
largest organizations with the ability to visualize and maintain accurate HCM data, confidently execute
organization design, devise harmonized succession and career plans, and create an aligned, high-per-
forming workforce. In collaboration with a global network of partners, Nakisa serves a wide range of cus-
tomers across all sectors and regions. Nakisa's expanding client base includes 700+ enterprise
customers, with more than 4 million subscribers from 24 industries, in 125 countries. Nakisa has been a
partner of SAP® since 2007. SAP® Organizational Visualization by Nakisa® (SOVN) and SAP® Talent
Visualization by Nakisa® (STVN) are co-developed, supported and sold by SAP. Available in 18 lan-
guages, these official solution extensions form a key part of the SAP product and enhancement roadmap,
ensuring customers fully benefit from the latest SAP HCM technology innovations.
For more information, visit www.nakisa.com.
1.2 About the Application

Nakisa OrgAudit is a tool used to enforce SAP HCM (Human Capital Management) data integrity and to
ensure that relevant business rules are followed. Data entry issues can cause key pieces of information
to be missing, inconsistent, or incorrectly maintained. This can have a negative impact, ranging from mild
(for example, indicating an employee is scheduled for retirement due to an incorrectly entered birth date)
to severe (for example, salary errors, or terminated employees remaining on the payroll).
Configure the application using the Nakisa AdminConsole to customize each feature according to com-
pany requirements. Settings are organized into modules that are accessed from the menu panel.
The application consists of the following modules:
l Configure Staging includes the SAPExtractor tool, which is used to extract human resource and ana-
lytic data from the SAP system to a staged database.
l Configure Audits is used to set up Nakisa OrgAudit audit runs.
l Application-Wide Settings includes the tools to configure general settings such as validations, logs,
and captions.
l Security Settings is used to configure authentication and user roles.
l Data Center is used to define connections to databases and create custom data elements.
l Listing is used to configure the directory listings and search settings.
l ChartBook is used to define the available ChartBook mode and templates.
l Details Designer is used to define the layout of the Details panel, and link it to and listings.
l Audit View is used to configure org charts and listings.
l Preferences is used to set up the available and default languages and User Console interface
defaults.
Note: The information provided in this guide may not correspond exactly to the current application if it is
customized.
The Nakisa AdminConsole is used to select and customize the options presented to the end-user accord-
ing to their role. The process includes the following main tasks:
2 www.nakisa.com
l Selecting how users are authenticated on the application server.
l Setting connections to the SAP data source.
l Setting application defaults.
l Turning features on or off.
l Customizing user interface and user preferences.
l Setting the data fields to call organization and human resource information used by the application.
l Designing how this information is presented in the organizational charts and record details.
l Defining the company hierarchy for the org chart.
l Setting up listing directories and search forms.
l Defining save and publish settings and customizations.
1.3 What's New

In addition to general editorial changes and corrections, this release of the documentation for the Nakisa
AdminConsole contains the following main changes since the last product release:
l When user preferences are configured to be saved in the database, you can now select which options
are enabled. See Storing User Preferences, section 16.2 on page 187.
l Administrators can now delete cached user records by user. See Storing User Preferences, section
16.2 on page 187.
l Nakisa Master Administrators can now track changes made within the AdminNakisa AdminConsole,
including tasks such as logging in, uploading new content, resets to the build, etc. See Using the
Admin Activity Manager, section 5.7 on page 47
l Administrators can now sort captions by category when creating and editing them. See Using Caption
Editor, section 5.5 on page 45
l If the connection string does not contain user name and password information, then temporary cre-
dentials can be saved for the Nakisa AdminConsole session when they are needed to configure cer-
tain wizards. See Managing Data Connections, section 9.2 on page 100.
l Administrators can now test the connection to the email established in the Admin Console. See Defin-
ing Print and Export Settings, section 5.2 on page 34
l The default "admin" user can now set password complexity requirements for Nakisa AdminConsole
passwords. Administrator users can also require other users to create a new password the next time
they log in to the Nakisa AdminConsole. See Securing Nakisa AdminConsole, section 4.1 on page 21.
l The Admin Console now contains a network diagnostic tool. See Network Diagnostic, section 6.4 on
page 54.
l ABAP Add-on and Transport Package information is now displayed in the System Information page.
l The RFC cache can be cleared from the Admin Console, without requiring the application to be
rebooted. See Resetting the RFC Cache, section 9.4 on page 109.
Nakisa Inc. 3
1 Welcome
1.4 Related Documentation

The following documentation is available in addition to this guide:
l The Release Notes describe new features and list known issues.
l The Environment Checklist provides all the software, hardware, and SAP requirements, and sup-
ported RDBMS databases.
l The Nakisa ABAP Add-on Installation and Specifications Guide provides details about implementing
the custom function modules used to integrate Nakisa applications with the SAP system.
l The Nakisa Transport Package Installation and Specifications Guide provides details about imple-
menting the SAP HR Interface for Organizational Charting (HR-OCI) configurations on the
SAP server.
l The Deployment Guide provides instructions for deploying and securing Nakisa applications in the
SAP NetWeaver environment.
l The User Guide includes information on features and functions available in the User Console.
1.5 Technical Support

Consult the SAP Service Marketplace Web site at http://service.sap.com, or contact SAP Global Support
Center if you require product support for Nakisa applications.
4 www.nakisa.com
2 Getting Started
2
Learn the basics of the application, such as accessing the Nakisa AdminConsole, loading and saving
builds, and interface elements.
2.1 Application Overview 6

2.2 Launching the Nakisa AdminConsole 6
2.3 Uploading the Serial File 7
2.4 Using the Interface 7
2.5 Saving and Publishing a Build 8
2.6 Launching the User Console 9
2 Getting Started
2.1 Application Overview

Nakisa OrgAudit has organizational charts (org charts) that indicate the formal structure of a business or
company, and uses this structure to display data such as error counts, severity, and error correction
trends based on data extracted from the SAP source.
From the Nakisa AdminConsole, the administrator can extract the required data into a staged database,
set up rules to validate the data, and execute the rules by performing audit runs. The results are then
viewed through the User Console, which also contains customizable listings and a dashboard that
provides a graphical overview of the audit run results.
Note: For information on customizing the Nakisa OrgAudit Dashboard module, contact your imple-
mentation partner.
When Nakisa OrgAudit is first deployed, the following set up procedure must be performed:
1. Set up the staged database by extracting staging data and audit data using the procedure outlined in
Setting Up the Staged Database, section 8.1 on page 64.
2. If required, modify the org chart and listing information.
Once the application and staging database have been set up, the administrator can generate error data
and statistics using the following procedure:
1. To validate rules against the latest data, extract information from the SAP source using the SAPEx-
tractor and audit data extractor.
2. Add rules or modify existing rules that will be used to detect errors in the database during an audit run.
3. Validate the data in the staged database against the existing set of rules by performing an audit run.
4. Verify the audit run results displayed in the Nakisa OrgAudit User Console.
2.2 Launching the Nakisa AdminConsole

Nakisa OrgAudit is a Web-based application installed on a company server, and is launched from a Web
browser using the administrator URL:
http://[hostname]/[virtual_directory]/manager.jsp
The [hostname] is the Web server name, and [virtual_directory] is the name of the folder
where the application is installed.
The administrator URL also provides access to the Nakisa AdminConsole for remote application support.
Access to the Nakisa admin and error logs is unavailable using this URL.
The application Serial file is required to use Nakisa OrgAudit. See Uploading the Serial File, section 2.3 on
the facing page for details.
Application settings are stored in specific builds that can be loaded, modified, saved and published by
using the Nakisa AdminConsole. Nakisa applications come with one or more default builds that have pre-
defined settings.
Once a build is published, the configurations are stored in a build workspace. Build workspace names
correspond to the default build name and an ID number. For example, if the default SAP_Live build is pub-
lished, the application creates the ___000___SAP_LIVE build workspace. See Build Folder Structure,
section 17.1 on page 194 for details about the application folders and files.
6 www.nakisa.com
Note: Nakisa recommends using the Nakisa AdminConsole during off-peak hours. Errors may occur in
the User Console if it is accessed while configurations are changed.
To launch the Nakisa AdminConsole:

1. Enable the following Internet options in the Web browser:
l JavaScript
l Cookies
l Pop-up windows
2. Open the administrator URL. The build selection frame is displayed.
Application settings are stored in a specific build that is saved and published by the administrator.
3. Select the required build from the list, then Load. The selected build is loaded, and details about the
build appear in the Build Panel at the top of the Nakisa AdminConsole.
General application information and the technical support e-mail are displayed when the build loads.
2.3 Uploading the Serial File

The application Serial file is required to use Nakisa OrgAudit. The Serial specifies the modules, lan-
guages, and the total number of records available to the application according to the current license. This
file is implemented when the application is deployed on the server, or the administrator uploads it using
the Nakisa AdminConsole at first login, if required.
To upload the Serial file:

1. Launch the Nakisa AdminConsole. A message appears on the page indicating that the license is
expired.
2. Click Upload.
3. Enter the administrator User name and Password, click Login.
4. Click Browse and navigate to the directory where the Serial file is stored.
5. Select the Serial file, click Upload. The Serial file is saved to the XML folder in the main applic-
ation directory.
6. Close the browser window, then re-launch the Nakisa AdminConsole. The application reads the
Serial file, and the required modules, features, and license are activated.
2.4 Using the Interface

The Nakisa AdminConsole is used to configure Nakisa OrgAudit according to company requirements.
This section provides an overview of the interface.
Nakisa Inc. 7
2 Getting Started
Nakisa logo: Accesses the Nakisa website.

Expand/collapse button: Expands or collapses the menu panel to extend the Wizard panel.
Navigation bar: Indicates the path taken to arrive at the current setup wizard, and provides access
to context-sensitive help .
Build panel: Displays information on the current build.
Logout: Click the administrator user name to log out of the Nakisa AdminConsole.
Menu panel: Displays the application and module menus.
Save & Publish current build: Displays the Save As, Save, and Publish buttons on the top-right of
the console.
Wizard panel: Displays the application and module setup wizards.
2.5 Saving and Publishing a Build

Application settings are stored in a specific build that is saved and published by the administrator. Con-
figuration files store the settings required by the user interface components in all Nakisa applications.
When the application is deployed, it only contains the default builds shipped with the application. One or
more default builds may be included, depending on the Nakisa application. A build workspace folder is cre-
ated the first time a build is loaded in the Nakisa AdminConsole.
When changes to a build are saved, the modified configuration files are saved to both the build workspace
folder and the delta folder within the build that keeps track of the changes.
When a build is published, all files contained in the build workspace folder are copied to the main applic-
ation directory.
8 www.nakisa.com
Changes to the application configurations are recorded in the log file saved in the Admin log, located in the
[application directory]/.system/Admin_config/[build workspace]/Log directory.
See Enabling Administrator and Error Logs, section 20.2 on page 210 for information about the admin log.
For more information about the build directories and the exact folders that are affected by saving and pub-
lishing a build, see Build Folder Structure, section 17.1 on page 194.
Note: It is highly recommended that the application is restarted after each publish operation. If you
choose to not restart the application, there may be an impact on the overall system performance. To
restart the application, refer to the following instructions: https://help.sap.com/saphelp_nw73/help-
data/en/49/d56e1cdf482221e10000000a42189d/frameset.htm. (Set a filter to see Nakisa applications,
and keep the window open to restart the application after each publish.)
To save and publish changes to a build:

1. In the menu panel, click the Save & Publish current build link. The Save As, Save, and Publish
buttons load in the top-right corner of the build panel.
2. Click Save. The changes made to the current build are written to the file of the selected build, but they
do not appear to users.
3. Click Save As to create a new build. The current build is copied to a new folder in the default install-
ation directory. The new build appears in the build selection frame the next time the Nakisa
AdminConsole is accessed.
Tip: Save As is useful for creating test builds and backups. Only custom builds saved in this way
can be deleted.
4. Click Publish. The new settings are saved and applied to the user interface after publication. The
console automatically quits administrator mode, and prompts the administrator to end the browser
session.
5. Log out of the Nakisa AdminConsole.
6. Close the Web browser.
2.6 Launching the User Console

Changes made to the application using the Nakisa AdminConsole appear in the User Console after the
administrator publishes the build.
To access the User Console:

1. Enable the following Internet options in the Web browser:
l JavaScript
l Cookies
l Pop-up windows
2. Open the following URL:
http://[hostname]/[virtual_directory]/default.jsp
The [hostname] is the Web server name, and [virtual_directory] is the name of the folder
where the application is installed.
The login frame is displayed.
Nakisa Inc. 9
2 Getting Started
Note: The login frame is omitted when the application is set up for Windows Integrated, single sign-
on, or anonymous access.
3. Enter your User name and Password.
4. Select the required Language from the drop-down list if the application is available in multiple lan-
guages.
5. Select Accessibility Mode to access the text-only interface.
6. Click Log In. The application loads in the Web browser and displays the selected language.
10 www.nakisa.com
3 SAP Connection and Author-
3
ization
3.1 Connection String 12
3.2 User Types 13
3.3 Authorization Objects 13
3.4 Emergency User 18
3 SAP Connection and Authorization
3.1 Connection String

The application connects to the SAP data source using a connection string.
The following is an example connection string:
ASHOST=SAPSERVER SYSNR=0 CLIENT=800 USER=user PASSWD=password
This string has the following attributes:
Attribute Description
ASHOST SAP server name
SYSNR SAP system number
USER SAP user name
PASSWD SAP user password
CLIENT SAP client number
The following is an example connection string for an SAP system configured for load balancing:
MSHOST=SAPSERVER R3NAME=SID GROUP=PUBLIC SYSNR=0 CLIENT=800 USER=user
PASSWD=password
This string has the following attributes:
Attribute Description
MSHOST Host name of the Message Server for the SAP system.
R3NAME ID of the SAP system when the SAP system is configured for load bal-
ancing.
Note: This attribute is mandatory when MSHOST is used.
GROUP Name of the SAP server group.

Note: This attribute is for an optional group of application servers in a load
balancing connection.
SYSNR SAP system number
USER SAP user name
PASSWD SAP user password
CLIENT SAP client number
The ASHOST, MSHOST, R3NAME, GROUP, SYSNR, and CLIENT attributes connect to the SAP server. Use
these attributes for Single Sign-On (SSO) authentication. The connection is established using the cre-
dentials entered in the log-in form or SSO ticket.
The USER and PASSWD attributes contain the user credentials retrieved by the log-in form or SAP portal.
12 www.nakisa.com
The MYSAPSSO2 attribute replaces USER and PASSWD when Single Sign-On with Logon Tickets authen-
tication is used.
Use all connection attributes if the application is set for Anonymous Access.
A service account may be used with single sign-on authentication to retrieve data from the SAP server.
This reduces the overhead created when new user server connections are set. The service account secur-
ity permissions are applied instead of user permissions. Enter values for USER and PASSWD in this scen-
ario.
3.2 User Types

Nakisa applications support various user types, which can typically include:
l Everyone (all employees)
l Manager
l Assistant
l Human Resources
l Executive
All user types must be mapped to at least two SAP roles:
l The /NAKISA/OM_COMMON role is used to perform authorization checks, and is required for all user
types. See Authorization Objects, section 3.3 below for details on which authorization objects are
required for this role.
l Each user type must be mapped to an additional SAP role that either limits or expands the author-
ization objects included in the /NAKISA/OM_COMMON role. If one does not exist, create a role (or if
necessary, multiple roles) with the required authorization objects for each user type.
3.3 Authorization Objects

Nakisa OrgAudit audits data extracted from the SAP system. The connection string set in the SAP
source connection for the SAPExtractor specifies the SAP backend user that is authorized to run the
extraction. This backend user must have access to the authorization objects provided in the tables that fol-
low to ensure that all data is extracted from the SAP system.
Nakisa Inc. 13
Authorization Check for RFC Access and underlying HR module objects

Object Field Value
S_RFC ACTVT 16
RFC_NAME /NAKISA/*
/NAKISA/HR_COMMON_FM (only applicable for ECC 6 EhP4,
EhP5, EhP6)
HCM_ORG_PUBLISH_XML
HRMSS_OCI
HRWPC_EMPLOYEEPROFILE_45FF
HRWPC_GENERAL_INFOTYPES
HRWPC_OADP_GENERAL
PERS
RFC1
RH65
RHPD_SEARCH
RHPH
RH_ORGPUB_APP
RH_PDOTYPES
SDIFRUNTIME
SDTX
SYST
RFC_TYPE FUGR
Authorization for File Access

Object Field Value
S_DATASET ACTVT 33
FILENAME *
PROGRAM *
Archive Link: Authorizations for Access to Documents

Note: Depending on the client's setup, multiple values for the OADOKUMENT field may be required.
14 www.nakisa.com
Object Field Value
S_WFAR_OBJ ACTVT 03
OAARCHIV *
OADOKUMENT HRIBMPFOTO
HRICOLFOTO
HRIEMPFOTO
HRIPCXFOTO
HRIPDDFOTO
ZHRICOL614
OAOBJEKTE PREL
CO-CCA: General Authorization Object for Cost Center Accounting

Object Field Value
K_CCA CO_ACTION 0003
KSTAR *
RESPAREA *
CO-CCA: Cost Center Master

Object Field Value
K_CSKS ACTVT 03
KOKRS *
KOSTL *
Authorization for Table Maintenance (using standard tools such as SM30)

Object Field Value
S_TABU_DIS ACTVT 03
DICBERCLS KA
PA
PC06
SC
PC
FC01
FC33
Nakisa Inc. 15
HR: Master Data (used for HR infotype authority checks)

Refer to the SAP Library article "P_ORGIN (HR: Master Data)" for additional information.
Object Field Value

P_ORGIN AUTHC R
INFTY 0000-0002
0006
0007
0008
0016
0032
0041
0077
0105
PERSA * (Personnel area)
PERSG * (Employee group)
PERSK * (Employee Subgroup)
SUBTY * (Subtype are subdivisions of infotypes)
VDSK1 * (Organizational Key)
HR: Master Data - Personnel Number Check

Note: This check is not performed if the user has no personnel number assigned, or if the user accesses
a personnel number other than his or her own.
Object Field Value

P_PERNR AUTHC R
INFOTYPE 0000-0002
0006
0007
0008
0016
0032
0041
0105
PSIGN * (Interpretation of assigned personnel number)
SUBTY * (Subtypes are sub-divisions of info types)
16 www.nakisa.com
Personnel Planning
Used to perform authorization checks for fields in Personnel Management components, such as Organ-
izational Management and Personnel Development.
Object Field Value

PLOG INFOTYPE 1000-1002
1003
1007
1011
1028
1033
ISTAT * (Planning Status)
PLVAR * (Plan Version from Structural Authorization)
PPFCODE DISP (function code)

HITW
LISD
SIMU
OTYPE * (Object Type)
Nakisa Inc. 17
HR: Master Data - Extended Check

Object Field Value
P_ORGXX AUTHC R
INFOTYPE 0000-0002
0006
0007
0008
0016
0032
0041
0077
0105
SACHA * (Payroll Administrator)
SACHP * (HR Master Data Administrator)
SACHZ * (Time Recording Administrator)
SBMOD * (Administrator Group)
The following authorization objects require configuration if Context Sensitive Structural Authorization is
set up in the SAP system:
Object Description
P_ORGINCON HR: Master Data with Context
P_ORGXXCON HR: Master Data - Extended Check with Context
The following tables are required to extract data for Nakisa OrgAudit:
Table Description
AGR_USER User authentication
T001 Company code information
PA0709 HR Master Record - Person ID
3.4 Emergency User

Emergency users can access the SAP system in the rare case where all administrative users are locked
due to incorrect configuration and/or forgotten passwords.
The application relies on the emergency user concept (SAP* system super user or DDIC data dictionary
and software logistics super user) for the back-end ERP system or HR system.
18 www.nakisa.com
Refer to the "Activating the Emergency User" article in the SAP Library for related procedures.
Nakisa Inc. 19
4 Security Settings
4
Learn how to secure the application by setting up user authentication and roles.
4.1 Securing Nakisa AdminConsole 21

4.2 Defining Roles 23
4.2.1 About Defining Roles 23
4.2.2 Securing Items for Roles 23
4.2.3 Granting Access per Role 24
4.2.4 Set Role Priority 25
4.2.5 Creating a New Role 25
4.2.6 Setting Default Roles 25
4.2.7 Denying Access 26
4.2.8 Managing Role Permissions 26
4.2.9 Deleting a Role 26
4.3 Setting User Authentication 27
4.3.1 About Setting User Authentication 27
4.3.2 Logon Screen 27
4.3.3 Single Sign-on with User ID 28
4.3.4 Single Sign-on with Logon Tickets 28
4.3.5 Anonymous Access 29
4.3.6 Setting iView Credentials 29
4.3.7 Setting the Authentication Source 29
4.3.8 Setting Employee Source 30
4.3.9 Mapping Roles 30
4.5 Communication Channel Encryption 31
4 Security Settings
4.1 Securing Nakisa AdminConsole

The Manage Administrator Console Users wizard is used to perform the following tasks:
l Change an administrator password
l Add administrative users with read and write access
l Add administrative users with read-only access
l Remove users
l Add password complexity
Access to the Nakisa AdminConsole is secured using the default user name "admin" and password
"admin". Nakisa recommends securing the Nakisa AdminConsole by changing the default password for
the "admin" user.
Changing Passwords
To change the password:
1. In the menu panel, click Security Settings > Manage Users.
2. Select the checkbox next to the required user, then click Change password.
3. Enter the Old Password.
4. Enter a new Password.
5. Re-enter the new password.
6. To force the user to change their password the first time they log in, select Change Password at
Next Logon.
Tip: You do not have to assign users a new password if you just want to force them to change their
password at the next log on. In this case, simply select the checkbox and leave the previous fields
empty.
7. Click Confirm. The password is changed.
Note: Administrators must log out and then log back in to access the Manage Administrator Console
Users wizard if they change their own password.
Adding Admin Users

This procedure adds a new administrative user with read and write access to the Nakisa AdminConsole.
Note: These new administrative users do not have the right to set password complexity.
To add an admin user:

2. Click Create new user.
3. Enter the User name and Password.
4. Re-enter the password.
Next Logon.
21 www.nakisa.com
6. Click Confirm. The user is created and can access the Nakisa AdminConsole using the credentials
provided.
Adding Read-Only Users

Read-only access is configured for remote support of Nakisa applications. The following actions are dis-
abled in the Nakisa AdminConsole when a read-only user logs in:
l Submit in all setup wizards
l Save As, Save, and Publish build
l Create new admin user
l Change admin password
l Delete admin users
l Set or change password complexity
To add a read-only user:

2. Click Create new user. The Add or modify user form loads in the wizard.
3. Add the prefix "ro_" to the User name, for example: ro_admin.
4. Enter the Password.
5. Re-enter the password.
Next Logon.
7. Click Confirm. The user is created and can access the Nakisa AdminConsole in read-only mode.
Removing Users
To remove a user:
2. Select the checkbox next to the required user, or click to select all users in the list (click to
clear all the checkboxes).
3. Click Delete selected user(s). The user is removed from the Existing users list and can no longer
access the Nakisa AdminConsole.
Note: The default "admin" user cannot be deleted.
Adding Password Complexity

The default "admin" user can add or change the complexity of all new passwords used to log in to the
Nakisa AdminConsole. Note that newly created administrative users do not have access to this feature.
To set the complexity of all new passwords for the Nakisa AdminConsole:
2. Click Modify Password Complexity.
3. Enter a regular expression for the required complexity. For example, to require that passwords con-
tain 4 to 8 characters, the regular expression would be: ^.{4,8}$
4. In the menu panel, click Save & Publish current build, then click Publish in the top-right corner of
the build panel.
Nakisa Inc. 22
4 Security Settings
4.2 Defining Roles
4.2.1 About Defining Roles

Roles are used to group employees and assign those groups a specific set of rights and privileges to the
application. Nakisa roles are defined in the application with the required security permissions for modules,
org charts, listings, and Details panel tabs, and are then mapped to the corresponding roles in the
SAP role repository.
The application has the following default user roles:
l Executive
l Manager
l HR (Human Resources)
These roles determine the user type and the components a user can access in the application.
Defining roles is a three-step process:
l Secure the required application items
l Create roles according to user groups
l Assign each role access to the secured items based on the required rights and privileges
Roles are defined in the Nakisa AdminConsole using the following setup wizards. Click a link to view the
task procedures:
Setup Wizard Task

Add/Remove Secure Items Secure application items for the required role.
Allow Actions By Role Determine whether to grant access to specific print and export
options for each available role.
Edit Roles Create or delete Nakisa roles, and manage permissions to secured
items for each role.
Summary Confirm and submit the new role settings.
The roles created by the administrator are mapped to specific users when setting user authentication.
See Mapping Roles, section 4.3.9 on page 30 for information about user authentication and roles.
Note: To restrict users from seeing specific errors related to a rule in the error listings and Details panels,
the rule itself must be secured in the Nakisa AdminConsole. See Adding Rules, section 8.7 on page 86 or
Modifying Rules, section 8.8 on page 89 for more information.
4.2.2 Securing Items for Roles

The Add/Remove Secure Items setup wizard is a tree view of the different application items the admin-
istrator can secure for the required roles. A secured item is only accessible in the User Console when a
role is assigned to it.
Note that the following features cannot be secured in this wizard step:
23 www.nakisa.com
l Tasks in the Action menu of the Details panel
l Tasks in the context menu for listings and org charts
l Individual hierarchies (entire org charts are secured, but the underlying linked hierarchies are not)
l Details panel sections (Details panel tabs are secured, but the sections contained within the tabs are
not)
Securing the above items requires changes to the configuration files. Contact your implementation partner
if securing these items is required.
Warning: If you create new org charts, listings, or Details panels, ensure that they are secured in this wiz-
ard step to prevent restricted users from viewing sensitive data.
Note: Ensure that each role has access to at least one org chart. An error occurs in the application when a
user who does not have access to an org chart logs into the User Console.
To secure items for roles:

1. In the menu panel, click Security Settings > Define Roles.
2. Click [+] in the tree view to expand the required modules, tasks, directories, org charts, listings, and
details (tabs).
3. Select Show Technical Names at the top right to display the technical field names listed in the tree.
A field that has the link icon ( ) indicates that the component is used in more than one area of the
application. For example, a field that appears in both the org chart box and the record details panel.
4. Select the checkboxes next to the required items in the tree to limit access to those items.
5. Click Next.
See also:
l Creating a New Role, section 4.2.5 on the next page
4.2.3 Granting Access per Role

Grant or deny access to print and export actions for the default roles using the Allow Actions By Role
setup wizard.
The following tables describes the different actions allowed by role:
Action Description
PrintOrgChart Print org charts.
ExportPdf Export org charts to PDF.
ExportImage Export org charts to image.
ExportListing Export listings.
FlexPrintAdvancedMode When false, the only print and export feature available is tem-
plate selection. Applicable only in Enhanced mode.
Note: For the export options to be available to the user, you must enable the global export settings. See
Defining Print and Export Settings, section 5.2 on page 34 for more information.
Nakisa Inc. 24
4 Security Settings
To grant or deny access for an action per role:

2. Click Allow Actions By Role to load the setup wizard.
3. In the table, select true to grant an action to a role or false to secure that action from the role.
4. If required, click Reset Authorizations to revert to the default values.
5. Do one of the following:
l If further role configurations are required, click Next to edit roles.
l If no other settings are required, click Finish > Submit.
4.2.4 Set Role Priority

If a user is granted more than one role, the user's permissions may contradict each other depending on the
permissions granted by those roles. In order to avoid conflicts in these scenarios, the available roles can
be ordered by their priority. The user's role with the highest priority will have its permissions in effect.
To set the priority of the available roles:

1. In the menu panel, click Security Settings > Define Roles > Set Role Priority.
2. In the table, set the priority of the available roles using the drop-down lists in the Priority column. Pri-
ority is assigned in ascending order, e.g., '1' assigns the greatest priority, '2' the next and so on.
l If further role configurations are required, click Next.
l If no other settings are required, click Finish > Submit.
4.2.5 Creating a New Role

Create roles using the Edit Roles setup wizard.
To create a role:
2. Click Edit Roles to load the setup wizard.
3. Enter a New role name, then click Add. The new role loads in the Manage Role Permissions sec-
tion.
See also:
l Managing Role Permissions, section 4.2.8 on the facing page
4.2.6 Setting Default Roles

Set a default role to allow access to authenticated user groups that are not mapped to a Nakisa role. The
default role should have minimal permissions to prevent access to sensitive information.
25 www.nakisa.com
To set a default role:
2. Click Edit Roles.
3. Under Manage Role Permission, select the required role from the drop-down list and then click Set
as Default.
Authenticated users that are not mapped to a Nakisa role gain access to the application based on the
selected role's permissions.
4. Click Finish > Submit.
4.2.7 Denying Access

This setting is used to deny access to authenticated user groups that are not mapped to a Nakisa role.
To deny access:
2. Click Edit Roles.
3. Under Deny Access, select Allow Valid Roles Only.
4.2.8 Managing Role Permissions

Grant permission to secured items for each role using the Edit Roles setup wizard.
Note: Ensure that each role has access to at least one org chart. An error occurs in the application when a
user who does not have access to an org chart logs into the User Console.
To grant permission to secured items:

3. In the Manage Role Permissions section, select the required role from the drop-down list. The per-
mitted and secured items for that role appears below the drop-down list.
4. Select the checkboxes next to the required Secured Items for the role, then click Add to Role's
Items. The items load in the Permitted Items list.
5. Select the checkboxes next to the required Permitted Items for the role, then click Remove from
Role's Items. The selected permissions are removed from the role.
4.2.9 Deleting a Role

Roles are deleted using the Edit Roles setup wizard.
Nakisa Inc. 26
4 Security Settings
To delete a role:
3. Select the required role from the drop-down list. The role loads in the Manage Role Permissions sec-
tion.
4. Click Delete Role.
4.3 Setting User Authentication
4.3.1 About Setting User Authentication

Access to the application is configured in the Security Settings module of the Nakisa AdminConsole. Vari-
ous authentication methods are available to best suit your system landscape.
The following authentication methods are available:
l Logon Screen: Prompts users to enter a user name and password to access the application. Login cre-
dentials are transmitted to the server over the HTTP connection using HTTP POST.
l Single Sign-on with User ID and Password: Authenticates users based on their SAP Portal cre-
dentials.
l Single Sign-on with Logon Tickets: Utilizes SSO2 logon tickets to authenticate users based on their
SAP Portal credentials.
l Anonymous: Users have access to the application without a user-specific account.
Setting authentication involves the following tasks:
l Select the authentication method used to secure access to the application. (Click the links above for
instructions).
l Set the credential information source. This step is only required for the Single Sign-on with User ID
and Password authentication method.
l Set the server connection that hosts the user directory service, and specify where user information is
stored.
l Set the connection to link authenticated users in the authentication source to their records in the
employee database. This step is required if dynamic org chart rooting (setting a different org chart root
depending on the logged-in user) is required.
l Map Nakisa user roles to roles defined in the company role repository.
l Confirm and submit the authentication settings.
4.3.2 Logon Screen

The user provides an ID and password when the authentication mechanism is set to Logon Screen. Login
credentials are transmitted to the server over the HTTP connection using HTTP POST. This mechanism
is used when the application is deployed independently.
27 www.nakisa.com
Refer to the "Using Basic Authentication (User ID and Password)" article in the SAP Portal for more
information.
To enable logon screen access:

1. In the menu panel, click Security Settings > Authentication Settings.
2. Select Logon Screen as the authentication mechanism.
3. In the wizard navigation panel, click Authentication Source to set the authentication server con-
nection.
4.3.3 Single Sign-on with User ID

The user is authenticated when they access the application after logging in to the SAP portal. This mech-
anism is used for SAP systems that do not support SAP logon tickets (typically when the application is
embedded in the SAP portal using iView) or for testing and demo purposes.
Note: User names and passwords must be URL-encoded for special characters to be handled properly.
Refer to the "Single Sign-On with User ID and Password" article in the SAP Portal for more information.
The following conditions apply when this mechanism is selected:
l The application server must be on the same domain as the SAP portal server.
l Cookies must be enabled on the client browser.
To enable single sign-on access:

2. Select Single Sign-On with User ID and Password as the authentication mechanism.
3. In the wizard navigation panel, click Credentials to set the credential source from the iView.
4.3.4 Single Sign-on with Logon Tickets

The user is issued an SSO2 ticket after successful authentication on the SAP server. SSO2 is stored in
the cookie, and supplies access to the application using single sign-on. The cookie value is MYSAPSSO2.
The following conditions apply when the Single Sign-On with Logon Tickets mechanism is selected:
l The SAP system and SAP portal are configured to accept logon tickets.
l The application server is on the same domain as the SAP portal server.
l Users have the same user ID in all SAP systems that are accessed using SSO with logon tickets.
l Cookies are enabled on the client browser.
Refer to the "Using X.509 Client Certificates" article in the SAP Portal for more information on using
single sign-on with logon tickets.
To enable single sign-on access:

2. Select Single Sign-On with Logon Tickets.
3. In the wizard navigation panel, click Authentication Source to set the authentication server con-
nection.
Nakisa Inc. 28
4 Security Settings
4.3.5 Anonymous Access

When the authentication mechanism is set to Anonymous, users accesses the application in anonymous
mode without providing any form of authentication. This mechanism is used for testing purposes or if the
company wishes to make anonymous content available through the Internet on an external portal.
Refer to the "Using Anonymous Logon to Access the Portal" article in the SAP Portal for more inform-
ation.
To enable anonymous access:

2. Select Anonymous as the authentication mechanism.
3. Click Finish, then click Submit.
4.3.6 Setting iView Credentials

The default values in the Credentials form correspond to the iView content supplied by Nakisa, and are
typically retained.
Note: The Credentials wizard step is only configured for the Single Sign-on with User ID and Password
authentication method.
To set the credentials:

1. In the menu panel, click Security Settings > Credentials.
2. If no changes were made to the iView, then leave the default values and skip to step 4.
3. If changes were made to the iView, set the required values:
a. Select the required Source. Credentials are typically transmitted to the server over the HTTP
connection using HTTP POST or HTTP GET.
b. Enter the Parameter name that holds User ID. The parameter used in SAP connection strings
is user.
c. Enter the Parameter name that holds Password. The parameter used in SAP connection
strings is passwd.
4. Click Authentication Source to set the authentication server connection.
4.3.7 Setting the Authentication Source

To authenticate users when they log in, set the server connection that hosts the user directory service
and specify where user information is stored using the Authentication Source form.
The following authentication methods use the SAP system to grant application access to users:
l Logon Screen
l Single Sign-on with User ID and Password
l Single Sign-on with Logon Tickets
29 www.nakisa.com
To set the SAP authentication source:
2. Click Authentication Source to load the wizard.
3. Enter the full SAP Application Server Host name (for example, SAPONE.dev.nakisa.net).
This value is used for the ASHOST attribute in the connection string.
4. Enter the appropriate SAP System Number. This value is used for the SYSNR attribute in the con-
nection string.
5. Enter the Client number assigned by SAP. This value is used for the CLIENT attribute in the con-
nection string.
4.3.8 Setting Employee Source

The Employee Source form is used to link employee records from the authentication source to those in
the employee database, and only requires configuration if dynamic org chart rooting (setting a different org
chart root depending on the logged-in user) is required.
To set the employee source

2. Click Employee Source to load wizard.
3. Select the Data Element that contains data from the employee databases. Typically, the default
UserPopulationInfo setting is used.
4. In the Employee Field in Employee Source drop-down list, select the field from the current data
element that contains the unique ID of the employee.
5. Optionally, select the Email Field from the current data element that stores employee e-mail data.
Note: The other fields in the Employee Source form are not used by the application.
4.3.9 Mapping Roles

Roles are used to group employees and assign those groups a specific set of rights and privileges to the
application and sensitive data resources. Roles created in the Nakisa AdminConsole are mapped to exist-
ing roles or user groups defined in the company roles repository. User group/role names must exist in the
data source to use this feature. Map as many existing user groups/roles to a Nakisa role as required.
See About Defining Roles, section 4.2.1 on page 23 for details on securing the application, creating
Nakisa roles, and managing role permissions.
There are two main tasks for mapping roles:
l Configuring the connection to the role repository server.
l Mapping Nakisa roles to those in the role repository.
Both tasks are configured in the Role Mapping wizard step.
The application uses the information entered in the form to read the roles contained in the AGR_USERS
table. The table columns that are read are:
Nakisa Inc. 30
4 Security Settings
l UNAME
l AGR_NAME
l FROM_DAT
l TO_DAT
To connect to the role repository server:

2. Click Role Mapping to load the wizard.
3. Click and enter the Connection String for the SAP data source in the field provided. See Con-
nection String, section 3.1 on page 12 for information about the SAP data connection.
Note: The user in the connection string must have permission to the RFC_Read_Table function,
and have access to the AGR_USERS table.
4. Click Test Connection to ensure the application connects to the SAP server.
The next step is to map Nakisa role to those in the role repository.
To map a role:
1. In the Map User Information to Roles section, select a Nakisa Role from the drop-down list.
2. In the New Mapping field, select the SAP role from the drop-down list.
3. Click Add. The role is added to the Mappings defined for role list.
4. If required, select the check box next to the SAP role name to remove the role from the Nakisa role.
5. Click Finish> Submit.
4.4 Confirm and Submit Settings

Confirm the changes and save them to memory once all configurations are complete. Changes must be
submitted before publishing or they will be lost.
To submit your changes:

1. Do one of the following to navigate to the Confirm page of the configuration wizard:
l Click Finish in the bottom right of the wizard.
l Click Confirm in the wizard navigation list.
2. On the Confirm page, click Submit. The changes are saved to memory.
4.5 Communication Channel Encryption

It is possible to encrypt all communication channels between the client Web browser, the Web server,
and the back-end data systems. In order to implement this level of security, enable HTTPS protocol on
the Web server to encrypt traffic between the client Web browser and the Web server. For details on
HTTPS encryption, please consult your Web server documentation.
To encrypt data from the Web server and the back-end data system, consult the documentation for your
data server for details.
31 www.nakisa.com
The applications also use the Secure Network Communications (SNC) with SAP systems. Please see
http://help.sap.com/saphelp_nw70/helpdata/en/e6/56f466e99a11d1a5b00000e835363f/content.htm for
more information.
Nakisa Inc. 32
5 Application-wide Settings
5
Learn about the general settings that are used throughout the application.
5.1 Configuring General Settings 34

5.2 Defining Print and Export Settings 34
5.3 Managing Validations 36
5.3.1 About Managing Validations 36
5.3.2 Adding a Simple Validation 36
5.3.3 Adding a List Validation 38
5.3.4 Adding a DB List Validation 39
5.3.5 Adding a Popup Validation 40
5.3.6 Adding an Auto-Complete Validation 42
5.3.7 Adding an Auto-Complete Popup Validation 43
5.3.8 Editing Validations 44
5.4 Customizing Error Messages 45
5.5 Using Caption Editor 45
5.6 Exporting and Importing Captions 46
5.7 Using the Admin Activity Manager 47
5.8 Enabling Org Chart Box Notes 48
5.9 Resource Bundle Configuration 49
5.1 Configuring General Settings

The General Settings setup wizard is used to configure the following areas of the application interface:
l Portrait images: Sets the directory path and file extension (GIF or JPG) for the employee portraits.
These images appear in the Details panel when users access employee records.
Warning: Portraits must be in portrait orientation.
l Company logo: Sets the company logo image for the Basic-mode (HTML) print and export page
header.
To configure General Settings:

1. In the menu panel, click Application-wide Settings > General Settings.
2. Set up the portrait images:
a. Enter the Portraits Path to the folder that stores the image files. Employee portraits are stored
as separate files in a folder under the main application directory. [application directory]
/images/Portraits is the default folder path.
b. Select GIF or JPG as the Portraits Image Extension type corresponding to the image files if the
data source does not contain a field linking employees to their portraits.
The application adds the specified extension to the field value used for the portraits. For
example, if employee portraits are saved in GIF format using their ID, the application adds the
GIF extension to the ID value and displays the image stored in the specified portraits path. In this
case, the ID field is defined as the portraits field when configuring the Details panel.
c. Select None if the data source contains a field linking employees to their portrait files.
3. Enter the folder path and file name of your Company Logo Image. This folder must be under the
main application directory.
Note: Nakisa recommends using GIF images that are no larger than 150 x 150 pixels for the com-
pany logo.
The fields Company Title and Company URL are not currently used in the User Console. You do
not need to set these fields.
4. Click Submit to temporarily store the settings in the browser session memory.
5.2 Defining Print and Export Settings

The Print/Export Preferences form provides various settings for printing and exporting data from the applic-
ation.
Use this form to:
l Set the default paper size and orientation for ChartBooks and both print wizards—Enhanced-mode
(Flash) and Basic-mode (HTML).
l Define the paper formats available for printing in the Enhanced-mode print wizard and ChartBook wiz-
ard.
l Select a default print and ChartBook template for each org chart.
l Select a global default print template for the Enhanced-mode print wizard.
34 www.nakisa.com
l Define header and footer text that is displayed on each printed page. This feature applies to the Basic-
mode print wizard only.
l Enable or disable the various export formats for org charts and listings.
To set print and export settings:

1. In the menu panel, click Application-wide Settings > Print / Export Preferences.
2. Configure the Default Print / Export Settings for the print wizards and ChartBook.
Note: If a template is in use, the default paper format is specified by the template.
3. Define the available Print Paper Formats for the Enhanced-mode print wizard and ChartBook:
a. To edit an existing format, click next to the required format, modify the parameters, then click
.
b. Reorder the paper formats with the Order drop-down menus. A value of "1" will move that paper
format to the top of the paper format list in the Enhanced-mode print wizard.
c. To delete an existing format, click next to the required format.
d. To add a paper format, enter the Name, Height, and Width in the fields below the table, then
click Add.
4. Configure the Default Org Chart Print/Export Template:
a. Select the Default Template from the drop-down list. Note that if you have added additional
Flash print and export templates, they cannot be selected as the default template.
b. To delete a template, select a template from the Delete Existing Template drop-down list, then
click Delete.
5. If required, define a default print template for each org chart:
a. In the Override Templates for Individual Org Charts section, click next to the org chart
whose default print and export template you want to change.
b. In the Print/Export Template column, select the new default template from the drop-down list,
or select Use Default Org Chart Print/Export Template to use the default template specified
in the Default Org Chart Print/Export Template section.
c. Click .
6. Define the Disclaimer Area text for the HTML print and export wizard:
a. Select Enabled to activate the disclaimer for the header (Top).
b. Enter the Disclaimer Area Height. The unit of measure is defined in step 2. The height is meas-
ured from the top of the page for headers, and from the bottom of the page for footers. Text
appears on the first line in the defined area.
c. Enter the Disclaimer Area Text for the header. Click if the application is configured in mul-
tiple languages, enter the translated text for each language, then click to accept the changes.
d. Align the header (Top) Left, Center, or Right.
e. Click to preview the disclaimer.
f. Set up the Bottom (footer) disclaimer area. This disclaimer is set up using the same procedure
as the header.
7. Configure the Export Settings (applies to both HTML and Flash print wizards):
a. Under Export Settings - Chart, enable or disable one or more export options to allow users to
export org charts in the specified format.
Nakisa Inc. 35
b. Under Export Settings - Listings, enable or disable one or more export options to allow users to
export listings in the specified format.
8. Click Submit to store the settings in the browser session memory.
5.3 Managing Validations
5.3.1 About Managing Validations

In the User Console, users can input data in listing search fields and in edit form fields (if applicable). The
Manage Validations module allows the administrator to create or modify validations that are used to
ensure that users enter correct values in these fields.
The following validation types are available:
l Simple: Allow the user to enter a text string, while restricting the valid characters and the length.
l List: Display a list of fixed values in a drop-down list.
l DB list: Display a list of values populated from a data element in a drop-down list.
l Popup: Allow the user to search for the field value via a selector listing.
l Auto-complete: Search for matching words as the user is typing, and display suggested matches in a
drop-down list.
l Auto-complete popup: Search for matching words as the user is typing, and display suggested
matches in a drop-down list, as well as allow the user to search for the field value via a listing.
l Date: Specifies the validation for date fields.
Note: Date-type validations are used by the application and should not be modified (except for the
description field).
See also:
l Adding a Simple Validation, section 5.3.2 below
l Adding a List Validation, section 5.3.3 on page 38
l Adding a DB List Validation, section 5.3.4 on page 39
l Adding a Popup Validation, section 5.3.5 on page 40
l Adding an Auto-Complete Validation, section 5.3.6 on page 42
l Adding an Auto-Complete Popup Validation, section 5.3.7 on page 43
l Editing Validations, section 5.3.8 on page 44
5.3.2 Adding a Simple Validation

Add a simple-type validation to the application. For this type of validation, the value entered by the user is
the value passed to the application.
To add a simple validation:

1. In the menu panel, click Application-wide Settings > Manage Validations.
2. Click Create a new validation. The General Information wizard step loads.
3. Enter the Validation Name.
36 www.nakisa.com
4. Optionally, enter a Description for the new validation.
5. In the Validation Type drop-down list, select "simple".
6. Click Next to load the Validation Configuration wizard step.
7. Select a Control Stylesheet from the drop-down list, which determines what the field looks like. The
CSS classes are defined in files located in [application directory]/_Themes and
[application directory]/_ThemesRTL (for right-to-left languages).
8. Select a Control Type from the drop-down list to determine whether the field is just a text box or a lar-
ger text area. Note that if this field is not set, the default value is "textbox".
9. Select the Min length and Max length for the entered value. To have an unspecified minimum
length, set the field to "-1".
10. Add Valid or Invalid Characters for the entered value if you have not specified a regular expression.
Any character that is not in the valid character list is considered to be invalid, and any character that
is not in the invalid character list is considered to be valid. Note that you should not add the same
character to both lists.
a. Enter a text character in the field provided, then click Add Character.
b. Select a text character from the list, then click Remove Selected Character, if required.
Note: If you configure a regular expression as well as valid or invalid characters, the regular expres-
sion has precedence and the application uses it to validate the input.
11. If required, create a regular expression. A regular expression can be used to specify a certain format
for an input field, such as for an e-mail address field.
a. Enter the Regular Expression syntax.
b. Enter the Regular Expression Caption that describes what the syntax is enforcing.
c. Enter the Regular Expression Error Message. This is the error message that displays to users
when the validation fails based on the regular expression.
d. Click to expand the language fields, enter the translated caption and error message for each
language, then click . Complete this step if the application is configured in multiple languages.
Refer to the Microsoft Developer Network article "Regular Expression Syntax (Scripting)" for details
about creating regular expressions.
12. If required, add an Extra Info by clicking Add New, then entering values for the Key and Value
fields. These fields allow you to add additional functionality, and is reserved for advanced users only.
Contact your implementation partner for more information.
13. Click Next to load the Selection Values wizard step. No configuration is required in this wizard step
for simple validations.
Nakisa Inc. 37
5.3.3 Adding a List Validation

Add a list-type validation, which is displayed as a drop-down list of static values. For this type of val-
idation, the unique hidden (or code-type) value passed to the application and the captions for those values
must be defined.
To add a list validation:

5. In the Validation Type drop-down list, select "list".
6. Click Next.
7. In the Validation Configuration wizard step, the fields are used to validate the List Values (entered in
the next step). These values are the unique hidden values that are passed back to the application.
Enter the required fields as follows:
l Select a Control Stylesheet from the drop-down list, which determines what the field looks like.
The CSS classes are defined in files located in [application directory]/_Themes and
l Leave the Control Type field empty.
l Select the Min length and Max length for the List Values. To have an unspecified minimum
l Add Valid or Invalid Characters for the List Values if required. Any character that is not in the
valid character list is considered to be invalid, and any character that is not in the invalid character
list is considered to be valid. Note that you should not add the same character to both lists.
Note: If you configure a regular expression as well as valid or invalid characters, the regular
expression has precedence and the application uses it to validate the input.
l If required, create a regular expression. A regular expression can be used to specify a certain
format for an input field, such as for an e-mail address field.
c. Enter the Regular Expression Error Message. This is the error message that displays to
users when the validation fails based on the regular expression.
d. Click to expand the language fields, enter the translated caption and error message for
each language, then click . Complete this step if the application is configured in multiple
languages.
Refer to the Microsoft Developer Network article "Regular Expression Syntax (Scripting)" for
details about creating regular expressions.
38 www.nakisa.com
l If required, add an Extra Info by clicking Add New, then entering values for the Key and Value
fields. These fields allow you to add additional functionality, and is reserved for advanced users
only. Contact your implementation partner for more information.
8. Click Next to load the Selection Values wizard step, and enter the required fields as follows:
l Select the Allow Null checkbox if you want to have an empty value in the drop-down list.
Warning: If this field is enabled, the Min Length field in the previous step must be set to 0.
l Create the list values:
a. In Selection Values, click Add New to add list items.
b. Click and enter the List Value for the list item, which is the value passed to the applic-
ation.
c. Enter the captions for each list item in the language fields. The captions are displayed in the
drop-down list in the User Console.
d. To remove list items individually, click , or click Remove All to remove all items.
5.3.4 Adding a DB List Validation

Add a DB list-type validation, which is displayed as a drop-down list of values from the database. For this
type of validation, both the unique hidden (or code-type) value passed to the application and the captions
for those values come from the database.
To add a DB list validation:

5. In the Validation Type drop-down list, select "dblist".
6. Click Next.
7. In the Validation Configuration wizard step, the fields are used to validate the values from the data-
base for the Value Field (entered in the next step). These values are the unique hidden values that are
passed back to the application. Enter the required fields as follows:
l Select the Min length and Max length for the hidden values from the database. To have an
unspecified minimum length, set the field to "-1".
l Add Valid or Invalid Characters for the hidden values from the database, if required. Any char-
acter that is not in the valid character list is considered to be invalid, and any character that is not
in the invalid character list is considered to be valid. Note that you should not add the same
Nakisa Inc. 39
character to both lists.

languages.
l Select the Data Element used to retrieve the values from the database.
l For the Value Field, click to select the field whose unique values are used in the application,
and click OK.
l For the Caption Field, click to select the corresponding field whose values are displayed in
the drop-down list in the User Console, and click OK.
l Select the Allow Null checkbox if you want to have an empty value in the drop-down list.
Warning: If this field is enabled, the Min Length field in the previous step must be set to 0.
l Field Dependencies cannot be configured via the Nakisa AdminConsole for this application.
5.3.5 Adding a Popup Validation

Add a popup-type validation, which is displayed as a non-editable text box with the icon that opens a
listing (selector). For this type of validation, the unique hidden (or code-type) value is passed to the applic-
ation (i.e. the hidden value associated to the captions displayed in the drop-down list).
To add a popup validation:

40 www.nakisa.com
5. In the Validation Type drop-down list, select "popup".
6. Click Next.
7. In the Validation Configuration wizard step, the fields are used to validate the unique hidden values
passed to the application after a record is selected from the selector listing. Enter the required fields
as follows:
l Select the Min length and Max length for the values passed to the application. To have an unspe-
cified minimum length, set the field to "-1".
l Add Valid or Invalid Characters for the List Values if required. Any character that is not in the
languages.
l Select the Selector listing to use for this popup validation.
l Select the Return Set, which determines which fields are displayed in the text box once a listing
record is selected. Note that the return set is not the fields that are passed back to the application.
Nakisa Inc. 41
5.3.6 Adding an Auto-Complete Validation

Add an auto-complete-type validation, which is displayed as an editable text box. Once the user enters a
certain amount of characters, the application generates a drop-down list of suggested matching values.
This type of validation is commonly used for search fields in the listings.
For this type of validation, the value entered into the text box is the value used by the application to gen-
erate the list of suggested values. The fully entered or selected value is the value passed to the applic-
ation.
To add an auto-complete validation:

5. In the Validation Type drop-down list, select "autocomplete".
6. Click Next.
7. In the Validation Configuration wizard step, the fields are used to validate the value entered by the
user in the text box. Enter the required fields as follows:
l Select the Min length and Max length for the entered value. To have an unspecified minimum
l Add Valid or Invalid Characters for the entered value, if required. Any character that is not in the
languages.
42 www.nakisa.com
l Select the Data Element that determines which table is searched in the database to populate the
drop-down list of suggested values. If this validations is used for a search field in a listing, then
this data element should be the same one used for the listing. If a different data element is used,
the field names must be the same in both data elements.
l Set the Max Number of Records, which determines the maximum number of suggested records
in the drop-down list.
l Set the Min Number of Characters, which determines how many characters the user must enter
before the suggested values are shown.
5.3.7 Adding an Auto-Complete Popup Validation

Add an auto-complete popup-type validation, which is a combination of the auto-complete validation and
the pop-up validation. Fields with this validation are displayed as an editable text box with a generated
drop-down list of suggestions once the user enters a certain amount of characters, as well as the icon
that opens a listing (selector).
For this type of validation, the return set specified for the selector listing determines which fields are dis-
played in the text box once a record is selected. The return set also determines the fields that are dis-
played in the suggested list of values when a value is entered into the text box. The unique hidden (or
code-type) value associated to the record (and not the return set) is passed to the application.
Auto-complete popup validations are commonly used for edit forms (i.e. writeback forms).
To add an auto-complete validation:

5. In the Validation Type drop-down list, select "autocompletepopup".
6. Click Next.
7. In the Validation Configuration wizard step, the fields are used to validate the hidden value asso-
ciated to the record selected. Enter the required fields as follows:
l Select the Min length and Max length for the hidden value. To have an unspecified minimum
l Add Valid or Invalid Characters for the hidden value, if required. Any character that is not in the
Nakisa Inc. 43
languages.
l Select the Data Element that determines which table is searched in the database to populate the
drop-down list of suggested values. Note that this data element should be the same one used for
the selector listing. If a different data element is used, the field names must be the same in both
data elements.
l Select the Search Fields, which are the fields used to search the database to populate the sug-
gested auto-complete drop-down list. Note that the fields actually displayed in the drop-down list
are determined by the Return Set field.
l Set the Max Number of Records, which determines the maximum number of suggested records
in the auto-complete drop-down list.
l Set the Min Number of Characters, which determines how many characters the user must enter
before the suggested values are shown in the auto-complete drop-down list.
l Select the Selector listing to use for the popup in this validation.
l Select the Return Set, which determines which fields are displayed in the text box once a listing
record is selected, and the fields that are displayed in the auto-complete drop-down list. Note that
the hidden fields (and not the return set fields) are the ones that are passed back to the applic-
ation.
Tip: The Search Fields should be included in the return set, otherwise the value entered in the
text box will not appear as one of the fields in list of the suggested values.
5.3.8 Editing Validations

Edit an existing validation.
44 www.nakisa.com
Warning: The validations with "date" and "string" in their names are used by the application, and should
not be modified (except for the description).
To edit a user-input or fixed-list validation:

2. Under Manage Validations, select the validation that you would like to view or modify.
Tip: To modify just the description, click to edit the desired validation, modify the description, and
click Apply Changes.
3. Click View/Modify Selected Item. The edit form loads in the wizard.
4. Perform the tasks provided in one of the following sections, depending on the validation type, to edit
the required fields:
l Adding a Simple Validation, section 5.3.2 on page 36
l Adding a List Validation, section 5.3.3 on page 38
l Adding a DB List Validation, section 5.3.4 on page 39
l Adding a Popup Validation, section 5.3.5 on page 40
l Adding an Auto-Complete Validation, section 5.3.6 on page 42
l Adding an Auto-Complete Popup Validation, section 5.3.7 on page 43
5. Click Finish, then Submit.
5.4 Customizing Error Messages

Administrators can write error messages and may provide a phone number or an e-mail address for users
to contact in case of a problem.
To customize the error message:

1. In the menu panel, click Application-wide Settings > Configure Error Messages.
2. Enter the Error Heading.
3. Enter the Error Message Line. Three lines are provided.
4. Click to expand the language fields, enter the translated error heading and message line for each
language, then click . Complete this step if the application is configured in multiple languages.
5.5 Using Caption Editor

Use the Caption Editor to change captions displayed in the User Console in one or more languages. All
application captions are stored in XML files located in the Languages folder of the main application dir-
ectory. Language files contain caption keys that define where that caption is displayed in the application.
Any captions that are modified are stored as custom captions in the AdminCustom.xml language file.
Note: Caption keys cannot be modified.
Nakisa Inc. 45
To change application captions:

1. In the menu panel, click Application-wide Settings > Caption Editor.
The editor loads in the interface and displays a table of all application captions in the available lan-
guages with their respective language keys.
2. If needed, select the correct caption category from the Choose Category drop-down menu. This
sorts the caption by type and displays only the type selected.
3. If required, modify the display settings of the editor:
a. To change the vertical size of the text boxes, select the TextArea checkbox, enter the number of
vertical Lines. Click anywhere outside the text box to refresh the display.
b. To change the horizontal size of the text boxes, click the Chars field and enter the text box width
in characters.
c. Select the Custom Captions Only checkbox to display modified captions only. Any captions
that are modified in other wizards, such as listing or org chart captions, are included in the cus-
tom captions.
d. Select the number of Entries Per Page from the drop-down menu in the top-right corner of the
page.
e. Click the arrow icons at the bottom-right corner of the page, or select a Page number to view addi-
tional entries.
4. To search for a specific caption, type a term in the Enter Search text box and click Search. The
application displays entries containing the search term in any language. Click Reset to display all lan-
guage entries.
5. To discard all caption changes made in the current session, click Reset Changes.
Note: Captions are reset to the values they had the last time Submit was clicked.
6. Click Submit > Publish.
5.6 Exporting and Importing Captions

Export or import captions using a comma-separated values (CSV) file to modify captions in other applic-
ations, such as Microsoft Excel. Captions are exported to the LanguageCaptions.csv file in UTF-8
format to support special character sets in multiple languages. The LanguageCaptions.csv file is
saved in the [application directory]/.system/Admin_config/[build workspace] dir-
ectory. A copy of the same file is also saved in the LanguageCaptions.zip file found in the same dir-
ectory.
Note: As CSV files use commas (,) to separate values, any commas contained in captions are exported
as ,. Similarly, when modifying captions in another application, ensure that , is used for
any commas to be displayed in the application, otherwise the file cannot be imported into the Nakisa
application.
Exporting Captions
To export application captions:
1. In the menu panel, click Application-wide Settings > Caption Editor. The editor loads in the inter-
face and displays a table of all application captions in the available languages with their respective
46 www.nakisa.com
language keys.
2. Modify any required captions using the editor.
3. To export only modified captions, select the Custom Captions Only checkbox. Otherwise, all cap-
tions are exported.
4. Click Generate CSV. The LanguageCaptions.csv file is created in the [application
directory]/.system/Admin_config/[build workspace] directory.
5. Click the Download link to open or save the CSV file to a location of your choosing.
Note: Although the CSV file is updated every time you click Generate CSV, the Download link is not
refreshed; consequently, the link will open the first CSV file generated in the current session. If you have
already exported a CSV file and then make additional caption changes in the same session, publish the
build, close the browser, and access the Nakisa AdminConsole before exporting the new changes.
Importing Captions
To import application captions:
1. In the menu panel, click Application-wide Settings > Caption Editor. The editor loads in the inter-
face and displays a table of all application captions in the available languages with their respective
language keys.
2. Click Browse, then locate the CSV file to import.
3. Click Import from CSV. The captions are updated in the editor.
4. Modify any required captions using the editor.
5.7 Using the Admin Activity Manager

The Admin Activity Manager provides Nakisa Master Administrators with enhanced security functionality
and oversight. It allows these administrators to track changes made within the AdminNakisa AdminCon-
sole, including tasks such as logging in, uploading new content, resets to the build, and monitor other
tasks. Master Administrators can enable the logs, determine which activities to log, view the logs in the
Nakisa AdminConsole, and export the log activity to an Excel spreadsheet for additional analysis.
To enable logging and encrypt the logs:

1. Click in the Enable Admin Console Activity Logging checkbox to enable logging.
2. Click in the Encrypt Log Entries checkbox to encrypt the log files.
To use the Admin Activity Manager:

1. Click Select Activities to Log.
2. Select the Admin Console activities you want written to your logs (login, save, upload content, etc.)
and click OK.
To export a log file:

1. Select the log file you want to export from the drop down menu.
2. Click Export to Excel.
Nakisa Inc. 47
To view the logs in the Nakisa AdminConsole:

Scroll through the logged activity using the First, Previous, Next, and Last navigation buttons, as appro-
priate.
5.8 Enabling Org Chart Box Notes

Notes can be added to any box in the org chart to attach additional information, as well as in the audit run
and error Details panels. Notes can be public (visible to any user) or private (visible only to the user who
added it).
Note: Enabling org chart box notes may have an impact on overall application performance.
To enable notes:
1. In the menu panel, click Application-wide Settings > Notes > Enable/Disable Notes.
2. Select one of the available options to enable or disable some or all types notes.
3. Click Finish > Submit > Publish.
In addition to selecting the type of notes to enable, a database to store the notes must be set up.
Note: The data connection name used for the storing notes is displayed in bold above the database para-
meters. Note that this data connection cannot be configured via the Data Center.
To create a notes database:

1. In the menu panel, click Application-wide Settings > Notes > Data Connection.
2. Select the Server Type, then enter the Server Name that hosts the staged database.
For Oracle databases, use one of the following syntaxes to enter the Server Name:
l Server name/service name
For example: PRODSRV/ORA92 where PRODSRV is the server name and ORA92 is the service
name.
l Fully qualified server name/port number/SID
For example: ora92.hq1.nakisa.net:1521:ora92
l IP address/port number/SID
For example: 192.168.0.148:1521:ora92
l TNS entry name
For example: ORA92.HQ1
Note: If the TNS entry name is used, the oracle.net.tns_admin system property in your
environment must be set to the location of the TNSNAMES.ORA file, typically found in the
[ORACLE_HOME]/network/admin directory.
3. Enter the Initial Catalog to specify the database name for the staged database. Skip this step for
Oracle databases.
4. Enter the User Name and Password for the database.
5. Click Test Connection. A message indicates whether the connection was successful.
48 www.nakisa.com
6. Click Recreate Structure.
Warning: Recreate Structure re-initializes the specified database and clears the data in the table.
This action is only used once after the application is deployed.
7. Click Next > Submit > Publish.
5.9 Resource Bundle Configuration

Resource bundles are user-defined conditions that allow you to map fields to text, images, and colors via
sets of mapping rules. Resource bundles are defined in one place in the Nakisa AdminConsole, and can
then be used in different places in the application (such as the Details Designer).
For example, resource bundles can be used to:
l Map numeric severity levels to textual severity levels.
l Map ranges of IDs to different image icons.
l Map male and female fields to different image icons.
l Map certain fields to colors using mathematical formulas to filter out unwanted values.
To determine which output value to use, the resource bundle input value is matched against the Match
Type and Map Key fields in the mapping rules. These fields can be combined in the following ways:
Match Type Map Key Matching Function

Exact Plain text There is a match if the input value exactly matches one
of the Map Key values.
Starts With Plain text There is a match if the input value starts with one of the
Map Key values.
Ends With Plain text There is a match if the input value ends with one of the
Map Key values.
Contains Plain text There is a match if the input value contains one of the
Map Key values.
Less Than Integer There is a match if the input value has a smaller value
than one of the Map Key values.
Greater Than Integer There is a match if the input value has a greater value
than one of the Map Key values.
Wildcard Wildcard pattern There is a match if the input value matches the wildcard
entry. Use the wildcard character "*" to match zero or
more characters, and the question mark "?" to match a
single character.
For example, if the wildcard pattern is th*, then any
input values that start with "th" are matches (such as
"the" and "there"). If the wildcard pattern is h?t, then
input values such as "hot", "hit", and "hat" are matches.
Nakisa Inc. 49
Match Type Map Key Matching Function

Range Numeric Range The syntax for numeric ranges is composed as follows:
l The leading inclusive indicator: Use "]" to include the
start value, or use "[" to exclude the start value.
l The numeric range: Enter a numeric range in the
format n-m (where n and m are integers).
l The ending inclusive indicator: Use "]" to include the
end value, or use "[" to exclude the end value.
For example, if the numeric range is ]100-105], then it
is a match if the input values are 101, 102, 103, 104, or
105.
Range Text Range The syntax for text ranges is composed as follows:
l The leading inclusive indicator: Use "]" to include the
start value, or use "[" to exclude the start value.
l The text range: Enter a text range in the format x-y
(where x and y are characters).
l The ending inclusive indicator: Use "]" to include the
end value, or use "[" to exclude the end value.
For example, if the text range is ]AG-BB], then it is a
match if the input values are greater than AG and smaller
than or equal to BB, such as AGA, AGB, AH, AI, AZ, BA,
BAA, and BB (but not BBA).
Note: If there is more than one matching rule, then the application picks the first matching rule in the
table.
To add a new resource bundle:

1. In the menu panel, click Application-wide Settings > Resource Bundle Configuration. The
resource Bundle Configuration page loads, and any existing resource bundles are listed on the page.
If no resource bundles have been added, the bottom portion of the page is blank.
2. Enter a Resource Bundle Name. Note that only letters and numbers should be used; do not use spe-
cial characters or spaces.
3. Select the required Resource Bundle Type:
l General: To map fields to text.
l Image: To map fields to images.
l Color: To map fields to colors.
4. Click Add New Resource Bundle. The resource bundle is added to the list in the bottom portion of
the page.
5. Click or the resource bundle name to expand the newly-created resource bundle.
6. To add a new mapped value, enter the following information:
l Caption: Enter a description for the mapping rule.
l Match Type: Select how the resource bundle input field is matched to the Map Key.
50 www.nakisa.com
l Map Key: Define the value or pattern that is matched against the resource bundle input field. Spe-
cific mapping keys should be used with specific matching types; refer to the previous table for
more information.
Note: The Map Key is case-sensitive.
Tip: To map a null value, verify whether the value returned from the data element is "null" or
empty. If the returned value is "null", enter null as the Map Key; if the returned value is empty,
leave the Map Key field blank.
l Map To: Define the value that is outputted when the input field matches the rule.
l For "general" resource bundles: Enter a text value.
l For "image" resource bundles: Enter the path to the image, starting after the [application
directory] folder. For example, images/country/flg_ca.gif.
Note: The supported image formats are JPG, PNG, and GIF.
l For "color" resource bundles: Enter the HTML color code, such as #FF0000 for red.
Tip: Set this field to {value} to output the original resource bundle input value.
7. Click Add.
8. Enter the Default Value, which is used when the resource bundle input field does not match any of
the mapping rules. Set this field to {value} to simply output the original resource bundle input value.
9. If no more changes are required for the resource bundles, click Submit.
10. Publish the build if no other changes in the application are required.
To modify resource bundles:

1. In the menu panel, click Application-wide Settings > Resource Bundle Configuration.
2. To edit the available resource bundles, click on one of the following options:
l Expand All or Collapse All: To expand or collapse the panels for all of the resource bundles.
l or : To expand or collapse the panel of one of the resource bundles.
3. To edit an existing mapping rule, click , and modify the required fields. Click or to accept or
reject the changes.
4. To delete a mapping rule, click .
5. Add new mapping rules if required.
6. When no more updates are required, click Submit.
7. Publish the build if no other changes in the application are required.
Nakisa Inc. 51
6 Debug Tools
6
Learn about the debugging tools that are used throughout the application.
6.1 Debug Tools Overview 53

6.2 Viewing and Exporting System Information 53
6.3 Log Manager 54
6.4 Network Diagnostic 54
6 Debug Tools
6.1 Debug Tools Overview

The Debug Tools menu in the Admin Console gives you access to a number of diagnostic and logging fea-
tures that help you monitor and maintain your Nakisa applications.
See the following for more information:
l RFC Trace
l System Information
l Log Manager
l Network Diagnostic
6.2 Viewing and Exporting System Information

System information is available to view important information about the build, connections and computer
in use. The available information includes:
l Product name, release, and build number
l License type, name, and expiry date
l Available and enabled languages
l Security settings
l Hardware specifications
l Java properties
l Tables displaying information about the ABAP Add-ons and Transport Packages installed on the
SAP server (requires a valid SAP connection string).
In addition to viewing system information, error logs and system information can be exported. Note that
the error logs can be exported on their own.
To view and export logs and system information:

1. In the menu panel, click Debug Tools > System Information.
2. In order to view ABAP Add-on and Transport Package information, a valid SAP connection string is
required.
This wizard requires a complete connection string. For security reasons, the [USER] and [PASSWD]
attributes may not be defined in the connection string. If [USER] and [PASSWD] are omitted, enter
the User Name and Password in the Temporary Credentials section of the SAP Connection Val-
idator dialog box. This way, the user name and password are only stored during the current Nakisa
AdminConsole session, and not permanently saved in the connection string. The dialog box can also
be used to enter a permanent connection string if none was previously provided.
3. The ABAP Add-on and Transport Package tables include a predefined filter to display only Nakisa-
related information. If you need to change the filter, please contact your Nakisa implementation part-
ner.
4. Click Export Logs and System Info at the bottom-right of the screen. The application creates a ZIP
file containing the system information (in HTML format) and the error logs.
5. Click the Download System Info link that appears, then save the file to a location of your choice.
53 www.nakisa.com
6.3 Log Manager
The Log Manager allows users to enable or disable several logs and the logging levels for those logs. For
more information, see Application Log Overview.
6.4 Network Diagnostic

The Network Diagnostic tool checks network settings such as ping rates and browser version to confirm
your network and system environment are optimized to run Nakisa solutions.
To use the Network diagnostic tool:

1. In the menu panel, click Debug Tools > Network Diagnostic.
2. Click Run Network Diagnostic. This opens a new browser window with the results of the network
diagnostic.
Nakisa Inc. 54
7 SAPExtractor
7
Learn how to extract data from the SAP system to a staged RDBMS database using the SAPExtractor.
7.1 SAPExtractor Overview 56

7.2 Setting Up Extraction 56
7.2.1 About Setting Up Extraction 56
7.2.2 SAP Source Connection 56
7.2.3 Destination Database 57
7.2.4 Table Details 57
7.2.5 Keywords 58
7.2.6 Table Fields 59
7.3 Starting Extraction 59
7.4 Scheduling Extractions 60
7 SAPExtractor
7.1 SAPExtractor Overview

To perform audit runs, the staged database must first be set up with main hierarchy and listing information
extracted from the SAP source using the SAPExtractor. For all the steps required to set up the database,
see Setting Up the Staged Database, section 8.1 on page 64.
Refer to the Environment Checklist for the list of supported relational database management systems
(RDBMS).
Note: For SQL databases, the database must be set up using case-insensitive collation. See the
troubleshooting section Org Chart diagram is missing, section 21.9 on page 222 for more information.
Note: For DB2 databases, the application requires that the size of the primary and secondary transaction
logs be increased. If the DB2 user account assigned to Nakisa OrgAudit does not have administrator priv-
ileges, then the administrator must also manually increase the page size of the system temporary and reg-
ular table spaces to 32 KB. See the troubleshooting section Cannot extract data to DB2 database, section
21.3 on page 218 for more information.
Extraction can be started using the Nakisa AdminConsole, or can be performed at scheduled times using
a command-line extractor.
7.2 Setting Up Extraction
7.2.1 About Setting Up Extraction

SAPExtractor extracts data from an SAP server to a staged RDBMS database. Before starting or schedul-
ing the SAPExtractor, you must first set up the following:
l The connections to the operational SAP server and to the staged destination database.
l The conditions surrounding the data that need to be extracted.
l The fields present in the tables in the staged database.
See also:
l Starting Extraction, section 7.3 on page 59
l Scheduling Extractions, section 7.4 on page 60
7.2.2 SAP Source Connection

This procedure sets the data connection to the SAP data source for SAPExtractor.
Tip: The data connection name used for the SAPExtractor source is displayed in bold under the Con-
nection String heading. The name is retrieved from the corresponding data connections in the Data
Center.
To set the source parameters:

1. In the menu panel, click Configure Staging > Configure SAPExtractor.
Source - SAP loads by default.
56 www.nakisa.com
2. Click to activate the connection string, then enter the connection to the required SAP source
server.
4. Click to accept the changes.
5. Click Next to set the destination database, or click Finish.
7.2.3 Destination Database

Set the connection to the destination database for SAPExtractor.
Tip: The data connection name used for the SAPExtractor destination is displayed in bold at the top of the
database parameters. The name is retrieved from the corresponding data connections in the Data Center.
To set the destination parameters:

2. Click Destination.
name.
For example: 192.168.0.148:1521:ora92
l TNS entry name
Oracle databases.
7. Click Next to set up the table details for the destination tables, or click Finish.
7.2.4 Table Details

Data that is extracted from the operational SAP server is written to tables in the staged destination data-
base. Details about the source and destination tables are provided in the SAPExtractor and are available
for editing, if required.
To specify which fields are populated in the destination tables, refer to Table Fields.
Nakisa Inc. 57
7 SAPExtractor
To edit table details:

2. Click Table Details.
3. Select the Extract checkbox for each table that needs to be extracted.
4. Click to modify the tables for the destination database.
5. Enter the Destination Table name and Description.
6. Select Yes for data that is Critical. SAPExtractor stops the extraction process if a critical table
reports errors.
7. Enter a Condition to filter the data extraction based on different criteria, for example date, language,
or location. To build a condition, use the field names from the SAP tables, relational operators (for
example, >= and >=), and keywords (which must be contained in square brackets). Using keywords
allows you to update many instances of a value from one place.
9. Click Next to define the required keywords, or click Finish.
Note: All of the table extraction details are contained in a file that is updated whenever you update the
table details in the Nakisa AdminConsole. Certain tables cannot be displayed in the interface, and must
be edited directly in the file [application directory]/.system/Admin_Config/[build
workspace]/SAPExtractor/functionConfiguration.xml.
7.2.5 Keywords
Use keywords to facilitate the extraction of specific information from the SAP system, or to update the
staged database. The same keyword can be used in multiple conditions in the Table Details wizard step,
and can then be updated in one place.
To set up or edit keywords:

2. Click Keywords.
3. The keyword DateToday is provided by default. Select one of the following options to specify the
value used by DateToday:
l Select System Date to use the current system date for this keyword. Note that this is the default
option for this keyword.
l Select User Specified Date to specify a different date for this keyword, and enter the date in
yyyyMMdd format .
4. Click to modify a keyword, then enter the required Value.
5. Enter a Description, if required.
7. Click Next to define the table fields used in the extraction, or click Finish.
Refer to the Nakisa OTFSchema Reference Guide for the list of keywords and default values imple-
mented in the application. The Nakisa OTFSchema Reference Guide is only available to Nakisa con-
sultants and partners.
58 www.nakisa.com
7.2.6 Table Fields
The administrator can specify the fields that are displayed in each table in the staged database, and which
SAP table fields they relate to.
To set up the destination table fields:

2. Click Table Fields.
3. Select the required Table Name, which were defined in the Table Details wizard step. The SAP
Table Name and the SAP fields it contains load in the form.
4. Click , then edit the Destination Field Name.
6. To add more fields to the destination table, click Add. When the Add Fields form loads, select the
required fields, then click Add > Done.
7. To remove fields from the destination table, select the checkbox next to the required fields and click
Delete.
8. Click Next or Finish.
7.2.7 Confirm and Submit Settings


7.3 Starting Extraction

Once all the SAPExtractor settings are configured, extract data from the SAP system.
SAPExtractor performs the following tasks during extraction:
l Extracts data from the source and writes it to the tables in the destination database.
l Creates new tables in the destination database, if required.
l Overwrites data stored in an existing destination table.
Details about the process are written to the Admin log on the date when the extraction is performed.
Successful extraction involves two steps:
l Extract the data from the SAP system.
l Execute table joins on the extracted data. Note that you can extract the data and execute the table
joins in the same step.
Nakisa Inc. 59
7 SAPExtractor
To extract data and execute joins:

1. In the menu panel, click Configure Staging > Start Data Extraction.
2. Select Extract data from SAP and Execute joins on extracted data. Executing joins retains the
table joins and relationships contained in the source data.
3. Click Start Extraction. This process may take several minutes.
4. Click Done.
5. If you are extracting data and executing joins for the first time to set up a staged database, you must
also set the hierarchy root ID for the org charts to be displayed properly. See Root Hierarchies, sec-
tion 11.3.3 on page 152 for instructions on how to set the root ID.
Note: You do not need to extract data and execute joins in the same step; they can performed one after
the other. If executing separately, you can extract data multiple times before executing joins, but it is not
recommended to execute joins multiple times after extracting data.
Note: Pressing the Cancel button during the procedure will only cancel actions after that point. Extracted
data and executed joins prior to canceling will be retained.
See also:
l Root Hierarchies, section 11.3.3 on page 152
7.4 Scheduling Extractions

SAPExtractor extracts data from an SAP server to a staged RDBMS database. Run data extractions at
scheduled times using the one of the following executable files:
l For Windows operating systems: [application directory]
/.system/application/ExtractionScripts/Windows/sapextractor.bat
l For Linux operating systems: [application directory]
/.system/application/ExtractionScripts/Linux/sapextractor.sh
Note: The executable files use the configuration settings from the current build, and cannot change the
extractor configurations. Use the SAPExtractor wizard in the Nakisa AdminConsole to change SAPEx-
tractor settings, then publish the build to make those changes available to the executable.
Schedule and run data extractions at off-peak hours using the Windows Scheduled Tasks utility or the
Linux cron utility. Refer to the Windows or Linux documentation for instructions about using the task-
scheduling utilities.
Note: If a folder in your path contains a space and is longer than 8 characters, the name of the folder must
be within double quotations marks. For example, a folder named Program Files must be written as "Pro-
gram Files" in the command line path.
To schedule both staging and audit data extractions, as well as an audit run, see Scheduling Extraction
and Audit Runs, section 8.11 on page 92.
Prerequisites
SAP Java Connector (SAP Jco) version 2.1.8 or 2.1.10 is required to run the command line extractor.
SAP Jco 3.0 is supported for command line extractions. Please contact Nakisa Support for additional
information. Other versions of SAP Jco are not supported.
60 www.nakisa.com
Running the Script
To run the script, the following attributes need to be defined:
Attribute Details
Path to the SAP Java SDK Find this file in the SAP system sapjvm directory.
For example: C:/usr/sap/[NetWeaver host name]
/J00/j2ee/JSPM/sapjvm/jre/bin
Path to the deployed Nakisa Specify the location of the deployed Nakisa application.
application (i.e. the For example: C:/usr/sap/[NetWeaver host name]
[application /J00/j2ee/cluster/apps/[Nakisa]/[EAR name
directory]) without extension]/servlet_jsp/[WAR name without
extension]/root
Build workspace name Specify the build name that matches the name in the
[application directory]/.system/Admin_Config folder.
For example: ___000___SAP_SQL
Path to the SAP Java Con- Specify the location of the sapjco.jar file.
nector (SAP JCo) For example: C:/SAPFile/sapjco.jar
Name of the Depending on the build, there may be a version number or suffix
NakisaFrameworkBinxx.j appended to the NakisaFramework.jar file. To verify the file
ar file name, locate the file in the [application directory]/WEB-
INF/lib directory.
Name of the Depending on the build, there may be a version number or suffix
NakisaTrollBinxx.jar appended to the NakisaTrollBin.jar file. To verify the file
file name, locate the file in the [application directory]/WEB-
INF/lib directory.
Extract data Set to true or false. The extractor extracts data from the SAP
server if the value is true.
Execute joins on extracted Set to true or false.The extractor executes joins to create new
data tables and objects when the value is true.
Generate analytics This field must be set to false for Nakisa OrgAudit because this
parameter only deals with demographic analytics, which are not
used in the application.
The command-line expression to run the sapextractor script with the previously defined attributes
may look as follows (note that the spaces in between each attribute has been highlighted in gray).
In Windows
C:/usr/sap/CE1/J00/j2ee/cluster/apps/Nakisa/OrgChart/servlet_
jsp/OrgChart/root/.system/application/ExtractionScripts/Windows/sapextract
or.bat C:/usr/sap/CE1/J00/j2ee/JSPM/sapjvm/jre/bin
C:/usr/sap/CE1/J00/j2ee/cluster/apps/Nakisa/OrgChart/servlet_
jsp/OrgChart/root ___000___SAP_SQL C:/SAPFile/sapjco.jar
NakisaFrameworkBin061032100 NakisaTrollBin061032100 true true true
Nakisa Inc. 61
7 SAPExtractor
In Linux:
Assign the sapextractor.sh file the permission to execute only once by running the command chmod
+x [application directory]/ExtractionScripts/Linux/apextractor.sh or locate the
file and manually set the owner permissions (read, write, execute), group permissions (read), and public
permissions (read).
sh /usr/sap/CE1/J00/j2ee/cluster/apps/Nakisa/OrgChart/servlet_
jsp/OrgChart/root/.system/application/ExtractionScripts/Linux/sapextractor
.sh /sapmnt/CE1/exe/jvm/linuxx86_64/sapjvm_5.1.024/sapjvm_5/bin
/usr/sap/CE1/J00/j2ee/cluster/apps/Nakisa/OrgChart/servlet_
jsp/OrgChart/root ___000___SAP_Sql /sapmnt/CE1/exe/jvm/linuxx86_
64/sapjvm_5.1.024/sapjvm_5/jre/lib/amd64/server/sapjco.jar
NakisaFrameworkBin061032100 NakisaTrollBin061032100 true true true
Messages at the command prompt describe the extraction progress. Detailed information about the
extraction is contained in the Admin Log file.
Tip: If the data set is large and the extraction seems slow, you can increase the memory size in the
sapextractor script. For example, to change the memory size from 1 GB to 4 GB, change the value -
Xmx1g to -Xmx4g.
For information to schedule the extractor to pull data from the SAP server at a specified time, refer to the
following Web sites:
l Windows: http://www.iopus.com/guides/winscheduler.htm
l Linux: http://ss64.com/bash/crontab.html
62 www.nakisa.com
8 Audit Configuration
8
Learn how configure audit runs in Nakisa OrgAudit.
8.1 Setting Up the Staged Database 64

8.2 Configuring Staged Database Connections 64
8.3 Extracting Audit Data 66
8.4 Creating Template Rules 67
8.4.1 About Creating Template Rules 67
8.4.3 Rule Logic 70
8.4.3.1 About Rule Logic 70
8.4.3.2 Basic Rule Logic Form 70
8.4.3.3 Advanced Rule Logic Form 72
8.4.6 Example Template Rule Creation 75
8.5 Editing Template Rules 79
8.5.1 About Editing Template Rules 79
8.5.2 Select Template Rule 79
8.5.4 Rule Logic 82
8.6 Deleting Template Rules 85
8.7 Adding Rules 86
8.8 Modifying Rules 89
8.9 Running Audits 90
8.10 Managing Audit History and Rules 92
8.11 Scheduling Extraction and Audit Runs 92
8.1 Setting Up the Staged Database

Audit runs are performed on data extracted from an SAP source into a staged database. Whenever a new
staged database is set up, the following procedure must be following to ensure that audit runs can be prop-
erly performed:
1. Set up the staged database by extracting staging data (for example, hierarchy and listing data) from
the SAP source using the SAPExtractor.
2. Recreate the database structure to create required database tables before extracting the audit data.
3. Extract the audit data to the staged database.
Note: If you are using a DB2 database for audit data, perform step 3 before step 2 to ensure the tables are
correctly built.
If you are already using a staged database with your current Nakisa OrgAudit build but need to switch to
another database, you must follow a different procedure to ensure that you do not accidentally transfer
some information to the new database. Follow the procedure specified for this case outlined in Con-
figuring Staged Database Connections, section 8.2 below.
See also:
l SAPExtractor Overview, section 7.1 on page 56
l Configuring Staged Database Connections, section 8.2 below
l Running Audits, section 8.9 on page 90
8.2 Configuring Staged Database Connections

To perform audit runs, the staged database must first be set up with main hierarchy and listing information
extracted from the SAP source using the SAPExtractor. The staged database then requires additional
tables and other changes to the database structure, which is achieved by extracting additional audit data
that will be validated against the audit rules. The audit data is extracted from the same source used with
the SAPExtractor, and shares the same staged database.
If you have already set up a staged database connection but would like to switch the connection to
another database, you must follow a different procedure to ensure that you do not accidentally transfer
some information to the new database. Follow the second procedure outlined below.
Note: For DB2 databases, the application requires that the size of the primary and secondary transaction
logs be increased. If the DB2 user account assigned to Nakisa OrgAudit does not have administrator priv-
ileges, then the administrator must also manually increase the page size of the system temporary and reg-
ular table spaces to 32 KB. See the troubleshooting section Cannot extract data to DB2 database, section
21.3 on page 218 for more information.
Tip: The data connection names are displayed in bold either under the Connection String heading or at the
top of the database parameters. The name is retrieved from the corresponding data connection in the Data
Center.
Note: Refer to the Environment Checklist for the list of supported RDBMS database and versions.
64 www.nakisa.com
To set up the staged database connection for audit extraction:
Note: These fields are already pre-populated when you set up the staged database for the SAPExtractor.
Use the following procedure if you need to modify the data connection, but note that it will also affect the
data connection for the SAPExtractor, org charts, and listings.
1. In the menu panel, click Configure Audit > Configure Audit.
2. The Source - SAP form loads. Click Next to load the Destination form.
Note: The fields in both forms are already pre-populated from when you set up the staged database
for the SAPExtractor. Use the next procedure if you need to modify the data connection, but note that
it will also affect the data connection for the SAPExtractor, org charts, and listings.
3. If required, under Recreate database structure, click Recreate Structure > Yes. All the database
tables needed by Nakisa OrgAudit are created in the destination database. Note that if you are setting
up the staged database for the first time, you must recreate the database structure. You can also
recreate the database structure to clear the database of all results and run a fresh audit run.
Warning: If the staged database already exists, this operation will remove and replace any existing
tables. All of the existing rules and the entire history of errors and audit runs will be permanently
deleted. Also note that if you change the destination database details before clicking Recreate Struc-
ture, the recreate operation will take effect at the new destination, even if you do not submit the
change.
When completed, the application shows the confirmation message Recreating structure
successful.
5. Publish the build. To continue with the staged database setup, start the audit data extraction.
To change the connection to another staged database for audit extraction:

1. In the menu panel, click Configure Audit > Configure Audit. The Source - SAP form loads.
2. Click Destination Database Details, and enter the new staged database connection information.
Select the Server Type, then enter the Server Name that hosts the staged database.
Note: Changes to the connection settings in the Destination step of any of the modules apply glob-
ally (i.e. also applies to the SAPExtractor, org charts, and listings).
name.
For example: 192.168.0.148:1521:ora92
l TNS entry name
Nakisa Inc. 65
Oracle databases.
6. If required, under Recreate database structure, click Recreate Structure > Yes. All the database
tables needed by Nakisa OrgAudit are created in the destination database. Note that if you are setting
up the staged database for the first time, you must recreate the database structure. You can also
recreate the database structure to clear the database of all results and run a fresh audit run.
Warning: If the staged database already exists, this operation will remove and replace any existing
tables. All of the existing rules and the entire history of errors and audit runs will be permanently
deleted. Also note that if you change the destination database details before clicking Recreate Struc-
ture, the recreate operation will take effect at the new destination, even if you do not submit the
change.
When completed, the application shows the confirmation message Recreating structure
successful.
8. Save the build, but do not publish the build.
9. Log out of the and close the browser
10. Open a new instance of your browser and load the Nakisa AdminConsole again. You can now
makeNakisa AdminConsole any other changes required and publish the build. Note that if you are
changing to a new staging database that has not been set up yet, you must now follow the steps out-
lined in Setting Up the Staged Database, section 8.1 on page 64.
See also:
l Setting Up the Staged Database, section 8.1 on page 64
l Managing Audit History and Rules, section 8.10 on page 92
8.3 Extracting Audit Data

Audit runs are performed on the data in the staged database, which is initially set up by extracting staging
data from the SAP source with the SAPExtractor. The audit data required by the template rules must then
be extracted as a separate step using the procedure below. See Configuring Staged Database Con-
nections, section 8.2 on page 64 for information about the source and destination databases connections
for audit data extraction. It is best to extract data before each audit run to ensure that the latest data is
being used.
Note: If this is the first time you set up the staged database, ensure that the main hierarchy and listing
information has already been extracted using the SAPExtractor before you extract audit data.
66 www.nakisa.com
To extract data for audit runs:
1. In the menu panel, click Configure Audit > Start Error Extraction.
2. Under Reading from SAP, select Extract data from SAP and Execute Joins on Extracted Data
to extract audit data from different SAP source tables and join them in the staged database.
3. If required, select Run Audit to run an audit as soon as the data extraction is completed. Note that
audit runs can only be successfully performed if rules have been added. For more information about
audit runs, see Running Audits, section 8.9 on page 90.
4. Click Start Extraction.
A new data set is extracted from the designated SAP source and assembled on the staged server in a
database format required by Nakisa OrgAudit. If you selected Run Audit, then once the staged data-
base is ready, the current rules are applied to it, and a log of the results appears.
Note: Pressing the Cancel button during the procedure will only cancel actions after that point. Extracted
data and executed joins prior to canceling will be retained.
8.4 Creating Template Rules
8.4.1 About Creating Template Rules

In Nakisa OrgAudit, a rule is a structured query that, when applied to a staged database during an audit
run, returns matching results for use in the application. Rules are added based on template rules. Some
standard template rules come included with the application and can be added immediately (see Adding
Rules) but custom template rules must be created by the administrator.
Warning: The Create Template Rules feature should only be used by advanced administrators.
The Create Template Rules wizard is divided into four steps:
l Download SAP Infotype
l Rule Logic
l Default Rules Parameters
l Sync Config
For an example of a new template rule created using the basic form in the Rule Logic step, see Example
Template Rule Creation, section 8.4.6 on page 75.
See also:
l About Editing Template Rules, section 8.5.1 on page 79
l Adding Rules, section 8.7 on page 86
l Modifying Rules, section 8.8 on page 89
8.4.2 Download SAP Infotype

The Download SAP Infotype wizard step allows you to define the SAP source table extraction and out-
put tables required for the new template rule. If the template rule requires data that has already been
extracted for another rule, then you can add the existing source and output tables to the new template
Nakisa Inc. 67
rule. If the table was already extracted for another template rule, but is missing some fields, these fields
can be extracted to the same output table. If the template rule requires new SAP tables or infotypes that
have not already been extracted, new extraction configuration can be set up to extract the information into
output tables in the destination database.
Note that multiple tables can be added to the same template rule.
To download SAP Infotypes:
1. In the menu panel, click Configure Audit > Create Template Rules. The Download SAP Infotype
wizard step loads automatically, allowing you to extract and map SAP infotypes in the destination
database.
2. Select one of the following options:
l Existing extraction configuration: Select this option to re-use source and output tables and
fields that have already been defined for other template rules.
l New extraction configuration: Select this option to define new source and output tables and
fields to extract from the SAP source.
3. To configure advanced fields, select the Advanced Mode checkbox. Configure the following fields in
the General Information section. Note that for existing extraction configuration, certain fields are
read-only because changing these fields could break existing template rules.
l Function Name: The name of the extraction function (for internal use only). The administrator
can leave this field untouched from its defaults.
l Function Description: The description of the extraction function (for internal use only). The
administrator can leave this field untouched from its defaults.
l Encoding: Specifies the character encoding scheme to use when extracting SAP data.
l DLLs:Specifies the SAP processor used to extract data. The available choices are as follows:
l Nakisa.SAP.SAPeProcessor (for use with staged solutions)
l Nakisa.SAP.Custom.OTFProcessor (for use with live solutions)
Note: For Nakisa OrgAudit, this field must be set to Nakisa.SAP.SAPeProcessor.
l Class: Specifies which processor class is used to extract data. This field must correspond to the
chosen DLL field.
l If Nakisa.SAP.SAPeProcessor is selected, you can choose one of the following classes:
l Nakisa.SAP.SAPeProcessor.RfcReadTable (to extract table data)
l Nakisa.SAP.SAPeProcessor.Hrwpc_Rfc_Rp_Read_Photo_Uri (to extract photo URI)
l Nakisa.SAP.SAPeProcessor.TpmTrgReadTableRFC (to extract in SAP's internal
RAW format)
Tip: To determine which class to use, use transaction code SE37 in the SAP GUI to view the
input and output parameters of the function modules that correspond to the classes listed
above (RFC_READ_TABLE, HRWPC_RFC_EP_READ_PHOTO_URI, or TPM_TRG_
READ_TABLE_RF respectively).
l If Nakisa.SAP.Custom.OTFProcessor is selected, choose the Nakisa.SAP.Cus-
tom.OTFProcessor.BAPI_SAP_OTFProcessor_Report_Lite class.
Note: For Nakisa OrgAudit, this field will almost exclusively be set to Nakisa.SAP.SAPePro-
cessor.RfcReadTable.
68 www.nakisa.com
l Row Download Portion: Specifies the number of rows of data that will be extracted at a time.
Note: Extracting too much data at once might cause the extraction to fail.
This field is only used when the class Nakisa.SAP.SAPeProcessor.RfcReadTable is selected.
For all other classes, all of the data is downloaded at once.
l Critical: Select this check box if you want the extraction of information to end immediately upon
encountering an error.
For example, the administrator sets up three tables to be extracted, and an error exists partway
through the second table's extraction. If Critical is checked, the extraction process will end imme-
diately upon encountering the error. If Critical is not checked, the first and third tables will extract
as expected while the extraction of the second table will not complete.
4. If you are creating a new extraction configuration, fill in the fields as follows in the Output Table Con-
figuration section:
l Source Table: The name of the SAP source table (for example, PA0001).
l Enter the source table, and click the Refresh button see a list of the fields contained in that
table under Available Fields. From there, you can select the fields you want to save to the
output table.
l Click to edit the name (or "alias") of a field in the destination database. By default, this
name is the same as the original SAP field name. Click to save the changes, or to dis-
card them.
l Download Conditions: Specifies special conditions, in XML, required by the administrator to
limit or refine the downloaded data that is stored in the output table.
For example, BEGDA <= '[DateToday]' And ENDDA >= '[DateToday]' would only
download data with valid dates.
Warning: There must be spaces between the fields and the operators in the download condition,
otherwise the table will not be properly extracted. (For example, BEGDA<='[DateToday]' is
incorrect, while BEGDA <= '[DateToday]' is correct.)
l Output Table Name: The name of the output table in the staged database that will receive the
downloaded SAP data. The name of this table should be unique.
l Output Table Description: The description of the output table that will receive the downloaded
SAP data.
5. If you are using existing extraction configurations, fill in the fields as follows in the Output Table Con-
figuration section:
l Source Table: The name of the SAP source table (for example, PA0001). Select the required
table from the list of source tables that have already been extracted for other template rules.
limit or refine the downloaded data that is stored in the output table. The same source table can be
extracted multiple times to different output tables (with different download conditions). Select the
required download condition for the required output table.
downloaded SAP data. Select the required output table that is related to the required download
condition. Note that number of output tables available indicates the number of times the same
source table has been extracted for other template rules.
SAP data.
Nakisa Inc. 69
l Fields in Use: The list of fields that have already been extracted from the source table to the out-
put table.
l Available Fields: The list of source fields that can still be extracted from this source table.
l If required, select the additional fields that need to be extracted and added to the selected out-
put table. Note that adding additional fields to an existing output table will not break the other
template rule that is also using the same tables.
card them.
6. Click Add / Modify Table To Rule to store the new, existing, or modified extraction configuration to
the template rule. The source to output table mapping appears in the List of Tables added to Rule
drop-down list at the top of the wizard.
Note: If new fields have been added to an existing output table, the Fields in Use list is not
refreshed in the wizard until the changes have been submitted in the last step.
7. If required, repeat the above steps to configure multiple SAP table extractions for the template rule.
8. To remove a table from the template rule, select the table from List of Tables added to Rule and
click Remove Table from Rule.
9. Click Next to define rule logic.
8.4.3 Rule Logic

8.4.3.1 About Rule Logic
The rule conditions applied to the extracted data are configured in the Rule Logic wizard step. This step
allows you to further manipulate the downloaded SAP data or configure table joins on the extracted
SAP data.
The rule logic can be defined using one of the following forms:
l Advanced form, where you must write the SQL statement yourself.
l Basic form, where you use a graphical query builder to generate the SQL statement.
8.4.3.2 Basic Rule Logic Form

Use the basic Rule Logic form to use a graphical query builder to generate the SQL query statements.
The list of tables added in the previous step are displayed in the List of Tables added to Rule drop-down
list. The SQL statements must use all of the tables that were added to the rule; remove any extra tables or
return to the previous step to add missing tables.
Note that the graphical query builder is not as flexible as the advanced form:
l It only supports adding one query per template rule; intermediary steps, tables, and results cannot be
generated and used within the same rule.
l It can only generate output error tables (and not views).
You can choose to apply a filter on the query, which will only return records that match the query condition
for active objects. By default these filters are based on the following tables and conditions:
70 www.nakisa.com
Filter Database Table Source Condition
Table
Active org RULES_FILTER_1 PA0000 STAT2 ='1' OR STAT2 ='3'
units
Active pos- HRP1000_ HRP1000 BEGDA <= '[DateToday]' And ENDDA >= '
itions ACTIVEPOS [DateToday]' AND PLVAR = '[PlanVersion]'
AND ( ISTAT = '1' ) AND ( OTYPE = 'S' )
Active HRP1000_ALL_OU HRP1000 BEGDA <= '[DateToday]' And ENDDA >= '
employees [DateToday]' AND PLVAR = '[PlanVersion]'
AND ( ISTAT = '1' ) AND ( OTYPE = 'O' )
To configure rule logic:

1. In the Rule Logic wizard step, enter the rule logic and join configuration Description or leave the
default value. This description is displayed when join statements are executed during data extraction.
2. Select the Basic option.
3. Select the table to configure in List of Tables added to Rule.
4. Select the required object type in the Select object type for table joins and active filters drop-
down list, or leave it empty. Note that you can only join tables that represent the same object type,
and an object type can only be selected if the field that identifies that object type is in the selected
table.
l For table joins, the object determines which fields are used to join the tables:
l Org unit: Tables are joined using OBJID.
l Position: Tables are joined using OBJID.
l Employee: Tables are joined using PERNR.
l To apply one of the active filters, the related object type must be selected.
l If table joins and active filters are not required for the rule, do not set this field.
5. If required, select one of the available Active object filters. If a filter is selected, the query will only
return matching records for objects that are active.
6. Click Add table to Query to add rule conditions and join tables (if required).
7. Select the fields that must be returned in the output table that contains all of the records that match
the rule conditions. Note that if you are joining tables or using active filters, the fields OBJID or
PERNR must be selected.
8. Click Add filter to table to add the rule conditions (i.e. WHERE clauses). Set up the following fields
in the filter configuration:
a. Select the required field from the drop-down list.
b. Select the required operator from the drop-down list.
c. If required, select whether the value is a field, text, or integer (without any decimals).
d. If required, enter either the field used for the value, or the text used for the value.
e. To add another statement, click . To remove any of the additional statements, click .
i. Select whether the additional statement is ANDed or ORed with the previous statement.
ii. Enter the required information for the additional statement.
Nakisa Inc. 71
f. To create a sub-group of statements (i.e. a set of nested statements), click Group and add more
statements, or use the and outside the existing groupings.
g. To clear all of the statements and start again, click Reset filter.
h. To completely remove the filter, click Remove filter.
i. Click Apply to add the table and filter to the template rule.
Note: If the filter was not properly configured, an error message is displayed and the statement
with the error is highlighted in red.
9. The resulting table and filter appears at the bottom of the page under Graph Query. Click to
expand the filter, or to hide it.
10. Other tables can be joined to the tables that have been added in the Graph Query:
a. Select the required table in the List of Tables added to Rule drop-down list at the top of the win-
dow.
b. Click on the table box in the Graph Query to select it (indicated by a dashed border),
c. Click Add table to Query and select how to join the tables:
l Join (inner join): Combines the rows from both tables that have matching values.
l Left outer join: Combines all of the rows from the left table with any common rows from the
right table. Note that for rows in the left table that do not match any rows in the right table, the
right row is filled with NULL.
l Union: Combines the rows of both tables, eliminating any duplicate rows. Note that the
application adds a NULL value in the output table for any columns that do not match. For
example, if table 1 has a column named MANDT and table 2 does not, the output table will
contain a NULL value for the MANDT column for all rows retrieved from table 2.
d. Follow the previous steps to add the table and filter and click Apply.
11. Repeat the previous steps to add more tables. Note that you can select tables or groups of tables in
the Graph Query.
12. To add a filter to the joined tables, select the required table box in the Graph Query and click Add fil-
ter. Refer to the previous steps for instructions on how to set the filter. Note that the field names
include the table name and a generated ID to indicate which table the field belongs to. Once the filter
is added, it appears in the Graph Query under the join that it applies to.
13. To remove a table or a group of tables, select the required box and click Delete query component.
Note that filters on joins cannot be removed unless the joined tables are deleted.
14. To remove all of the tables, clear all of the object and filter fields, and start again, click Reset.
15. To view the generated SQL statements that the graph query represents, click Query statements pre-
view. A new window appears with the SQL statements, which can be selected and copied if desired.
Click Close when you are done viewing the statements.
16. If all of the tables added to the template rule have not been used in this wizard step, select these
tables from the List of Tables added to Rule drop-down list and click Remove Table from Rule.
17. Click Next to configure the rule parameters.
8.4.3.3 Advanced Rule Logic Form

Use the advanced Rule Logic form to write your own SQL statements.
72 www.nakisa.com
list. The SQL statements must use all of the tables that were added to the rule; remove any extra tables,
or return to the previous step to add missing tables.

1. In the Rule Logic wizard step, enter the rule logic and join configuration Description or leave the
default value. This description is displayed when join statements are executed during data extraction.
2. Select the Advanced option.
3. Click Add Statement to add a new row to the table.
4. Click to edit the statement definition in the native syntax of your database (Oracle, DB2, or SQL).
Click to save the changes, or to discard them. Select Ignore Errors if you want the extraction
to continue even if there is an error with this statement.
5. Click Add Statement to add another row to the table for more statements.
Note: Always be sure to pair any new statement with its corresponding drop statement. Also make
sure Ignore Errors is checked for the drop statement.
6. If all of the tables added to the template rule have not been used in the SQL statements, select these
8.4.4 Default Rule Parameters

Setting the default values for a template rule, such as general rule information or database information, is
done in the Default Rules Parameters wizard step. The advanced mode of this wizard step allows admin-
istrators to enter additional information, such as keywords and error correction steps.
Note: All of the fields with stars "*" are mandatory and must be configured.
To set the default rule parameters:

1. In the Default Rules Parameters wizard step, set up the general information, database information,
and additional information for the template rule.
2. In the General Information section, modify the following rule parameters:
l Rule Name: The name of the given template rule.
l Description: A more complete description of why this rule will flag an error.
The rule description is displayed in the Details panels and Profile windows in the User Console.
l Category: The category specifies the object type to which the rule applies. The possible cat-
egories are:
l Org Unit
l Position
l Employee
l Group: The group that the rule affects (OM - organization management, PA - personnel admin-
istration, CM - compensation management).
l Severity: The severity assigned to an error detected using this rule (low, medium, or high).
l Weightage: A percentage value that specifies the weight of the rule when the application cal-
culates data integrity scores for positions and companies. The scores are calculated using the
Nakisa Inc. 73
number of errors found, the total number of objects, and the rule weightage. Refer to the User
Guide for detailed information about the score calculations.
3. In the Database Information section, modify the following template rule parameters:
l Table Name: The output table name where the required data is located. This field is automatically
populated but may need to be changed. Generally, the table generated from the join statement
should be selected. Click on the icon to select a different table, or to enter the name of table if
it does not appear in the drop-down list.
Note: The output table is either the extracted table in the destination database, or the output error
table generated by SQL statements in the Rule Logic step.
l Table Object Field Name: The ID field name (for example, PERNR or OBJID) in the output table
where the required data is located.
4. If required, select the Advanced Mode checkbox to enter additional information.
a. In the General Information section, modify the following template rule parameters as required:
l Rule ID: The ID of the created template rule. This field is automatically generated and cannot
be changed.
l Component: A user-defined value that can be used to group certain rules together.
b. In the Database Information section, modify the following template rule parameters as required:
l Keyword Condition: The conditions that restrain the scope of the rule, written in the native
syntax of your database (Oracle, DB2, or SQL).
l Keyword List: User-defined, comma-separated keywords. Note that there cannot be spaces
in the list.
l Default Keywords: Comma-separated values for the keywords. Note that there cannot be
spaces in the list.
Note that these three keyword fields are related and must have coordinated information. (The
number of elements in the Keyword List must correspond to the number of default keywords.)
For example, to add a rule that searches for employees whose ages are less than 18 or greater
than 60, enter the following:
l Keyword List: KW_MIN_AGE,KW_MAX_AGE (user defined variables for the minimum and
maximum age)
l Keyword condition: [AGE_YEARS < [KW_MIN_AGE] OR AGE_YEARS > [KW_MAX_
AGE]] (where AGE_YEARS is a field in the staged database)
l Default Keywords: 18,60
c. In the Additional Information section, modify the following template rule parameters as
required:
l Error Correction: Provides a URL users can click to link directly to the source of an error for
easy correction. This URL may pass one or more relevant fields needed for the rule in ques-
tion, according to the URL syntax employed by the user's system.
The most common fields to pass are ERRORS_EMPLOYEEID (for employee IDs), ERRORS_
POSITIONID (for position IDs), and ERRORS_ORGUNITID (for org unit IDs). For a complete
list of fields, contact your implementation partner.
For example, the Age Incorrect rule would require the employee's ID number to be passed in
the URL. In this case, a possible URL would be: http://[location_of_
74 www.nakisa.com
application]?EmployeeID={ERRORS_EMPLOYEEID}. In this example, EmployeeID
could be any parameter as required by the user's URL to pass a value.
l Tool: Specifies the recommended tools for correcting the error.
l Reason: A short description of why this rule will flag an error.
l How to Correct: Suggests the actions to take in order to correct the error.
5. Click Next to configure the extraction process.
8.4.5 Sync Configurations

The Sync Configs wizard step allows you to extract the data and execute the joins that you specified in
the current session of Create Template Rules.

1. In the Sync Configs wizard step, select Extract data from SAP and Execute joins on extracted
data. Executing joins retains the table joins and relationships contained in the source data.
Note: The Start Extraction button will only perform its actions on the functions, joins and rules cre-
ated in this current session.
Warning: If you exit the wizard before submitting the changes, all work will be lost. If you submit
changes without clicking Start Extraction, changes will be appended to the staged database and a
global extraction will be necessary (see Extracting Audit Data for more details).
4. Click Publish to store new template rule in the database.
See also:
8.4.6 Example Template Rule Creation

The following example illustrates how to add a rule that finds employees with missing name and address
information.
1. In the menu panel, click Configure Audit > Create Template Rules.
2. Select Existing extraction configuration.
3. To add the first required table, fill in the fields as follows in the Output Table Configuration section:
l Source Table: Select "PA0002".
l Output Table Name: Select "PA0002".
l Download Conditions: Use the download condition that is automatically selected for the
PA0002 output table.
4. Click Add / Modify Table To Rule to add the table to the template rule. The source to output table
mapping appears in the List of Tables added to Rule drop-down list at the top of the wizard.
Nakisa Inc. 75
5. To add the second required table, fill in the fields as follows in the Output Table Configuration sec-
tion:
l Source Table: Select "PA0006".
l Output Table Name: Select "PA0006".
l Download Conditions: Use the download condition that is automatically selected for the
PA0006 output table.
6. Click Add / Modify Table To Rule to add the table to the template rule. The source to output table
mapping appears in the List of Tables added to Rule drop-down list at the top of the wizard.
8. In the Rule Logic wizard step, select the Basic option.
9. Fill in the following general fields:
l Select object type for table joins and active filters: Select "employee".
l Select Active employees to only return matching records for active employee objects.
10. In List of Tables added to Rule, select the table SAP_PA0002 -> PA0002.
11. Click Add table to Query.
l Select the field PERNR.
l Click Add filter to add the following rule conditions:
l Set Fields to "LASTNAME" and Operator to "is empty".
l Click to add a second condition, and select "OR".

l Set Fields to "FIRSTNAME" and Operator to "is empty".
12. Click Apply.

13. In List of Tables added to Rule, select the table SAP_PA0006 -> PA0006.
14. Select the PA0002 table box in the Graph Query section, and click Add table to Query.
l Select Join to use an inner join for the two tables.
l Select the field PERNR.
l Click Add filter to add the following rule conditions:
l Set Fields to "STREET" and Operator to "is empty".
l Click to add a second condition, and select "OR".

l Set Fields to "CITY" and Operator to "is empty".
l Click to add a third condition, and select "OR".

l Set Fields to "P_Code" and Operator to "is empty".
l Click to add a forth condition, and select "OR".
76 www.nakisa.com
l Set Fields to "COUNTRY" and Operator to "is empty".
l Click to add a fifth condition, and select "OR".

l Set Fields to "DISTRICT" and Operator to "is empty".
15. The following table and filter appears at the bottom of the page under Graph Query (with the filters
expanded).
Nakisa Inc. 77
16. To view the generated SQL statements that the graph query represents, click Query statements pre-
view. A new window appears with the SQL statements, which can be selected and copied if desired.
Click Close when you are done viewing the statements.
18. In the Default Rules Parameters wizard step, enter the following information:
l General Information section:
l Rule name: Enter "Name and address missing"
l Description: Enter "Both name and address information are missing for the employee".
l Category: Select "employee".
l Group: Select "PA".
l Severity: Select "medium"
l Weightage: Enter "10".
l Database Information section:
l Table name: Click , and select the table generated from the table join (for example, "DB ->
j_id768_node_T").
l Table Object Field Name: Enter "PERNR"
19. Click Next.
20. In the Sync Configs wizard step:
l Clear Extract data from SAP because no new extraction was required for the template rule.
l Select Execute joins on extracted data.
78 www.nakisa.com
21. Click Start Extraction. When the dialog box appears to confirm that the join was performed, click
Close.
22. Click Next > Submit.
23. Publish the build. A rule can now be added based on this template rule.
8.5 Editing Template Rules
8.5.1 About Editing Template Rules

run, returns matching results for use in the application. Rules are added based on template rules.
Both default template rules and custom template rules can be modified using the Nakisa AdminConsole,
but only when they have not been configured and added as existing rules.
Warning: The Edit Template Rules feature should only be used by advanced administrators.
The Edit Template Rules wizard is divided into five steps:
l Select Template Rule
l Download SAP Infotype
l Rule Logic
l Default Rules Parameters
l Sync Config
See also:
l About Creating Template Rules, section 8.4.1 on page 67
8.5.2 Select Template Rule

In this step, select the template rule to modify.
To select the custom template rule:

1. In the menu panel, click Configure Audit > Edit Template Rules. The Select rule wizard step loads
automatically.
2. In the Select column, select the checkbox for the template rule that needs to be modified. Note that
you can only edit template rules that have not been added as a rule.
3. Click Next.
8.5.3 Download SAP Infotype

The Download SAP Infotype wizard step allows you to modify the existing SAP source table extraction
and output tables already assigned to the template rule, or to add new extraction configurations if required.
Nakisa Inc. 79
If the template rule requires data that has already been extracted for another rule, then you can add the
existing source and output tables to the new template rule. If the table was already extracted for this tem-
plate rule or another template rule, but is missing some fields, these fields can be extracted to the same
output table. If the template rule requires new SAP tables or infotypes that have not already been extrac-
ted, new extraction configuration can be set up to extract the information into output tables in the des-
tination database.
Note that multiple tables can be added to the same template rule.
To download SAP Infotypes:
1. In the menu panel, click Configure Audit > Edit Template Rules. The Download SAP Infotype wiz-
ard step loads automatically, allowing you to extract and map SAP infotypes in the destination data-
base.
2. The tables that have already been added to the template rule are available in the List of Tables
added to Rule drop-down list.
3. To add a more tables to the rule or to add more fields to an existing table, select one of the following
options:
l Existing extraction configuration: Select this option to modify an extraction configuration that
has already been added to the template rule, or to add a new table by re-using source and output
tables and fields that have already been defined for other template rules.
l New extraction configuration: Select this option to define new source and output tables and
fields to extract from the SAP source.
4. To configure advanced fields, select the Advanced Mode checkbox. Configure the following fields in
the General Information section. Note that for existing extraction configuration, certain fields are
read-only because changing these fields could break existing template rules.
l Function Name: The name of the extraction function (for internal use only). The administrator
can leave this field untouched from its defaults.
l Function Description: The description of the extraction function (for internal use only). The
administrator can leave this field untouched from its defaults.
l Encoding: Specifies the character encoding scheme to use when extracting SAP data.
l DLLs:Specifies the SAP processor used to extract data. The available choices are as follows:
l Nakisa.SAP.SAPeProcessor (for use with staged solutions)
l Nakisa.SAP.Custom.OTFProcessor (for use with live solutions)
Note: For Nakisa OrgAudit, this field must be set to Nakisa.SAP.SAPeProcessor.
l Class: Specifies which processor class is used to extract data. This field must correspond to the
chosen DLL field.
l If Nakisa.SAP.SAPeProcessor is selected, you can choose one of the following classes:
l Nakisa.SAP.SAPeProcessor.RfcReadTable (to extract table data)
l Nakisa.SAP.SAPeProcessor.Hrwpc_Rfc_Rp_Read_Photo_Uri (to extract photo URI)
l Nakisa.SAP.SAPeProcessor.TpmTrgReadTableRFC (to extract in SAP's internal
RAW format)
Tip: To determine which class to use, use transaction code SE37 in the SAP GUI to view the
input and output parameters of the function modules that correspond to the classes listed
80 www.nakisa.com
above (RFC_READ_TABLE, HRWPC_RFC_EP_READ_PHOTO_URI, or TPM_TRG_
READ_TABLE_RF respectively).
l If Nakisa.SAP.Custom.OTFProcessor is selected, choose the Nakisa.SAP.Cus-
tom.OTFProcessor.BAPI_SAP_OTFProcessor_Report_Lite class.
Note: For Nakisa OrgAudit, this field will almost exclusively be set to Nakisa.SAP.SAPePro-
cessor.RfcReadTable.
l Row Download Portion: Specifies the number of rows of data that will be extracted at a time.
Note: Extracting too much data at once might cause the extraction to fail.
This field is only used when the class Nakisa.SAP.SAPeProcessor.RfcReadTable is selected.
For all other classes, all of the data is downloaded at once.
l Critical: Select this checkbox if you want the extraction of information to end immediately upon
encountering an error.
For example, the administrator sets up three tables to be extracted, and an error exists partway
through the second table's extraction. If Critical is checked, the extraction process will end imme-
diately upon encountering the error. If Critical is not checked, the first and third tables will extract
as expected while the extraction of the second table will not complete.
5. If you are creating a new extraction configuration, fill in the fields as follows in the Output Table Con-
figuration section:
l Source Table: The name of the SAP source table (for example, PA0001).
l Enter the source table, and click the Refresh button see a list of the fields contained in that
table under Available Fields. From there, you can select the fields you want to save to the
output table.
card them.
limit or refine the downloaded data that is stored in the output table.
For example, BEGDA <= '[DateToday]' And ENDDA >= '[DateToday]' would only
download data with valid dates.
Warning: There must be spaces between the fields and the operators in the download condition,
otherwise the table will not be properly extracted. (For example, BEGDA<='[DateToday]' is
incorrect, while BEGDA <= '[DateToday]' is correct.)
downloaded SAP data. The name of this table should be unique.
SAP data.
6. If you are using existing extraction configurations, fill in the fields as follows in the Output Table Con-
figuration section:
l Source Table: The name of the SAP source table (for example, PA0001). The tables that have
already been added to the template rule are at the top of the list and prefixed with "____".
l To add an existing extraction configuration to the template rule, select the required table from
the list of source tables that have already been extracted for other template rules.
Nakisa Inc. 81
l To edit an extraction configuration that has already been added to the template rule, select one
of the "____" tables.
limit or refine the downloaded data that is stored in the output table. The same source table can be
extracted multiple times to different output tables (with different download conditions). Select the
required download condition for the required output table.
downloaded SAP data. The output tables that have already been added to the template rule are at
the top of the list and prefixed with "____".
l To add a new output table to the template rule, select the required output table that is related to
the required download condition. Note that number of output tables available indicates the num-
ber of times the same source table has been extracted for other template rules.
l To edit an existing extraction configuration that has already been added to the template rule,
select one of the "____" tables.
SAP data.
l Fields in Use: The list of fields have already been extracted from the source table to the output
table.
l Available Fields: The list of source fields that can still be extracted from this source table.
l If required, select the additional fields that need to be extracted and added to the selected out-
put table. Note that adding additional fields to an existing output table will not break the other
template rule that is also using the same tables.
card them.
7. Click Add / Modify Table To Rule to store the new, existing, or modified extraction configuration to
the template rule. The source to output table mapping appears in the List of Tables added to Rule
drop-down list at the top of the wizard.
Note: If new fields have been added to an existing output table, the Fields in Use list is not
refreshed in the wizard until the changes have been submitted in the last step.
8. If required, repeat the above steps to configure multiple SAP table extractions for the template rule
9. To remove a table from the template rule, select the table from List of Tables added to Rule and
click Remove Table from Rule. Note that you can also remove tables that already belonged to the
template rule if they are not needed in the new definition of the template rule.
8.5.4 Rule Logic

The rule conditions applied to the extracted data are configured in the Rule Logic wizard step. This step
allows you to modify the existing SQL statements or to add new ones to further manipulate the down-
loaded SAP data or to configure other table joins on the extracted SAP data.
list. The SQL statements must use all of the tables that were added to the rule; remove any extra tables,
or return to the previous step to add missing tables.
82 www.nakisa.com
1. In the Rule Logic wizard step, enter the rule logic and join configuration Description. This descrip-
tion is displayed when join statements are executed during data extraction.
The Advanced option is selected by default. Note that the Basic Rule Logic form (with the graphical
query builder) is not available in this wizard.
2. Click to edit an existing statement definition in the native syntax of your database (Oracle, DB2,
or SQL). Click to save the changes, or to discard them. Select Ignore Errors if you want the
extraction to continue even if there is an error with this statement.
3. To add a new row to the table, click Add Statement, then repeat the previous step to create the
statement definition.
Note: Always be sure to pair any new statement with its corresponding drop statement. Also make
sure Ignore Errors is checked for the drop statement.
4. If all of the tables added to the template rule have not been used in the SQL statements, select these
8.5.5 Default Rule Parameters

If required, modify the default values that were originally set for the template rule in the Default Rules
Parameters wizard step.
Note: All of the fields with stars "*" are mandatory and must be configured.
To set the default rule parameters:

1. In the Default Rules Parameters wizard step, modify the required fields in the general information,
database information, and additional information sections for the template rule.
2. In the General Information section, modify the following rule parameters as required:
l Rule Name: The name of the given template rule.
l Description: A more complete description of why this rule will flag an error.
The rule description is displayed in the Details panels and Profile windows in the User Console.
l Category: The category specifies the object type to which the rule applies. The possible cat-
egories are:
l Org Unit
l Position
l Employee
l Group: The group that the rule affects (OM - organization management, PA - personnel admin-
istration, CM - compensation management).
l Severity: The severity assigned to an error detected using this rule (low, medium, or high).
l Weightage: A percentage value that specifies the weight of the rule when the application cal-
culates data integrity scores for positions and companies. The scores are calculated using the
number of errors found, the total number of objects, and the rule weightage. Refer to the User
Guide for detailed information about the score calculations.
Nakisa Inc. 83
3. In the Database Information section, modify the following template rule parameters as required:
l Table Name: The output table name where the required data is located. This field is automatically
populated but may need to be changed. Generally, the table generated from the join statement
should be selected. Click to select a different table, or enter the name of table if it does not
appear in the drop-down list.
Note: The output table is either the extracted table in the destination database, or the output error
table generated by SQL statements in the Rule Logic step.
l Table Object Field Name: The ID field name (for example, PERNR or OBJID) in the output table
where the required data is located.
4. To configure advanced fields, select the Advanced Mode checkbox.
a. In the General Information section, modify the following template rule parameters as required:
l Rule ID: The ID of the created template rule. This field cannot be changed.
l Component: A user-defined value that can be used to group certain rules together.
b. In the Database Information section, modify the following template rule parameters as required:
l Keyword Condition: The conditions that restrain the scope of the rule, written in the native
syntax of your database (Oracle, DB2, or SQL).
l Keyword List: User-defined, comma-separated keywords. Note that there cannot be spaces
in the list.
l Default Keywords: Comma-separated values for the keywords. Note that there cannot be
spaces in the list.
Note that these three keyword fields are related and must have coordinated information. (The
number of elements in the Keyword List must correspond to the number of default keywords.)
For example, to add a rule that searches for employees whose ages are less than 18 or greater
than 60, enter the following:
l Keyword List: KW_MIN_AGE,KW_MAX_AGE (user defined variables for the minimum and
maximum age)
l Keyword condition: [AGE_YEARS < [KW_MIN_AGE] OR AGE_YEARS > [KW_MAX_
AGE]] (where AGE_YEARS is a field in the staged database)
l Default Keywords: 18,60
c. In the Additional Information section, modify the following template rule parameters as
required:
l Error Correction: Provides a URL users can click to link directly to the source of an error for
easy correction. This URL may pass one or more relevant fields needed for the rule in ques-
tion, according to the URL syntax employed by the user's system.
The most common fields to pass are ERRORS_EMPLOYEEID (for employee IDs), ERRORS_
POSITIONID (for position IDs), and ERRORS_ORGUNITID (for org unit IDs). For a complete
list of fields, contact your implementation partner.
For example, the Age Incorrect rule would require the employee's ID number to be passed in
the URL. In this case, a possible URL would be: http://[location_of_
application]?EmployeeID={ERRORS_EMPLOYEEID}. In this example, EmployeeID
could be any parameter as required by the user's URL to pass a value.
l Tool: Specifies the recommended tools for correcting the error.
84 www.nakisa.com
l Reason: A short description of why this rule will flag an error.
l How to Correct: Suggests the actions to take in order to correct the error.
5. Click Next to configure the extraction process.
8.5.6 Sync Configurations

The Sync Configs wizard step allows you to extract any new data and execute the joins that you spe-
cified in the current session of Edit Template Rules.

1. In the Sync Configs wizard step, select Extract data from SAP and Execute joins on extracted
data. Executing joins retains the table joins and relationships contained in the source data.
Note: If no changes were made in the Download SAP Infotype step, then you do not need to
extract data from SAP. If no changes were made in the Rule Logic step, then you do not need to
execute joins on the extracted data.
Note: The Start Extraction button will only perform its actions on the functions, joins and rules cre-
ated in this current session.
Warning: If you exit the wizard before submitting the changes, all work will be lost. If you submit
changes without clicking Start Extraction, changes will be appended to the staged database and a
global extraction will be necessary (see Extracting Audit Data for more details).
4. Click Publish to store new template rule in the database.
See also:
l Adding Rules, section 8.7 on the next page
8.6 Deleting Template Rules

Template rules can be deleted from the application but only when they have not been configured and
added as existing rules.
Note: Deleted template rules will be permanently removed from the list of template rules; recreating the
database structure will not bring them back. However, any extractions and joins associated to the deleted
rules will still be performed. The only way to delete the associated extractions and joins is to manually
remove them from the ruleDbObjectsConfiguration.xml file (for joins) and
functionConfiguration.xml (for data extractions).
To delete a template rule:

1. In the menu panel, click Configure Audit > Delete Template Rules.
2. Check the box next to the rule or rules you would like to delete and click Next.
3. Click Submit to confirm the deletion of rules.
Nakisa Inc. 85
See also:
l Adding Rules, section 8.7 below
8.7 Adding Rules

run, returns matching results for use in the application.
A new rule is added by copying and modifying a template rule in the Show Template Rules tab. All new
rules are listed in the Show Existing Rules tab. Enabled existing rules are applied to a staged database
during an audit run, but note that template rules cannot be enabled. The rules are stored in the staged data-
base after you perform an audit run or publish the build, but are not stored when you simply save the build.
Each time the Nakisa OrgAudit launches, it loads the default set of template rules and any existing rules
that it finds in the staged database.
Some rules have keywords that the administrator needs to define in the Nakisa AdminConsole. The
keywords are used to represent values that may be defined differently in each deployed SAP server, or
that depend on the company's specific needs. For example:
l [KW_GENDER_MALE] may have the value M in one customer SAP server, and the value 1 in another
customer SAP server.
l [KW_MAX_AGE] represents the maximum age for an employee, which may be 70 for one company
and 75 for another.
Each rule can also be secured based on the user's role. If a rule is disabled for a role, then users with that
role will not see the errors related to that rule in any of the error listings or the errors listed in the Details
panels. Note that in this case, the secured rule is still visible to the users and the secured errors are still
included in the total number of errors and score calculations in the dashboards, Details panels, and views.
To secure specific areas of the User Console per role instead of securing rules, see About Defining
Roles, section 4.2.1 on page 23 for more information.
Note: If you require a template rule that does not currently exist, contact your implementation partner to
have a new one created. The set of template rules and the default keyword values are also customizable.
To add a rule:
1. In the menu panel, click Configure Audit > Add Rules. The Select Rule wizard step loads auto-
matically.
2. Click the Show Template Rules tab.
3. Browse through the list to find the rule that most closely corresponds to the rule you wish to create, or
find the rule using the search options available at the bottom of the list. To search the list, enter a
value and, if necessary,a wildcard (*), then select the column to search, and click Search. For
example, searching *direct* in the Name field will return the "Direct cost center" rule and the "Pos-
ition without direct reporting line" rule.
Tip: Click the column headers to change the rule sort order.
4. Click the Select checkbox corresponding to the rule to be copied, then click Next to modify the new
rule.
Tip: Double-click on any modifiable value in a row to select or deselect the rule.
86 www.nakisa.com
5. In the Modify rule wizard step, click . Some of the fields become available for editing. Modify the
values as necessary.
Field Description
Name The name of a rule in the rulesSchema.xml file, which is used to create
a database table needed to run an audit.
The rule name is displayed in the User Console listings, Details panel, and
Profile window.
Activate A value that determines whether a rule is enabled in the application ("Yes"
= enabled; "No" = disabled). Enabled rules are executed in audit runs.
Category The category specifies the object type to which the rule applies. The pos-
(Not editable) sible categories are:
l orgunit
l position
l employee
The category is displayed in the org charts, listings, Details panels, and
dashboards in the User Console.
Severity The severity assigned to an error detected using this rule (low, medium,
high, or critical).
The severity is displayed in the org charts, listings, Details panel, Profile
window, and dashboards in the User Console.
Group Name A designation for the group to which a rule belongs. Currently, rules can
(Not editable) belong to one of the following groups:
l OM - organization management
l PA - personnel administration
l CM - compensation management
The group name is displayed in the org charts, listings, Details panels,
dashboards, and Profile windows in the User Console.
Component A user-defined value that can be used to group certain rules together. The
category is displayed in the Details panels (for example, the Audit Runs
listing Details panel has a statistics graph that displays the number of
errors by category and severity), dashboards, and Profile windows in the
User Console.
Date Created Specifies the date and time that an existing rule was added, or the date
(Not editable) and time that a copy of a rule was created due to a modification of an exist-
ing rule. Note that this field does not appear for template rules.
Reason A short description of why this rule will flag an error.

This description is displayed in the org chart Details panels in the User
Console, and helps the user determine what action needs to be taken.
Nakisa Inc. 87
Field Description
How to correct Suggests the actions to take in order to correct the error.
The instructions are displayed in the Details panels and Profile windows in
the User Console.
Tool Specifies the recommended tools for correcting the error.

This information is available in the org chart Details panels and Profile win-
dows in the User Console.
Description A more complete description of why this rule will flag an error.
The rule description is displayed in the Details panels and Profile windows
in the User Console.
Rule Weightage A percentage value that specifies the weight of the rule when the applic-
ation calculates data integrity scores for positions and companies. The
scores are calculated using the number of errors found, the total number of
objects, and the rule weightage. These scores are displayed in the org
charts, Details panels, and dashboards in the User Console.
The total value for the enabled rules for each group must be 100%.
Otherwise, the application will not perform the audit run.
Refer to the User Guide for detailed information about the score cal-
culations
Error Correction Provides a URL users can click to link directly to the source of an error for
URL easy correction. This URL may pass one or more relevant fields needed
for the rule in question, according to the URL syntax employed by the
user's system.
The most common fields to pass are ERRORS_EMPLOYEEID (for
employee IDs), ERRORS_POSITIONID (for position IDs), and ERRORS_
ORGUNITID (for org unit IDs). For a complete list of fields, contact your
implementation partner.
For example, the Age Incorrect rule would require the employee's
ID number to be passed in the URL. In this case, a possible URL would
be: http://[location_of_application]?EmployeeID=
{ERRORS_EMPLOYEEID}. In this example, EmployeeID could be any
parameter as required by the user's URL to pass a value.
Tip: You can change the sort order of the rules by clicking on the column headers.
6. Click Next to define the keywords.
7. In the Modify keywords wizard step, click for the keyword you wish to define. The keyword
Value field becomes editable. Enter either your SAP server-specific value for that keyword, or the
company-specific value required for the keyword. Click to save the changes, or to discard
them.
Note: If you see the message "No Rows Available", it means that there are no keywords associated
with the rule you are adding.
8. Click Next to set up the rule security.
88 www.nakisa.com
9. In the Modify Rule Security wizard step, set the rule to "true" or "false" for each role. If the rule is set
to true for a role, then users with that role will be able to see the specific errors related to that in the
User Console. Note that by default, all of the rules are set to "true" for all of the roles. Click Reset
Authorizations to reset the fields to their default values.
10. Click Next > Submit to save the new rule.
11. Repeat this procedure to create additional rules.
Note: After creating a rule, it no longer appears in the Show Template Rules tab.
12. If you do not perform an audit run immediately, you must publish the build in order to store the new
rules in the staged database. Note that simply saving the build without running an audit or publishing
the build will not save the new rule.
See also:
l Modifying Rules, section 8.8 below
8.8 Modifying Rules

An existing rule is one that has been created by adding a template rule or modifying an existing rule.
Note: When you modify the rule name or its keyword(s), the application disables the original rule (sets its
Activate field to "No") and creates a copy of the rule with the new changes. The disabled rule is not
included in future audit runs, but it can be re-enabled or can be referred to for any errors related to it from
previous audit runs.
Some rules have keywords that are defined by the administrator in the Nakisa AdminConsole. The
keywords are used to represent values that may be defined differently in each deployed SAP server, or
that depend on the company's specific needs. For example:
l [KW_GENDER_MALE] may have the value M in one customer SAP server, and the value 1 in another
customer SAP server.
l [KW_MAX_AGE] represents the maximum age for an employee, which may be 70 for one company
and 75 for another. \
Rules can also be secured per role to restrict access to certain errors in the error listings (including the
errors listed in the Details panels). If a rule is restricted for a role, then users with that role will not be able
to see the specific errors related to that rule, but the errors are still included in the total number of errors
and score calculations in dashboards, Details panels, and views. Note that any changes to rule security
take effect as soon as the build is published; you do not need to perform a new audit run to secure the
errors that were already opened from previous audit runs. To secure specific areas of the User Console
per role instead of securing rules, see About Defining Roles, section 4.2.1 on page 23 for more inform-
ation.
When you modify a rule that was already executed in a previous audit run, all of the errors associated to
the original version of the rule are auto-closed and new errors for the new version of the rule are opened.
Nakisa does not recommend modifying executed rules because it causes some redundancy. For
example, if there is an employee with the age 80 in the database and the rule for the maximum age was
changed from 70 to 75, the original error is auto-closed and a new error is opened for the same database
record, which actually has not changed at all and may affect your statistics. If you re-activate the rule, its
associated errors will open again (i.e. auto-open) upon the next audit run.
To remove redundant information, you need to delete your audit history.
Nakisa Inc. 89
Note: If you change the rule security to deny access to a user after the audit run has been performed, the
auto-closed errors will still be visible to that user. The security change only applies to the new errors
raised for that modified rule.
When you deactivate a rule that was already executed in a previous audit run, all of the errors associated
to the rule are auto-closed. These errors can still be viewed in the User Console, but should not be manip-
ulated (for example, they should not be opened again).
To modify an existing rule:

1. In the menu panel, click Configure Audit > Modify Rules.
2. In the Select rule wizard step, browse through the list to find the rule that you would like to modify, or
find the rule using the search options available at the bottom of the list. To search the list, enter a
value and a wildcard (*) if necessary, select the column to search, and click Search.
Note: Template rules are not available for selection because only existing rules can be modified.
3. Select the rule and click Next.
4. In the Modify rule wizard step, click next to the rule to edit it.
5. Modify the values in the rule fields as necessary. See Adding Rules, section 8.7 on page 86 for inform-
ation about each field. Click to save the changes, or to discard them. Note that modifying the
fields "Name" or "Keywords" causes a copy of the rule to be created, and deactivates the original.
6. Click Next to modify the keywords.
7. In the Modify keywords wizard step, click for the keyword you wish to modify. The keyword
Value field becomes editable. Enter either your SAP server-specific value for that keyword, or the
company-specific value required for the keyword. Click to save the changes, or to discard
them.
Note: If you see the message "No Rows Available", it means that there are no keywords associated
with the rule you are modifying.
8. Click Next to modify the rule security.
9. In the Modify Rule Security wizard step, modify the rule security for the required roles. If the rule is
set to "true" for a role, then users with that role will be able to see the specific errors related to that in
the User Console. Click Reset Authorizations to reset the fields to their default values.
10. Click Next > Submit to save the modified rule.
11. Repeat this procedure to modify other rules.
12. If you do not perform an audit run immediately, you must publish the build. Otherwise, the modified
rules will not be stored in the staged database. Note that simply saving the build without running an
audit or publishing the build will not save the modified rules.
8.9 Running Audits

Audit runs are performed on the data in the staged database, which contains data extracted using the
SAPExtractor and audit data extraction. During an audit run, the application will perform the following
steps:
l Store any new or modified rules in the staged database.
l Validates the database entries against the set of existing rules that have been enabled (i.e. Activate is
set to true), and generates a list of errors.
90 www.nakisa.com
l Merges the errors generated in the new audit run with all of the errors that already exist in the database
from previous audit runs. For example, new error entries are opened, old errors that were marked as
closed but not corrected are auto-opened, old errors that have been corrected are auto-closed.
l Executes database table joins.
l Generates analytic data.
An audit run usually finishes within a few minutes. Depending on the numbers of errors found and the size
of the organization structure (number of org units involved as well as their relation), the time to complete
the audit run will vary.
Warning: Ensure that all of the rules required for the audit run have already been added with the correct
fields. Modifying rules after they have been executed in an audit run may lead to duplicated data.
To run an audit report:

1. To have the most correct data, run the SAPExtractor and audit data extraction to update the staged
database.
2. In the menu panel, click Configure Audit > Start Error Extraction.
3. Under the Run Audit heading, click Run Audit.
Progress statements will be displayed while the application is performing the audit run.
l After each successfully executed rule, the application displays Rule execution
status: success, followed by the number of errors found for that rule.
l If all of the rules could not be executed (for example, because the weightage for all of the rules in
one group did not add up to 100%), the application either prints an error message, or else does not
print any messages regarding the execution of the rules.
Note: Nakisa does not recommend using the Cancel button while the audit is running. At a certain
point, the audit run can no longer be stopped, and any partial results may be incorrect.
4. Once the audit run completes or an error occurs, you can select one of the following options:
l Preview Audit: Opens a PDF document summarizing the results of the audit run. You must still
choose whether to save or discard the audit.
l Save Audit: Saves the current audit run results to your staged database and executes database
table joins. Note that this option is not available if the audit run failed.
l Once the application has completed performing join statements on the database tables, it dis-
plays Execution of your Join Statements done.
l Once the application has completed generating analytic data, it displays Executing rules
analytics done.
l When this procedure is complete, click Close to return to the Start Error Extraction wizard
step.
l Discard: Discards the results from the current audit run and returns you to the Start Error Extrac-
tion wizard step.
5. Publish the build.
Tip: To run an audit immediately after you extract audit data from the SAP source, see Extracting Audit
Data, section 8.3 on page 66.
Nakisa Inc. 91
8.10 Managing Audit History and Rules

There are three ways in which to clear any audit history accrued through past audit runs; each method
handling existing rules differently. The three methods are as follows:
l The Recreate Database Structure button recreates all audit-related database tables, thereby deleting
all audit history. Any configured audit rules are deleted. Default template rules and user-created tem-
plate rules will be retained (provided the user-created template rules were published prior to recreating
the database structure).
l The Delete Audit History button recreates all audit-related database tables, thereby deleting all audit
history. Any existing configured audit rules are retained.
l The Delete Audit & Reapply Rules button recreates all audit-related database tables, thereby delet-
ing all audit history. Any configured audit rules are deleted and replaced with the complete set of tem-
plate rules.
Note: The set of template rules and the default keyword values are customizable. For information on
customizing this list, contact your implementation partner.
To delete audit history:

1. In the menu panel, click Configure Audit > Configure Audit. The Source - SAP form loads.
2. Click Destination.
3. Depending on the intended outcome detailed above, click Recreate Database Structure, Delete
Audit History, or Delete Audit and Reapply Rules.
Note: It is not necessary to publish your build after applying either button. The changes will be reflected
immediately in the User Console.
8.11 Scheduling Extraction and Audit Runs

To schedule an audit run on the most current data, you can schedule staging and audit data extractions to
run before the audit run using the ExtractionTrigger.bat (for Windows operating systems) or
ExtractionTrigger.sh (for Linux operating systems) executable files.
The following table lists all of the files required for scheduling extractions and audits.
File Name Description

In Windows
File location:
[application directory]/.system/application/ExtractionScripts/Windows
ExtractionTrigger.bat This file triggers the extraction by calling the Folder.bat file and
the sapextractor.bat file with the appropriate attributes.
92 www.nakisa.com
File Name Description
sapextractor.bat This file starts the extraction process in Windows. No changes are
required in this file.
Note that this file can be used to schedule only the SAPExtractor
(see Scheduling Extractions, section 7.4 on page 60 for more inform-
ation).
Folder.bat This file creates a folder named "SQLSERVER", "ORACLE", or

"DB2", depending on which database type is used for the staged
database. This folder is temporarily required by the extractor.
Certain attributes need to be added to this file, and the folder name
needs to be specified based on the database type.
In Linux
File location:
[application directory]/.system/application/ExtractionScripts/Linux
ExtractionTrigger.sh This file triggers the extraction by calling the Folder.sh and
sapextractor.sh files with the appropriate attributes.
sapextractor.sh This file starts the extraction process in Linux. No changes are
required in this file.
Note that this file can be used to schedule only the SAPExtractor
(see Scheduling Extractions, section 7.4 on page 60 for more inform-
ation).
Folder.sh This file creates a folder named "SQLSERVER", "ORACLE", or

"DB2", depending on which database type is used for the staged
database. This folder is temporarily required by the extractor.
Attributes do not need to be added to this file, but the folder name
does need to be specified based on the database type.
Note: The executable files use the configuration settings from the current build, and cannot change the
extraction and audit configurations. Use the Nakisa AdminConsole to change SAPExtractor settings,
audit data extraction settings, and existing rules, then publish the build to make those changes available
to the executable files.
Prerequisites
SAP Java Connector (SAP Jco) version 2.1.8 or 2.1.10 is required to run the command line extractor.
Other versions of SAP Jco are not supported.
Configuring the Scripts in Windows

In the ExtractionTrigger.bat file, you must add command-line expressions that call the
sapextractor.bat file with the following attributes, and also call the Folder.bat file. Note that
there must be a space between each attribute in the command.
Nakisa Inc. 93
Attribute Details
[application directory]) /J00/j2ee/cluster/apps/[Nakisa]/[EAR name
without extension]/servlet_jsp/[WAR name
without extension]/root
Build workspace name Specify the build workspace name that matches the name in the
[application directory]/.system/Admin_Config
folder.
For example: ___000___OrgAudit_SqlServer
Path to the SAP Java Connector Specify the location of the sapjco.jar file.
(SAP JCo) For example: C:/SAPFile/sapjco.jar
Name of the Enter the file name, without the file extension. Depending on the
NakisaFrameworkBinxx.jar build, there may be a version number or suffix appended to the
file NakisaFramework.jar file. To verify the file name, locate the
file in the [application directory]/WEB-INF/lib dir-
ectory.
For example: FrameworkBin
NakisaTrollBinxx.jar file build, there may be a version number or suffix appended to the
NakisaTrollBin.jar file. To verify the file name, locate the
ectory.
For example: TrollBin
Extract staging data Set to true or false. The extractor extracts staging data from
the SAP server if the value is true.
Execute joins on extracted sta- Set to true or false. The extractor executes joins to create new
ging data tables and objects based on the staging data when the value is
true.
Extract audit data Set to true or false. The extractor extracts audit data from the
SAP server if the value is true.
Execute joins on extracted audit Set to true or false. The extractor executes joins to create new
data tables and objects based on the audit data when the value is
true.
94 www.nakisa.com
Attribute Details
Run audit Set to true or false. The application performs an audit run on
the extracted data if the value is true.
NakisaSherlockBinxx.jar build, there may be a version number of suffix appended to the
file NakisaSherlockBin.jar file. To verify the file name, locate
the file in the [application directory]/WEB-INF/lib dir-
ectory.
For example: SherlockBin
You must also define the following attributes in the Folder.bat file.
Attribute Details
SET ONE (Path to the deployed Specify the location of the deployed Nakisa application.
Nakisa application, i.e. the For example: C:/usr/sap/[NetWeaver host name]
SET TWO (Build workspace Specify the build workspace name that matches the name in the
name) [application directory]/.system/Admin_Config
folder.
Database folder name The database folder name has to be set to "SQLSERVER",
"ORACLE", or "DB2", depending on the staged database type.
The folder name has to be set in four places in this file.
The following is an example of the command lines added to the required files for a SQL staged database.
Note that the spaces in between each attribute has been highlighted gray.
ExtractionTrigger.bat:
call folder.bat
call sapextractor.bat C:/usr/sap/CE1/J00/j2ee/JSPM/sapjvm/jre/bin
C:/usr/sap/CE1/J00/j2ee/cluster/apps/Nakisa/OrgAudit/servlet_
jsp/OrgAudit/root [build workspace] C:/SAPFile/sapjco.jar FrameworkBin
TrollBin true true false true true true SherlockBin
Folder.bat:
SET ONE=C:/usr/sap/CE1/J00/j2ee/cluster/apps/Nakisa/OrgAudit/servlet_
jsp/OrgAudit/root
SET TWO=[build workspace]
@echo Creating SQLSERVER folder .....
cd %ONE%\.system\Admin_Config\%TWO%\SAPExtractor
mkdir SQLSERVER\extractorSchema
xcopy /s extractorSchema SQLSERVER\extractorSchema
Nakisa Inc. 95
@echo SQLSERVER folder creation is done.
Configuring the Scripts in Linux

In the ExtractionTrigger.sh file, you must add command-line expressions that call the
sapextractor.sh and Folder.sh files with the following attributes. Note that there must be a space
between each attribute in the command.
Attribute Details
Attributes to call sapextractor.sh
folder.
Path to the SAP Java Connector Specify the location of the sapjco.jar file.
(SAP JCo) For example: C:/SAPFile/sapjco.jar
NakisaFrameworkBinxx.jar build, there may be a version number or suffix appended to the
file NakisaFramework.jar file. To verify the file name, locate the
ectory.
For example: FrameworkBin
NakisaTrollBinxx.jar file build, there may be a version number or suffix appended to the
NakisaTrollBin.jar file. To verify the file name, locate the
ectory.
For example: TrollBin
Extract staging data Set to true or false. The extractor extracts staging data from
the SAP server if the value is true.
Execute joins on extracted sta- Set to true or false. The extractor executes joins to create new
ging data tables and objects based on the staging data when the value is
true.
96 www.nakisa.com
Attribute Details
Extract audit data Set to true or false. The extractor extracts audit data from the
SAP server if the value is true.
Execute joins on extracted audit Set to true or false. The extractor executes joins to create new
data tables and objects based on the audit data when the value is
true.
Run audit Set to true or false. The application performs an audit run on
the extracted data if the value is true.
NakisaSherlockBinxx.jar build, there may be a version number of suffix appended to the
file NakisaSherlockBin.jar file. To verify the file name, locate
the file in the [application directory]/WEB-INF/lib dir-
ectory.
For example: SherlockBin
Attributes to call Folder.sh
folder.
In the Folder.sh file, you must also set the database folder name (in two places) to one of the following
values:
l SQLSERVER
l ORACLE
l DB2
The following is an example of command lines added to the ExtractionTrigger.sh file and the
changes made to the Folder.sh file for an SQL staged database. Note that in the following examples,
the spaces in between each attribute has been highlighted gray.
ExtractionTrigger.sh:
sh folder.sh /usr/sap/CE1/J00/j2ee/cluster/apps/Nakisa/OrgAudit/servlet_
jsp/OrgAudit/root [build workspace]
sh sapextractor.sh /sapmnt/CE1/exe/jvm/linuxx86_64/sapjvm_5.1.024/sapjvm_
5/bin /usr/sap/CE1/J00/j2ee/cluster/apps/Nakisa/OrgAudit/servlet_
jsp/OrgAudit/root [build workspace] /sapmnt/CE1/exe/jvm/linuxx86_
Nakisa Inc. 97
64/sapjvm_5.1.024/sapjvm_5/jre/lib/amd64/server/sapjco.jar FrameworkBin
TrollBin true true false true true true SherlockBin
Folder.sh:
cp -rf $1/.system/Admin_Config/$2/SAPExtractor/extractorSchema
$1/.system/Admin_Config/$2/SAPExtractor/SQLSERVER;
cp -rf $1/.system/Admin_Config/$2/SAPExtractor/extractorSchema
$1/.system/Admin_Config/$2/SAPExtractor/SQLSERVER/extractorSchema;
Running the Executable File

To run the extractions and audit run, start the ExtractionTrigger script. Messages at the command
prompt describe the extraction progress. Detailed information about the extraction is contained in the
Admin Log file.
Tip: Once you publish the build, the executable files are copied to the application's root folder, and you
can run the executable file from the root folder instead of from the file's original location.
Schedule and run data extractions at off-peak hours using the Windows Scheduled Tasks utility or the
Linux cron utility. Refer to the Windows or Linux documentation for instructions about using the task-
scheduling utilities:
l Windows: http://www.iopus.com/guides/winscheduler.htm
l Linux: http://ss64.com/bash/crontab.html
See also:
l Setting Up the Staged Database, section 8.1 on page 64
98 www.nakisa.com
9 Data Center
9
Learn how to create data connections and data elements.
9.1 Data Center Overview 100

9.2 Managing Data Connections 100
9.3 Creating Data Elements 103
9.3.1 About Creating Data Elements 103
9.3.2 Merge Two Data Elements 103
9.3.3 Data Element for RDBMS Structure 104
9.3.4 Data Element with Custom Integration Class 106
9.4 Resetting the RFC Cache 109
9 Data Center
9.1 Data Center Overview

The Data Center is the central location in the Nakisa AdminConsole that is used to manage data con-
nectivity in the application.
Use the Data Center to:
l Create the mandatory data connections to servers that provide new data information.
l Modify existing data connections.
l Create and modify data elements that are used for org charts, org chart box views, listings, and the
Details panel.
l Test connectivity to ensure the server is responding.
l Test the performance time required to process a request.
The following tools are available:
l Data Connections: Create and manage multiple database connections.
l Data Element Management: Create and modify data elements.
l Resetting the RFC Cache: Reset the RFC cache if there have been changes to the RFC interface in
the SAP system.
9.2 Managing Data Connections

Create and manage multiple database connections in the Data Center. Any new connections can then be
used to create org chart box views and Details panels.
Refer to the Environment Checklist for the list of supported databases and versions.
To connect to a database, the process involves creating a connection, and then configuring the con-
nection. Note that there may be a list of default connections that have already been created, but these con-
nections are not configured by default.
Create a Connection
To add a new data connection:
1. In the menu panel, click Data Center.
2. Click Data Connections.
3. Click Create New.
4. Enter a Name and a Description.
5. Select the required Data Connection.
6. Click Confirm.
The new connection is added as the last item in the Select a connection list. The new connection must
then be configured to connect to a database.
100 www.nakisa.com
Configure a Connection
All required connections must be configured. There are three types of data connections available:
l Active Directory
l RDBMS
l SAP
Note: There may be pre-configured data DLL connections that can only be used with custom integration
class data elements.
To connect to an Active Directory server or RDBMS database:

3. Use the page controls to find the required connection in the Select a connection list.
4. Select the checkbox next to an RDBMS database connection and click Configure.
5. Select the Server Type.
6. Enter the Server Name.
name.
For example: 192.168.0.148:1521:ora92
l TNS entry name
7. For Active Directory connections, enter the Server Port where the authentication server resides.
Port 389 is the Active Directory default, and 3268 if Global Catalog is the directory service forest.
8. Enter the Initial Catalog property for the required database in the data source. Skip this step for
Oracle and Active Directory connections.
9. Enter the User Name and Password for the server.
10. If you are configuring an Active Directory connection, complete the following fields:
a. Enter the Default Domain of the Active Directory server.
b. Select Allow Empty Password to enable users to log in with their Active Directory user ID only.
Note: Active Directory must be configured to accept anonymous binds (authentications). For
details, refer to the Microsoft Active Directory documentation.
c. Select Use SSL to encrypt the credentials using Secure Sockets Layer.
Nakisa Inc. 101

9 Data Center
d. Select Use these credentials to connect to the data source in the application to access the
LDAP database with a service account based on the specified credentials.
e. Select the Forest Browsing Mechanism (the AD directory service forest). This field is optional.
f. Set the Search Limit to a specific number of objects.
11. Click Test Connection.
12. Click Save when the connection is successful.
13. Click Submit.
To connect to an SAP server:

3. Use the page controls to find the required connection in the Select a connection list
4. Select the checkbox next to an SAP connection and click Configure.
5. Click and enter the Connection String for the SAP data source in the field provided. See Con-
nection String, section 3.1 on page 12 for information about the SAP data connection.
Note: For security reasons, the USER and PASSWD attributes may not be defined in the connection
string, but are required by certain wizards in the Nakisa AdminConsole. If USER and PASSWD are omit-
ted, enter the User Name and Password in the Temporary Credentials section. This way, the user
name and password are only stored during the current session of Nakisa AdminConsole, and not per-
manently saved in the connection string. Note that the connection information can also be set in the
wizards wherever credentials are required.
6. Click Test Connection.
7. Click to confirm the connection.
8. Click Save.
9. Click Submit.
Remove Connection
Warning: Before removing a connection, all fields that use that connection in the Details panels, listings,
or org chart views must be cleared. This information can only be changed in the configuration files.
Contact your implementation partner to perform these changes.
To delete a connection that is no longer used:

3. Use the page controls to find the required connection in the Select a connection list.
4. Select the checkbox next to the connection you wish to remove.
5. Click Delete.
102 www.nakisa.com
9.3 Creating Data Elements
9.3.1 About Creating Data Elements

Nakisa applications use data elements to retrieve and filter information displayed in the User Console.
Data elements are instances of one or more database tables, and have their own attributes—such as data-
base connection, table name, and fields—that are used by other configurations within the application.
Note: Creating data elements requires knowledge of data elements, SAP tables, SAP RFCs, and Nakisa
RFCs. Contact your implementation partner if you need assistance.
The Data Element Management section of the Data Center provides the following options for creating
data elements:
l Edit/Create new data element for an RDBMS structure reads data from a table stored in a relational
database management system (RDBMS).
l Create new data elements by merging two data elements is used to combine two data elements into
one.
l Create new data element with custom integration class is used in exceptional cases and serve as cus-
tom command processors that use specific methods to connect to an RDBMS database or RFC.
9.3.2 Merge Two Data Elements

In some cases, merging two data elements for the same object can improve performance for hierarchy
data elements and detail data elements.
Merging two data elements involves the following steps:
l Create the data element that will contain the merged data
l Select the data elements to merge
l Define how duplicate rows and columns are processed
l Set the key field(s), effective date fields, and extra info fields (if any) for the data element
Prerequisites
l Establish a connection to the SAP data source in the Data Connections screen.
Create Data Element

To create a data element:
2. In the Data Elements section, click Edit/Create new data element by merging two data ele-
ments.
3. Click Create New Data Element.
4. Enter a unique Name for the data element. The typical syntax is Object, Property and the Rep-
resentation term.
5. Enter a Description to identify how the data element functions.
Nakisa Inc. 103

9 Data Center
6. Select the Data Connection to the SAP system where the required tables are stored.
7. Click Create.
8. Select the Data Element from the list, then click Next to define the source data elements.
Define Source Data Elements

To define the source data elements:
1. Select the Source Data Element.
2. Select the Source Field used to join the two data elements.
3. Select the Merge Data Element.
4. Select the Merge Field used to join the two data elements.
Data Field Captions

Set the required language captions for the Source Fields and Merge Fields configured in the Linked Data
Elements step.
To set the field captions:

1. Select a table from the drop-down list.
2. To change the vertical size of the text boxes, select the TextArea checkbox.
3. To display the caption key for each field, select the Show Keys checkbox.
4. For each field, set the captions in the required languages.
5. Click Next.
Data Element Properties

Set the key fields, effective date fields, and extra info fields in the data element.
To set the data element properties:

1. Use the search controls below the field list to search the required field by its name or description.
2. Select the checkbox for the key field(s).
3. Optionally, click , enter a new Description, then click .
4. If applicable, select the effective Start Date and End Date fields contained in the data element.
5. If applicable, set the Name and Value fields to add an extra info item, and click Create. These fields
allow you to add additional functionality, and is reserved for advanced users only. Contact your imple-
mentation partner for more information.
6. Click Next > Submit to save the data element.
9.3.3 Data Element for RDBMS Structure

Nakisa applications use data elements to retrieve and filter information displayed in the User Console.
Data elements are instances of one or more database tables, and have their own attributes—such as data-
base connection, table name, and fields—that are used by other configurations within the application.
104 www.nakisa.com
The Edit/Create new data element for an RDBMS structure wizard is used to define the data and table
structure passed between a relational database management system (RDBMS) and the application. This
process involves the following steps:
l Create the data element
l Define the source data table that holds the required fields
l Define the fields returned from the database
Prerequisites
Establish a connection to the RDBMS data source in the Data Connections screen before continuing.
Data Element
To create the data element for the transaction:
2. In the Data Elements section, click Edit/Create new data element for an RDBMS structure.
4. Enter a unique Name that represents the data type. The typical syntax is Object, Property and the
Representation term.
5. Enter a Description.
6. Select the Data Connection to the server that holds the required data table.
7. Click Create. The data element is added to the list.
8. Select the new Data Element, then click Next to set the server connection.
Data Connection
To set the data table in the data source:
1. In the Data Connection form, click and select the required Data Table.
2. Optional: Enter a Data Filter to return a subset of data from the table.
3. Click Next to define the required fields.
Fields
Select the fields from the data table, and specify the key fields used to link data.
To set the fields:

1. In the Fields form, click Add to load the Add Fields form.
2. Select the Field Name for the required columns, then click Add.
3. Use the page controls provided to find and add the required fields.
4. Click Done when all the fields are added.
5. Select the Key Field in the list.
6. Optional: Set a new caption for the table fields.
a. Click and enter a new Caption in the field provided.
b. Click to confirm the new caption.
Nakisa Inc. 105

9 Data Center
7. Click Next to set the data element properties


1. Use the search controls below the field list to search the required field by its name or description.
4. If applicable, select the effective Start Date and End Date fields contained in the data element.
6. Click Next > Submit to save the data element.
Preview
The Preview displays the query that is sent to the data source. Read the RDBMS table to preview the
loading time of fields for each record generated in the application.
To generate a preview:
1. Click and enter a Test Value for the parameter. For example, enter an org unit ID.
Note: The preview generates all rows in the table when Test Value is left blank.
2. Click to set the test value.
3. Click Run Query. A preview loads on the screen. The loading time for the value is presented.
4. Click Finish when the time is satisfactory.
5. Click Submit to save the data element.
9.3.4 Data Element with Custom Integration Class

Integration classes are used in exceptional cases and serve as custom command processors that use
specific methods to connect to an RDBMS database, RFC, or unusual data source (for example, using a
CSV file to generate an org chart). The Edit/Create new data element with Custom Integration Class
wizard is included in the application primarily to support some legacy features and features that require
connection to non-standard RFCs. This wizard is intended for advanced users who have good knowledge
of the Nakisa framework.
Creating data elements with custom integration classes involves the following steps:
l Create the data element
l Select the required integration class and method
l Define the input field(s) and filter(s)
l Review the output columns for each output table
l Define the output table field captions
106 www.nakisa.com
Prerequisites
l Knowledge of the custom integration class being used, as well as the Nakisa framework.
l Establish a connection to the SAP data source in the Data Connections screen.
Data Element
The first step is to create the data element.
To create the data element:

2. In the Data Elements section, click Edit/Create new data element with Custom Integration
Class.
4. Enter a unique Name that represents the data type. The typical syntax is Object, Property and the
Representation term.
5. Enter a Description.
6. Select the Data Connection to the server that holds the required data table.
7. Click Create. The data element is added to the list.
8. Select the new Data Element, then click Next to select the integration class and method.
Integration Method Selection

The next step is to select the integration class and method used for the data element.
To select the integration class:

1. In the Source list, select the required integration class. A description of each integration class is dis-
played below the list when an integration class is selected.
2. In the Method list, select the required method that is used to call the RFC or connect to the data
base. A description of the method is also displayed when a method is selected.
3. Click Next to define the input parameters.
Integration Method Input

If required, modify the filter and value for each input parameter.
To modify the input parameters:

1. In the Integration method inputs form, click next to the required parameter.
2. Leave the default Caption value as is.
3. Select the Source filter to return the required data set. The following options are available:
Nakisa Inc. 107

9 Data Center
Source Use Example

WhereClause Extract the value for the specified fields from Parameter: ID;
the WHERE clause.
Source: WhereClause;
Value: Read from the
WHERE clause at
runtime
DefaultValue Specifies a constant/default value for the para- Parameter: IW_AUTH_

meter. CHECK;
Source: DefaultValue;
Value:X
User Call specific information from the User Pop- Role

ulation at login.
Session Read session information for the user roles CLIENT

established in the portal.
DateTime Set an effective date. NOW
4. Click to confirm your changes for the parameter.

5. Click Next to preview the output table columns.
Integration Method Outputs

This wizard step allows you to preview the output table columns to ensure the correct data set is returned.
To preview the output table columns:

1. Select a primary table from the drop-down list. The Output Tables section is updated with all the out-
put tables contained in the primary table.
2. Select an Output Table. The Table Columns section lists the column name, data type, and column
description. Verify if all the values are correct.
3. If any changes are required, click Previous to modify the integration class, method, or input para-
meters.
4. If all the table columns are correct, click Next to define the field captions.
Data Field Captions

Set the required language captions for the fields configured in the previous step.
To set the field captions:

1. Select a Data Table from the drop-down list.
2. To increase the vertical size of the text boxes, select the TextArea checkbox.
3. To display the caption key for each field, select the Show Keys checkbox.
4. For each field, set the captions in the required languages.
5. Click Next.
108 www.nakisa.com

1. Use the search controls at below the field list to search the required field by its name or description.
4. If applicable, select the Start Date and End Date fields contained in the data element.
6. Click Finish, then click Submit to save the data element.
9.4 Resetting the RFC Cache

If there have been any changes to the RFC interface in the SAP server, the RFC cache in the application
must be reset. If the cache is not reset, the application could behave incorrectly when it calls the modified
RFC.
To reset the RFC cache:

3. In the Data Connections section, click Reset RFC Cache. A confirmation message appears to indic-
ate that the cache has been reset.
Nakisa Inc. 109

10 Details Designer
10
Learn how to design the Details panel and assign it to org charts and listings.
10.1 Details Designer Overview 111

10.2 Create Top-Level Details 112
10.3 Modifying the Design 112
10.3.1 About Modifying the Design 112
10.3.2 Creating Linked Details 114
10.3.3 Creating Joined Details 115
10.3.4 Adding Detail Title 116
10.3.5 Creating Table Layout 117
10.3.6 Adding Collapsible Panels 118
10.3.7 Adding Tabs 119
10.3.8 Adding Sections 120
10.3.8.1 About Adding Sections 120
10.3.8.2 XHTML Sections 121
10.3.8.3 Custom Sections 123
10.3.9 Moving Elements 123
10.3.10 Removing Elements 124
10.3.11 Style Properties 125
10.4 Layout Element and Section Reference 125
10.4.1 Section Definitions 125
10.4.2 Layout Element and Section Reference 129
10.4.3 Basic Layout Elements and Sections 130
10.4.4 Static Layout Elements and Sections 136
10.4.5 Pre-defined Sections 140
10.5 Linking Details to Hierarchies 142
10.6 Linking Org Charts to Details 143
10.7 Linking Details to Listings 144
10 Details Designer
10.1 Details Designer Overview

The Details Designer module in the Nakisa AdminConsole provides a design schematic of the Details
panel, and is used to define the data and layout displayed in the User Console. The Details panel opens
within the User Console and displays extended information about a record in tabs and collapsible panels
that organize information into specific areas of interest. Details panels are modified using top-level
details.
The Details panel is composed of the following components:
l The data element defines the source database, table, and fields. Data elements can contain multiple
linked tables from the same data connection. Use the Data Center to create new data elements.
l The detail serves as the data source for the view. It defines the data elements used in the design, and
can consist of one data element or multiple data elements that are linked or joined together. Use the
Details Designer to create details, linked details, and joined details.
l The section defines which detail fields are displayed, and arranges them in specific formats. See Sec-
tion Definitions, section 10.4.1 on page 125 for details on the different section types.
l The layout elements define the arrangement of the nested sections. Layout elements include row
tables, column tables, collapsible panels, and tabs.
The application includes pre-configured Details panel designs for each organizational object.
Workflow
Setting up the Details panels involves the following steps:
l Create or use default top-level details.
l If required, create a linked detail to include data that is not contained in the top-level detail data ele-
ment.
l If required, create a joined detail to combine data elements so that their data can be used in the same
section.
l Modify the design.
l Assign the Details panel to one or more hierarchies.
l Define which org charts can be accessed through the Details panel Actions menu (View in Org Chart
option).
l Assign the Details panel to one or more listings.
Access the Details Designer Module

To access the Details Designer, click Details Designer in the menu panel.
The options are organized into the following sections in the menu panel:
l New: Create new top-level details and link them to data elements
l Top Level Details: Modify the Details panel for each organizational object
111 www.nakisa.com
10.2 Create Top-Level Details
Create top-level details to create a Details panel that uses a different data element than the default details
included with the application. New details can be used for any org chart or listing.
To create new details:

1. In the menu panel, click Details Designer.
2. Under the New heading, click Top Level Details to create a new Details panel.
3. Enter the New detail name.
4. Select the required data element from the drop-down list. The data element defines the available dis-
play fields.
5. Click Submit. The detail is added to the corresponding list in the menu panel.
See also:
l About Modifying the Design, section 10.3.1 below
10.3 Modifying the Design
10.3.1 About Modifying the Design

Modify the layout elements in existing Details panels, or create a new design from scratch for any top-
level details you have created.
The following layout elements are displayed in the Details Designer:
Nakisa Inc. 112

10 Details Designer
Collapsible Panel: An individual frame with an editable heading.

Row table: A layout element that aligns nested elements vertically.
Column table: A layout element that aligns nested elements horizontally.
Section: A layout element where the displayed fields are defined.
Layout element selector: Additional layout elements are added to the required placeholders by
clicking and selecting the required element from the menu.
Tabs: A navigational element that displays layout elements in one frame. Tabs are used to switch
between sets of information about a record.
113 www.nakisa.com
Column tables, row tables, panels, and tabs are used as placeholders for any layout element. The Details
Designer is a customizable schematic of these elements.
The following topics explain how to use the Details Designer:
l Creating Linked Details, section 10.3.2 below
l Creating Joined Details, section 10.3.3 on the next page
l Adding Detail Title, section 10.3.4 on page 116
l Creating Table Layout, section 10.3.5 on page 117
l Adding Collapsible Panels, section 10.3.6 on page 118
l Adding Tabs, section 10.3.7 on page 119
l About Adding Sections, section 10.3.8.1 on page 120
l Moving Elements, section 10.3.9 on page 123
l Removing Elements, section 10.3.10 on page 124
l Style Properties, section 10.3.11 on page 125
10.3.2 Creating Linked Details

Create a linked detail to include data that is not contained in the top-level detail. For example, if you are
creating a Details panel for a position, you may wish to include information about the incumbent
employee. In this scenario, you would use the top-level detail for the position, then create a linked detail
based on the employee data element.
Note: Depending on the fields and data you wish to display, a new data element may be required. Use the
Data Center to create data elements.
If a section requires the fields from more than one data element, create a joined detail instead.
To create a linked detail:

2. Under the Top Level Details heading in the menu panel, click the detail you wish to modify. The
Details Designer for the selected object loads in the interface.
3. At the top of the Details Designer screen, click Create Linked Detail.
4. Enter a descriptive Detail name. The name cannot contain spaces.
5. Select the detail to link to. In the above example, the position detail would be selected.
6. Select the data element to use. In the above example, the data element containing employee inform-
ation would be selected.
7. Select the table to use from the linked data element.
The Edit Mappings section of the form is updated with the available fields from the top-level detail
(source fields) and the selected table from the linked data element (destination fields).
8. Enter a Static filter to return a subset of data from the selected data element.
9. In the Edit Mapping section, select the source and destination fields used to link the two tables,
then click the >> button. In the above example, the Position ID fields would be used.
10. Click Apply. The linked detail is created and is available for use in any Details Designer section for
the current top-level detail.
Nakisa Inc. 114

10 Details Designer
10.3.3 Creating Joined Details

Create a joined detail to combine the data contained in an existing detail with the data contained in
another data element. The fields from both data elements then become available in the joined detail, and
can be used in the same section of the Details panel.
Note: Using joined details results in multiple data calls being made for one section of data. Joining too
many details together may have an impact on the performance.
For example, if you are creating a Details panel for a position, you may wish to include information about
both the incumbent employee and the position in the same table (i.e. listing section). In this scenario, you
would create a joined detail based on the top-level detail for the position and an employee data element.
Note: Depending on the fields and data you wish to display, a new data element may be required. Use the
Data Center to create data elements.
To create a linked detail:

3. At the top of the Details Designer screen, click Create Joined Detail.
4. Enter a descriptive Detail name. The name cannot contain spaces.
5. Select the detail to link to, which is a top-level detail, a linked detail, or another joined detail.
6. Select the data element to use. In the above example, the data element containing employee inform-
ation would be selected.
7. Select the table to use from the joined data element.
The Edit Mappings section of the form is updated with the available fields from the top-level detail
(source fields) and the selected table from the joined data element (destination fields).
8. Enter a Static filter to return a subset of data from the selected data element.
9. Select the Link Type, which determines how the data element of the selected detail and the selected
data element are joined.
l Left join: Returns all rows from the "left" table, and the matching rows from the "right" table.
l Inner join: Combines the column values of two tables. The rows returned have at least one
column matching the fields in both tables.
l Side merge: Merges two tables by combining the columns of both tables, and combining the data
rows from each table side by side. If the same column appears in both tables, then the column is
not repeated and the values from the second table are returned.
l Merge: Merges two tables by combining the columns of both tables, and adding the data rows
from each table one after the other. If the same column appears in both tables, then the column is
not repeated and the values from both tables are returned.
10. In the Edit Mapping section, select the source and destination fields used to link the two tables,
then click the >> button. In the above example, the Position ID fields would be used.
11. Click Apply. The joined detail is created and is available for use in any Details Designer section for
the current top-level detail.
115 www.nakisa.com
10.3.4 Adding Detail Title
The Details Title layout element defines the tab heading for the details panel. The tab heading typically
uses one data field to display the title of the record, for example: the position title.
To set the tab heading:

3. If you are modifying a new top-level detail, do the following:
a. Click to expand the menu.
b. Mouse over Section > Name Section, then click the data element assigned to the detail. The
Edit Fields form opens
c. Select the required field for the tab, then click Apply. It is recommended to use one or two fields
for the tab.
4. If you are modifying an existing top-level detail, do the following:
a. In the Name Section, click Edit to load the Edit Fields form.
b. Select the required field for the tab.
c. Click Apply.
Nakisa Inc. 116

10 Details Designer
10.3.5 Creating Table Layout

The Row Table and Column Table layout elements organize the layout of the details panel. Dotted lines
show the boundaries of the table and its nested tables.
The following elements can be added to a table:

l Nested row and column tables
l Panels
l Tabs
l Sections (fields)
This procedure adds the table in the example above. A new placeholder is provided each time a layout ele-
ment is added to the design.
Create a table that has one column and many rows to arrange elements vertically in the design.
To create a table with two rows:

3. In the required layout element, click and select Row Table from the menu. The table is added to
the layout.
4. Click inside the new table, then add a section to create the first row.
5. Click below the first row, and add a section to create the second row.
Create a table that has one row and many columns to arrange elements horizontally in the design.
To create a table with two columns:

117 www.nakisa.com
3. In the required layout element, click and select Column Table from the menu. The table is added
to the layout.
4. Click inside the new table, then add a section to create the left column.
5. Click next to the column, then add a section to create the right column.
10.3.6 Adding Collapsible Panels

A Collapsible Panel layout element is used to frame specific details inside a named section.
A new placeholder is provided each time a layout element is added to the design.
To add a collapsible panel:

3. In the required area, click and select Collapsible Panel from the menu.
4. Click to load the Change Panel Caption dialog box.
5. Enter the English caption in the field provided.
6. Repeat the process for the additional languages, if required.
7. Click Apply. The panel is added to the layout.
Move the tables (created in the Table Layout topic) inside the panel.
Nakisa Inc. 118

10 Details Designer
To move the table:

3. Click and hold the title bar of the main row table.
4. Drag the table into the collapsible panel.
5. Release the mouse button.
The row table and all nested controls are moved to the new position.
10.3.7 Adding Tabs

Create a series of tabs to group sets of information about a record inside each tab.
This procedure adds the tabs in the example above. A new placeholder is provided each time a layout ele-
ment is added to the design.
119 www.nakisa.com
To add tabs:
3. In the required area, click and select Tabs from the menu. One tab is added to the layout.
4. Click to load the Change Tab Caption dialog box.
5. Enter the language captions for the tab in the fields provided. English is the application default.
6. Click Apply.
7. Click Add Tab, and add the next tab to the design.
10.3.8 Adding Sections

10.3.8.1 About Adding Sections
A section holds the fields used by the application, and arranges them in specific formats in the details
panel layout.
The application gathers these fields from the following sources:
l Data elements specified for the current object
l Data elements specified for the linked objects in the hierarchy
l Data elements specified for the joined objects in the hierarchy
l Data elements created in the Data Center, which are joined to the current object
l Data elements generated for the current object when creating custom org charts
l Pre-configured XSL sections that read data from the application configuration files
The fields are rendered in the Details panel using specific section types. See Section Definitions, section
10.4.1 on page 125 for descriptions of the available sections, and see Layout Element and Section Refer-
ence, section 10.4.2 on page 129 for examples of different section types in the Details Designer and User
Console.
Mouse over any section in the Details Designer layout to view the data source:
Add sections to a table (created using the steps in Creating Table Layout, section 10.3.5 on page 117) to
display specific fields from the data source in the details panel.
Nakisa Inc. 120

10 Details Designer
To create the layout in the example above:

3. Add a Column Table to the design.
4. Click in the Column Table, then select Section > Field/Value Section (Multiple) > [detail
source].
The detail sources are identified as follows:
l Top-level detail
l Linked detail
l Joined detail
Tip: Hover over the detail to see information about the data element and the data connection that
were used to create the detail. If one of these items was created outside of the Nakisa AdminCon-
sole, the type is displayed as "Unclassified". Note that for data elements, this means that it cannot
be configured in the Data Center.
5. Select the required fields in the Edit Fields dialog box. The fields listed are drawn from the selected
detail source.
6. Click Apply. The section is added to the design.
7. Click the arrows to arrange the fields in the required order.
8. Click in the Column Table, then select Row Table.
9. Click in the Row Table, then select Section > Image Section > [detail source].
10. Select the field containing the portrait link, then click Apply.
11. Click in the Row Table, then select Section > Name Section > [detail source].
12. Select the required display fields, then click Apply.
10.3.8.2 XHTML Sections
The XHTML section allows you to add any type of section defined by XHTML code. It also supports Jelly,
JavaScripts, fields, and resource bundles.
121 www.nakisa.com
The following example shows the XHTML code (which uses a resource bundle and the field
NATIONALITY_COUNTRY) and the resulting section in the Details panel.
<img src="{rb.CountryFlag:NATIONALITY_COUNTRY}"/>
<div>Nationality:<b>{rb.Nationality:NATIONALITY_COUNTRY}</b></div>
The following example shows the XHTML code, which uses a resource bundle and the fields MAIN_ID,
SOBID, and SOBID_STEXT. In the resulting Details panel, clicking the org unit name opens the Details
panel for that org unit.
<a href="#" onclick="Javascript:TriggerEvent('forceDetails',event, 'MAIN_
ID,','{SOBID}','OrgUnitDetail','directory','jobfamily');" class="link-blue
t-general-hyper-link DisableInMoreDetails"> {rb.NotApplicable:SOBID_STEXT}
</a>
To add an XHTML section:

3. If required, add a table, panel, or tab to the design.
4. Click in the required area, then select Section > XHTML > [detail source].
l Top-level detail
l Linked detail
l Joined detail
5. Enter the required XHTML code.
6. If any fields need to be passed in the template XHTML, make sure that they are selected under List
of Fields.
7. Click Apply. The XHTML section is added to the design.
See also:
l Resource Bundle Configuration, section 5.9 on page 49
Nakisa Inc. 122

10 Details Designer
10.3.8.3 Custom Sections

Administrators can upload and use their own custom section templates (XSL files).
Note: To create custom XSL files, contact your implementation partner.
To upload and use the custom XSL files:

1. Create a ZIP file with all of the custom XSL files. Ensure that you use the directory structure
/Root/CustomizedXsl/ in the ZIP file.
2. Upload the ZIP file using the method described in Uploading Content, section 17.5 on page 197.
5. If required, add a table, panel, or tab to the design.
6. Click in the required area, then select Section > Customized Xsl Section Designer > [detail
source].
l Top-level detail
l Linked detail
l Joined detail
7. If you have uploaded more than one custom XSL file, select the required file from the drop-down list at
the top of the Edit Fields dialog box.
8. Select the required fields. The fields listed are drawn from the selected detail source.
9. Click Apply. The customized section is added to the design.
10.3.9 Moving Elements

Move layout elements or sections to a different area in the details panel design.
This example moves the Field/Value Section into the Row Table to its left.
123 www.nakisa.com
To move the section:
3. Click and hold the top bar of the Field/Value Section.
4. Drag the section into the Row Table.
5. Release the mouse button when the Column Table top bar is highlighted.
The section is moved inside the Row Table.
10.3.10 Removing Elements

These steps remove fields, layout elements, and tabs from the details panel layout.
To remove elements:
3. Do one of the following to remove a element:
l Click Edit in a section, clear the required checkbox to remove a field, and click Apply.
l Click to remove a layout element. Any nested elements are also removed.
l Click to remove a tab. Any nested elements in the tab are also removed.
Nakisa Inc. 124

10 Details Designer
10.3.11 Style Properties

Customize the appearance of panels and tables with Cascading Style Sheet (CSS) markup language.
To set style properties:

3. Locate the required panel or table.
4. Click Properties in the top bar. The Properties dialog box appears.
5. Enter one or both of the following:
l CSS declarations for the Style, for example: color:orange; text-align:center;
l A CSS Class for the panel or table. The CSS classes are defined in files located in
[application directory]/_Themes and [application directory]/_ThemesRTL
(for right-to-left languages).
6. To display a collapsed panel when the Details panel is opened, click the Collapsed by default
checkbox (applicable for collapsible panels only).
7. Click Apply.
10.4 Layout Element and Section Reference
10.4.1 Section Definitions

The tables below list all the layout sections used in the Details Designer, and a short description of their
purpose.
Predefined Sections
Element Description
Org Silo Displays the direct and indirect reporting relationships above the current
org unit.
EmpPos Silo Displays the position and its incumbent. This section is typically placed
(Employee Position Silo) below the org unit silo section.
Call From Section Adds a drop-down list containing countries. Users select the country from
which they are calling, and any telephone, fax, or mobile phone number dis-
played in the details panel is updated with the complete number to dial
from the selected country.
125 www.nakisa.com
Static Layout
Element Description
EmployeeBusinessCard Displays employee information in a rectangular box. Links are
displayed for the employee and position name fields (used to
access the respective Details panels), as well as the e-mail
address. If the current record has multiple incumbents, a sep-
arate business card is displayed for each employee.
This static section must be used with the related Business
Card sections.
EmployeeTabs Displays employee information in a tabbed interface. If the cur-

rent record has multiple incumbents, a separate tab is rendered
for each employee. Links are displayed for the employee name
and e-mail fields.
This static section must be used with the related Employee Tab
sections.
Section
Element Description
XHTML Displays sections defined by XHTML code.
Customized XSL Section Displays custom sections that have been uploaded to the Nakisa
Designer AdminConsole. Once the data element has been selected, the Custom
XSL Section Designer dialog box provides a drop-down list of all the
uploaded custom XSL section files.
Error Correction Button Displays a button that links to the error correction URL. When users click
the button for an open error and then return to the User Console, the dia-
log box to change the status to "In Progress" automatically opens. If the
error was already the In Progress state, then the dialog box to add a com-
ment opens.
The following fields must be selected for this section:
l Error ID (ERRORS_ERRORID)
l ErrorCorrectionURL (RULE_ERRORCORRECTIONURL)
l Object Type (ERRORS_OBJECTDESCRIPTIONID)
l Severity (ERRORS_PRIORITYID)
l Status (ERRORS_STATUSID)
l OrgUnit ID (ERRORS_ORGUNITID)
l Postion ID (ERRORS_POSITIONID)
l Employee ID (ERRORS_EMPOYEEID)
l Audit Run ID (AUDIT_EXTRACTID)
Nakisa Inc. 126

10 Details Designer
Element Description
Score Org Unit Severity (1 Displays the errors by group and severity for an org unit. Used in the org
of 3) unit Details panel for the Organization Structure org chart and Org Unit
Listing.
Used with the org unit Grouped Score Details (section 2) and org unit
Grouped Score Details (section 2).
Note that all of the available fields need to be selected in this section.
Score Org Unit Group (2 of Displays the score for each group for an org unit. Used in the org unit
3) Details panel for the Organization Structure org chart and Org Unit List-
ing.
Used with the org unit Severity Grouped Score Details (section 1) and
the org unit Score Details (section 3).
Score Org Unit Rule (3 of Displays the score for all of the rules in each group for an org unit. Used
3) in the org unit Details panel for the Organization Structure org vhart and
Org Unit Listing.
Used with the org unit Severity Grouped Score Details (section 1) and
the org unit Score Details (section 3).
Score CompCode Sever- Displays the errors by group and severity for a company. Used in the
ity (1 of 3) Details panel for the Company Code org chart and listing.
Used with the Score CompCode or Position Group (2 of 3) and Score
CompCode Rule (3 of 3).
Score CompCode Rule (3 Displays the score for all of the rules in each group for a company. Used
of 3) in the Details panel for the Company Code org chart and listing.
Used with the Score CompCode Severity (1 of 3) and Score CompCode
or Position Group (2 of 3).
Score CompCode or Pos- Displays the score for each group for a company or a position. Used in
ition Group (2 of 3) the Details panel for the Company Code org chart and listing, or in the
position Details panel for the Position listing.
Used with the Score CompCode Severity (1 of 3) and Score CompCode
Rule (3 of 3), or with the Score Position Severity (1 of 3) and Score Pos-
ition Rule (3 of 3).
Score Position Severity (1 Displays the errors by group and severity for a position. Used in the pos-
of 3) ition Details panel for the Position listing.
Used with the Score CompCode or Position Group (2 of 3) and Score
Position Rule (3 of 3).
127 www.nakisa.com
Element Description
Score Position Rule (3 of Displays the score for all of the rules in each group for a position. Used in
3) the position Details panel for the Position listing.
Used with the Score Position Severity (1 of 3) and Score CompCode or
Position Group (2 of 3).
All Errors Embedded List- Used in the All Errors tab in the org unit Details panel. When you click on
ing a row, the Details panel for that error opens.
Position Employee Pair Displays employee names and their positions. Position names are dis-
Section played as a link that users can click to access the position Details panel.
This section is typically mapped to different data sources to display the
following organizational relationship:
l Positions to which the current employee or position reports.
l Positions the current employee or position manages.
l Positions that are in the same organizational level as the current
employee or position.
l Dotted-line relationships.
Position Employee Pair Similar to the Position Employee Pair section, except that the position
(no hyperlink) names are not displayed as links.
Position and Org Unit Displays org unit and position information. Note that the org unit name is
Details (no hyperlink) not displayed as a link.
Business Card Name This section should be assigned to the Heading Name component in the
Header Business Card static layout.
Business Card Name This section should be assigned to the Employee Name and ID com-
ponent in the Business Card static layout. Up to two fields can be selec-
ted for this section.
Business Card Title This section should be assigned to the Position Title and ID component
in the Business Card static layout. Up to two fields can be selected for
this section.
Business Card Contact This section should be assigned to the Telephone, Email, and Location
Details components in the Business Card static layout.
Employee Tab Name This section should be assigned to the Employee Name component in
the Employee Tab static layout.
Employee Tab Data Sheet This section should be assigned to the Employee Data Sheet component
in the Employee Tab static layout. Up to five fields can be selected in
this section.
Employee Tab Position This section should be assigned to the Employee Position component in
Name the Employee Tab static layout. Up to three fields can be selected in this
section. All of the fields are displayed as clickable links that lead to the
related position Details panel.
Nakisa Inc. 128

10 Details Designer
Element Description
Employee Tab Portrait This section should be assigned to the Employee Picture component in
the Employee Tab static layout.
Employee Tab Contact This section should be assigned to the Contact Info component in the
Info Employee Tab static layout. Up to four fields can be selected in this sec-
tion.
Employee Extended Pro- This section should be assigned to the Employee Extended Profile -
file - Employee Group Info Employee Group Info component in the Employee Tab static layout.
Detail Header Section Adds a header with a colored rule line underneath. The header can dis-
play position, job or organization information, followed by a user-defined
caption. The color of the rule line is customizable.
Image Section Displays a portrait.
Field Value Section Adds one field name and its value. The information that can be displayed
is related to position, job or organization. For example, selecting Job
Name might display "Job Name" (the field name) followed by "Manager"
(the field's value).
Name Section Adds field values. The values that can be displayed are related to pos-
ition, job or organization. If multiple fields are selected, they will appear
written out in customizable sequence.
Field/Value Section (Mul- Similar to the Field Value section, except that it can display more than
tiple) one field name and value.
Name Section (Multiple) Similar to the Name section, except that the first two fields are displayed
like a field name (bold).
Listing Section Displays each selected field as a column in a listing, and displays each
relevant record as a row in the listing.
Note: The Details panels can be further customized (for example, by adding graphs and charts). Contact
your implementation partner for more information.
10.4.2 Layout Element and Section Reference

The topics that follow provide details on the layout elements and sections used in the Details Designer.
Screenshots show various Details panel designs as they appear in the User Console and their cor-
responding configuration in the Nakisa AdminConsole. Callouts identify the layout elements and sections
used in each design.
Basic Layout Elements and Sections

The Basic Layout Elements and Sections topic provides details on commonly-used Details panel ele-
ments.
The following layout elements are covered in this topic:
129 www.nakisa.com
l Row table
l Column table
l Collapsible panel
l Tabs
The following sections are covered in this topic:
l Detail Header
l Name
l Field/Value
l Listing
l Image
l Position Employee Pair (no hyperlink)
l Position and Org Unit Details (no hyperlink)
Static Layout Elements and Sections

The Static Layout Elements and Sections topic provides details on the pre-configured elements that dis-
play employee information.
The following layout elements are covered in this topic:
l Employee Business Card
l Employee Tabs
The following sections are covered in this topic:
l Business Card Name Header
l Business Card Name
l Business Card Title
l Business Card Contact Details
l Employee Tab Name
l Employee Tab Data Sheet
l Employee Tab Position Name
l Employee Tab Portrait
l Employee Tab Contact Info
10.4.3 Basic Layout Elements and Sections

Commonly-used layout elements and sections are outlined in this topic. Two different design examples
are provided:
l The first example shows two screenshots of the same Details panel design as it appears in the User
Console; the first screenshot identifies the layout elements and the second identifies the sections
used in the design. An additional screenshot illustrates the Details Designer configuration for this
example.
l The second example focuses on the Position and Org Unit Details (no hyperlink) and Position
Employee Pair (no hyperlink) sections. Screenshots show how these sections are displayed in the
Details panel and the corresponding configuration in the Details Designer.
Nakisa Inc. 130

10 Details Designer
Note: The following examples are for illustrative purposes; some fields and/or sections may not be avail-
able in all applications.
Layout Elements
Layout elements can contain multiple sections and/or layout elements nested within them. In the example
below, the collapsible panel contains a nested column table, which in turn contains a nested row table.
The row table contains two nested sections that use different data sources.
Sections
A typical details panel includes multiple sections. Each section is connected to a data source that
retrieves the required fields, enabling you to display information from multiple data sources. In the
example below, there are two different Field/Value (Multiple) sections in the collapsible panel; the first
uses a data source to display basic position information, while the second uses another data source to dis-
play cost center information.
Note that some sections have a limit to the number of fields. The Name, Detail Header, and Field/Value
sections only display one field. Use the Name (Multiple) and Field/Value (Multiple) sections to display mul-
tiple fields.
131 www.nakisa.com
Nakisa Inc. 132
10 Details Designer
Details Designer Configuration

The following Details Designer configuration produces the result shown in the preceding screenshots.
Position Employee Pair and Position and Org Unit Details Sections
The following example illustrates the use of these two sections:
l The Position and Org Unit Details (no hyperlink) section can include up to six fields.
l The Position Employee Pair (no hyperlink) section displays employee names and their positions.
This section is typically mapped to different data sources to display the following organizational rela-
tionships:
l Position(s) to which the current employee or position reports
l Position(s) the current employee or position manages
l Position(s) that are in the same organizational level as the current employee or position
l Dotted-line relationships, if any
133 www.nakisa.com
Both these sections are typically used for position or employee Details panels.
Details Designer Configuration

The following Details Designer configuration produces the result shown in the preceding screenshot. Note
that each Position Employee Pair section uses a different data source to display the required information.
Nakisa Inc. 134

10 Details Designer
135 www.nakisa.com
10.4.4 Static Layout Elements and Sections
The application includes two static layout elements that display employee information:
l Employee Business Card displays employee information in a rectangular box. Links are displayed
for the employee and position name fields (used to access the respective Details panels), as well as
the e-mail address. If the current record has multiple incumbents, a separate business card is dis-
played for each employee.
l Employee Tabs displays employee information in a tabbed interface. If the current record has mul-
tiple incumbents, a separate tab is rendered for each employee. Links are displayed for the employee
name and e-mail fields.
Nakisa Inc. 136

10 Details Designer
The layout of both these elements is pre-configured and cannot be changed. Specific sections should be
used in these elements, as illustrated in the following examples.
Note: Static layout elements cannot be directly removed, as they do not include the icon. To remove a
static layout element, create an empty row or column table, drag the static layout element into the table,
then click to remove the table and the nested static layout element. Also note that a Details panel can-
not contain the same static section more than once.
Employee Business Card

The following is an example of the business card as it appears in the User Console. Callouts identify the
business card components as they appear in the Details Designer.
Employee Business Card Configuration

The following Details Designer configuration produces the result shown in the preceding screenshot. Cal-
louts identify the sections to use for each business card component. To add sections to the business
card, click next to the component. Green check marks indicate that a section has been assigned.
137 www.nakisa.com
Employee Tabs
The following is an example of the employee tab for a position with two incumbents as it appears in the
User Console. Callouts identify the employee tab components as they appear in the Details Designer.
The extended employee profile only appears in the User Console for users with an executive role.
Note: The extended employee profile is not displayed if the employee tab is used for custom org charts.
Nakisa Inc. 138

10 Details Designer
Employee Tabs Configuration

The following Details Designer configuration produces the result shown in the preceding screenshot. Cal-
louts identify the sections to use for each employee tab component. To add sections to the employee tab,
click next to the component. Green check marks indicate that a section has been assigned.
139 www.nakisa.com
10.4.5 Pre-defined Sections
The application includes pre-defined sections, such as:
l Org unit silo displays the direct and indirect reporting relationships above the current org unit.
l Employee Position silo displays the position and its incumbent. This section is typically placed
below the org unit silo section to display the desired results (see the Silo screenshot below).
All pre-defined sections are only available for default org charts.
Silo
The following silo sections display the direct and indirect reporting relationships of the selected record.
The example below shows the silo report for a position. The pre-defined silo sections are only available for
default org charts. Contact your implementation partner to create similar sections for custom org charts.
Nakisa Inc. 140

10 Details Designer
141 www.nakisa.com
Silo Configuration
The following Details Designer configuration produces the result shown in the preceding screenshot.
10.5 Linking Details to Hierarchies

Top-level details can be linked to one or more hierarchies. This allows you to create one Details panel for
an organizational object and then link it to all hierarchies containing that object. Any top-level detail that is
not linked to a hierarchy or a listing will not be used in the User Console.
Tip: Top-level details can also be assigned to org charts in the Select Detail step of the org chart con-
figuration wizard. However, this method only allows you to assign a top-level detail to the selected hier-
archy. The procedure below is optimal for assigning a top-level detail to multiple hierarchies.
To link a top-level details to a hierarchy:

3. If required, modify the design of the selected detail.
4. Click the wizard step Used in Org Charts.
5. Select the Org Chart containing the required hierarchy.
Nakisa Inc. 142

10 Details Designer
Org charts can consist of one or more hierarchies. Therefore, top-level details are linked to the under-
lying hierarchy and not the org chart itself.
6. Select the required Hierarchy, then click Set as Hierarchy Detail. The table at the bottom of the
form is updated with the org chart and hierarchy name.
Note: Although a top-level detail can be linked to multiple hierarchies, any given hierarchy can only
use one top-level detail. If the selected hierarchy is already linked to another top-level detail, that link
is removed and updated with the new top-level detail.
7. In the table, select the Data Element Field used to link to the hierarchy ID field.
8. If required, repeat steps 5 through 7 to link the same top-level detail to another hierarchy.
9. If no other changes are required, click Finish > Submit. Otherwise, click one of the wizard links to:
l Define which org chart(s) can be accessed through the Details panel Actions menu (View in Org
Chart option)
l Assign the Details panel to one or more listings
10.6 Linking Org Charts to Details

From the Details panel Actions menu, users can view the current record of the root hierarchy as the root
node in an org chart. This functionality also works for child hierarchies, however the record's parent node
will become the root node. If using this functionality for child hierarchies, the following conditions must be
met:
l The child hierarchy must be linked the root hierarchy, and not any other child hierarchy.
l The child hierarchy must not be recursive (i.e., the hierarchy cannot be linked to another of its type).
The following procedure enables this feature by linking one or more org charts to the Details panel.
To link an org chart to a top-level detail:

4. Click the wizard step Viewed in Org Charts.
5. Select the Org Chart that will be accessed through the Details panel Actions menu.
Note: For child hierarchies, make sure to specify its root org chart and hierarchy.
6. Select Expand Groups to display all child nodes of the user-selected record.
7. Click Set as View in Org Chart Detail. The org chart is added to the table at the bottom of the
form.
8. If required, repeat steps 5 through 7 to link additional org charts to the top-level detail.
9. To remove a linked org chart, click next to the org chart in the table at the bottom of the form.
l Assign the Details panel to one or more hierarchies
l Assign the Details panel to one or more listings
143 www.nakisa.com
10.7 Linking Details to Listings
A top-level detail can be linked to one or more listings. This allows you to create one Details panel for an
organizational object and then link it to all listings containing that object.
Tip: Top-level details can also be assigned to listings in the Select Detail step of the listing configuration
wizard. However, this method only allows you to assign a top-level detail to the selected listing. The pro-
cedure below is optimal for assigning a top-level detail to multiple listings.
To link a top-level detail to a listing:

4. Click the wizard step Used in Listings.
5. In the Directories not using selected detail section, select the Directory name (listing) to which
you wish to link the top-level detail.
6. Click Use selected detail with directory. The selected listing is updated in the Directories using
selected detail drop-down list and the Field Mappings table is updated with the key field of the listing.
Note: Although a top-level detail can be linked to multiple listings, any given listing can only use one
top-level detail. If the selected listing is already linked to another top-level detail, that link is removed
and updated with the new top-level detail.
7. In the Field Mappings table, select the Detail Field used to link to the listing key field.
8. If required, repeat steps 5 through 8 to link the same top-level detail to another listing.
l Assign the Details panel to one or more hierarchies.
l Define whichorg chart(s) can be accessed through the Details panel Actions menu (View in Org
Chart option).
Nakisa Inc. 144

11 Org Charts
11
Learn how to configure org charts in the application.
11.1 Org Chart Overview 146

11.2 Org Chart Configuration 148
11.2.1 Enable/Disable 148
11.2.2 Assistant and Council Display Settings 148
11.2.3 Print and Export Templates 149
11.3 Hierarchy Configuration 150
11.3.1 Data Connection 150
11.3.2 Fields 151
11.3.3 Root Hierarchies 152
11.3.4 Linked Hierarchies 153
11.3.5 Assistant and Council Filters 155
11.3.6 Subcategory Groups 156
11.3.7 Selected Item Fields 157
11.3.8 Sort Fields 157
11.3.9 Select Details 158
11 Org Charts
11.1 Org Chart Overview

Organization charts—or org charts—graphically show the hierarchical authority, roles and responsibilities,
and relationships in an organization.
Nakisa OrgAudit includes organizational charts (org charts) that indicate the formal structure of a busi-
ness or company, but uses this structure to display data, such as error counts, severity, and error cor-
rection trends.
Org charts consist of one root hierarchy and may include one or more underlying hierarchies that are
linked. For example, a single-hierarchy org chart can display the reporting relationships of positions, while
a more complex org chart can link several hierarchies to show the relationships between org units (or
departments), positions, and employees.
The Audit View module in the Nakisa AdminConsole is used to set up the org chart, link the required hier-
archies, and define the org chart box views for each organizational object.
The following screenshot shows how org charts and hierarchies are organized in the OrgChart menu
panel:
Note: The above screenshot is for illustrative purposes only, and does not correspond to the org charts
available in the application.
Note: Org charts and listings can only be modified once the staged database has been set up. See Applic-
ation Overview, section 2.1 on page 6 for more information.
Configuring org charts involves the following steps:
l Define the general org chart settings:
l Enable the org chart and assign it to a module.
l Set up how assistants and councils appear in the org chart (optional).
l Define the template used in the Enhanced-mode (Flash) print and export wizards.
l Finish and submit the changes
146 www.nakisa.com
l Set up the root hierarchy:
l Connect to the data source.
l Add fields from the data source tables, and set the key field.
l Define the fields used to set up the root hierarchy structure.
l Set up how assistant and council records are retrieved from the database (optional).
l Group similar records into one org chart box using sub-category groups (optional).
l Define the fields displayed in the Selected Items panel.
l Link the required Details panel to the org chart.
l Design the org chart box views.
l Finish and submit the changes.
l Set up the linked (or child) hierarchies (if applicable):
l Add fields from the data source tables, and set the key field.
l Define the fields used to set up the child hierarchy structure, and then link it to its parent hier-
archy.The parent hierarchy can be the root hierarchy or another linked hierarchy. For example, in
an org unit-position-employee org chart, the position hierarchy is linked to the org unit hierarchy
(which is the root hierarchy), and the employee hierarchy is linked to the position hierarchy (which
is a linked hierarchy).
l Set up how assistant and council records are retrieved from the database (optional).
l Group similar records into one org chart box using sub-category groups (optional).
l Define the fields displayed in the Selected Items panel.
l Link the required Details panel to the org chart.
l Design the org chart box views.
Org Chart Description

Organization Structure Shows the org unit (department) hierarchy and its reporting pos-
itions. This org chart comprises two hierarchies: org unit and pos-
ition.
Company Code Shows the organizational structure by company code. This org
chart comprises one hierarchy: company code.
Position Shows the self-referencing relationship between positions in the

organization. The position-to-position S A002 to S relationship
must be maintained on the SAP server for this org chart to func-
tion. This org chart comprises one hierarchy: position.
The default org charts display data errors in the org chart box for each organizational object.
Nakisa Inc. 147

11 Org Charts
11.2 Org Chart Configuration
11.2.1 Enable/Disable
This procedure enables an org chart in the User Console.
To enable an org chart:

1. In the menu panel, click Audit View to load the module.
2. Under the OrgChart heading, click the required org chart. The Enable/Disable form loads by default.
3. Select Yes to enable the org chart, or No to disable it.
4. Enter a new Caption using company-specific terms, or leave the default. This caption appears in the
Nakisa AdminConsole menu panel as well as the module menu in the User Console.
5. Click to enter translated text for the caption, and click to accept the changes.
6. In the Assign to Module section, select Audit in the Module field. This setting assigns the org
chart to the Audit module in the User Console. The org chart will not appear in the User Console if
another value is selected.
7. Click Next to proceed to the next step, or click Finish.
11.2.2 Assistant and Council Display Settings

If required, the application can display assistant and council org units or positions separately from the reg-
ular structure for easy identification. There are two steps to configuring assistant and council org chart
nodes:
l In the Assistant/Council org chart wizard step, define how assistant and council org chart nodes are
displayed in the User Console.
l In the General Settings hierarchy wizard step, set the filter to identify assistant and council records.
Note: This feature is currently not applicable to Nakisa OrgAudit.
Assistant Display Settings

Define how assistant org chart nodes are displayed in the User Console.
To define assistant display settings:

1. In the menu panel, click Audit View to load the module, then select the required org chart under the
OrgChart heading.
2. Click Assistant/Council, then go to the Assistant Configuration section.
3. Select the Default Display. There are three options:
l Hide assistants: Assistant records do not appear in the org chart
l Show assistants as regular box: Assistant records appear as regular nodes in the org chart.
l Show assistant as assistant box: Assistant records appear as offset nodes in the org chart.
4. To change to positioning of assistant nodes, click next to an org chart style, select the required
assistant alignment, then click .
148 www.nakisa.com
Note: Currently, only the Horizontal Org Chart style supports different assistant positioning. All other
styles display assistants to the right of the org unit or position to which they report.
l To set up how Council org chart nodes are displayed in the User Console, follow the procedure
below.
l To define the print and export templates for the org chart, click Next.
l If no other settings are required, click Finish.
Council Display Settings

Councils are org units, departments, or positions that are not part of the normal reporting structure but
have an impact on the organization. Typical examples of councils include committees and advisory
boards. Once configured, the application displays any council records as independent nodes in columns
to the left of the org chart.
Note: Council records are only displayed independently if they belong to the root node currently displayed
in the application. Any council records that belong to another branch are displayed as part of the normal
reporting structure.
To define council display settings:

OrgChart heading.
2. Click Assistant/Council, then go to the Council Configuration section.
3. Select the Default Display to show or hide council nodes in the org chart.
4. Enter the Maximum number of boxes per column for each org chart style.
Based on this value, the application determines the optimal display of council boxes to limit the
amount of white space. For example, if a value of "5" is entered and there are six council boxes, the
application will display them in two columns with three boxes in each column.
l To define the print and export templates for the org chart, click Next.
11.2.3 Print and Export Templates

Users can create or select a template when printing or exporting Enhanced-mode org charts. Templates
contain pre-defined text for the headers and footers that can be modified by users (in the Enhanced-mode
print wizard) and by administrators (in the Print/Export form of the org chart configuration wizard). In addi-
tion, administrators can also add dynamic headers and footers that display field values of the root node for
the selected org chart. Separate templates can be created for the root hierarchy of each org chart.
Note: Print and export templates support the Enhanced-mode print wizard only.
To modify a Flash-mode print and export template:

OrgChart heading.
Nakisa Inc. 149

11 Org Charts
2. In the wizard navigation panel, click Print/Export. The default template loads in the interface with
separate text boxes for the header and footer texts.
3. Edit the Header text:
a. In the Fields Available for Use in Header section, click the required field(s) to add them to the
header. All fields selected in the Fields wizard step for the current org chart are listed in this sec-
tion.
b. If required, enter any additional text in the Header text box.
c. Use the formatting controls below the text box to adjust the font type, size, style, and color, as
well as the text justification.
4. Repeat the above step for the Footer text.
5. Click Next > Submit.
Additional templates may be created in the User Console and imported into the Nakisa AdminConsole
using the following procedure:
To add new Flash-mode print and export templates:

1. In the User Console, create and save the required template. Refer to the User Guide for more inform-
ation.
2. In the Nakisa AdminConsole, import the template using the Upload Content button or the Add-On
Manager.
3. If required, the imported template can be modified using the previous procedure.
4. Publish the build. The new templates are now accessible to all users.


11.3 Hierarchy Configuration
11.3.1 Data Connection

In the Data Connection screen, configure the connection to the main data source for organization data.
These fields are already pre-populated when you set up the staged database for either the SAPExtractor
or to extract audit data. Use the following procedure if you need to modify the data connection, but note
that it will also affect the data connection for the SAPExtractor, audit extraction, and listings.
The data connection and data element names used for the current hierarchy are displayed in bold. These
names are retrieved from the corresponding data connections and data elements in the Data Center.
150 www.nakisa.com
Tip: Click on the icon for information about the org chart type and name, hierarchy name, data element
type and name, and the data connection type and name. If one of these items was created outside of the
Nakisa AdminConsole, the type is displayed as "Unclassified". Note that for data elements, this means
that it cannot be configured in the Data Center.
To establish a connection to a staged database:

1. In the menu panel, click Audit View to load the module, then select the required hierarchy under the
OrgChart heading.
2. Click Data Connection.
name.
For example: 192.168.0.148:1521:ora92
l TNS entry name
4. Enter the Initial Catalog to specify the database name for the data source. Skip this step for Oracle
databases.
5. Enter the User Name and Password for accessing the database.
6. Click Test Connection. A message indicates when the connection is successful.
7. Click to activate the drop-down list, then select the required Data Table that contains the fields for
the org chart.
8. Enter a Data Filter, if required.
9. Click Next to set up the org chart fields, or click Finish.
11.3.2 Fields
Add fields from the data source and set the key field(s) for an organizational object.
Note: Ensure the data connection is set before continuing.
To set the fields:

OrgChart heading.
2. Click Fields.
Nakisa Inc. 151

11 Org Charts
3. Click Add to load the Add Fields form.

4. Select the required fields, then click Add.
5. Use the page controls below the table to find and add the required fields.
7. Select the Key Field that uniquely identifies the record type.
The key fields are used to:
l Create an object hierarchy.
l Link hierarchies.
A typical example is the org unit ID field, and the position Object_ID and ParentNo fields.
8. Optionally, modify the field caption of an existing field:
a. Click to activate the required field.
b. Enter a new caption for the field.
c. Click to accept the caption.
9. Click Next to set up the hierarchies, or click Finish.
11.3.3 Root Hierarchies

Org charts consist of one root hierarchy and may include one or more underlying hierarchies that are
linked. Configure the root hierarchy first using the procedure below, then configure the linked hierarchies
(if applicable).
Note: Ensure that the fields are defined for each organizational object before continuing.
To set up the root hierarchy:

1. In the menu panel, click Audit View to load the module, then select the required root hierarchy under
the OrgChart heading.
2. Click General Settings.
3. Enter the hierarchy Caption. This caption appears in the Nakisa AdminConsole menu panel.
Tip: Click next to the fields described below to activate drop-down lists.
4. Select the required Hierarchy ID Field for the organizational object. This field holds the unique ID of
each record in the object table.
5. Select the required Hierarchy Parent Field. This field identifies the parent ID field in the object table.
The record is the top-level parent (root) if the parent ID is 0 (or NULL).
6. Select the required Element ID Field for the object. The element ID is the unique identifier of the
record if IDs are shared among objects.
7. Enter the Child Exists Filter to identify the field in the object table that indicates when a record has
children. The filter HasChildren = 'TRUE' is the default. A data call is sent to the server if this
option is left blank.
8. Select the Org chart root value source. This defines where the application retrieves the root record
from. The available options are:
l Org Chart Root or Static: Retrieves the record specified in the next step from the hierarchy data
element.
152 www.nakisa.com
l User Record: Retrieves the record specified in the next step from the employee data element.
Note: The User ID is not functional in this release of the application.
9. Do one of the following to define the org chart root:
l If OrgChart Root or Static was selected in the previous step, enter the Org chart root value ID.
l If User Record was selected in the previous step, select the field containing the ID of the required
organizational object in the employee data element from the User record field drop-down list. For
example, if you wish to root the org chart at the org unit of the logged-in user, select the field con-
taining the org unit ID. Note that dynamic rooting cannot be set up for the Company Code Org
Chart.
Note: If you root the org chart at the logged-in user's organizational object, ensure that the
Employee Source step in the Security Settings > Authentication Settings wizard is completed.
10. Set Page limits to determine the number of children that appear under a parent when the branches
and groups in the structure are expanded. There are additional controls in the org chart box that allow
you to view the additional children that do not fit on the page.
11. Select the Parent Description Field. This value appears when starting the org chart one level above
the current node.
12. Enter a Dotted Relationship Filter to identify the field and value that indicate when a record has a
dotted-line relationship.
13. Click inside the Color field, then select a color. This color is used to identify the object type and is dis-
played on the left border of the org chart box (in the org chart and the Selected Items panel) as well as
the expand and collapse buttons for the object.
14. Select the Default Style for the org chart.
15. If required, configure one or more of the following optional tasks in the General Settings form. Other-
wise, click Next to set up the Sort Fields, or click Finish.
l Assistant Configuration is used to define a filter for assistant org units and/or positions that are dis-
played separately from the reporting structure.
l Council Configuration is used to define a filter for council org units and/or positions that are dis-
played outside the reporting structure.
l Subcategory Group Settings is used to combine similar records into one org chart box.
l Selected Items Settings is used to set the fields that are displayed in the Selected Items panel.
11.3.4 Linked Hierarchies

Org charts may contain multiple hierarchies that are linked together. Each linked (or child) hierarchy must
be configured separately and then linked to its parent hierarchy.
Note: Ensure that the fields are defined for the hierarchy before continuing.
Child Hierarchies
To set up the child hierarchy:
1. In the menu panel, click Audit View to load the module, then select the required child hierarchy under
3. Enter the hierarchy Caption. This caption appears in the Nakisa AdminConsole menu panel.
Nakisa Inc. 153

11 Org Charts
4. Select the required Hierarchy ID Field for the organizational object. This field holds the unique
object ID of each record in the object table.
5. Select the Hierarchy Parent Field. This field identifies the parent ID field in the object table.
6. Select the Element ID for the object.
7. Enter a Child Exists Filter for child nodes.
8. Enter a Dotted Relationship Filter to identify the field in the position table that indicates when a
record has a dotted-line relationship with an org unit.
Linking Hierarchies
The final task is to link the child hierarchy to the parent hierarchy.
In the following procedure, subordinate positions are grouped by the ParentNo field, and then joined to
the parent hierarchy using the org unit ID field. The link between hierarchies is established using a Fil-
terData query.
To link the hierarchies:

1. In the menu panel, click Audit View to load the module, then select the required child hierarchy under
2. Click General Settings and go to the Link Information section.
Note: The Linked From field indicates the parent hierarchy name, and is unavailable for editing.
3. Enter the Linked Using field of the parent hierarchy. Note that this field must have the same value
as the Hierarchy ID Field entered for the org unit.
4. Enter ParentNo in the Grouped by field. The ParentNo stores the org unit ID of each position, as
outlined in the position table.
5. Select FilterData as the Link Operation.
FilterData queries the ParentNo field of the position to define the link between hierarchies.
The ParentChild link operation is specific to LDAP tree hierarchies.
6. Enter a Static Filter to reduce the records returned by the server.
7. Enter the Group Child Exists Filter for grouped children.
8. Click inside the Color field, then select a color. This color is used to identify the object type and is dis-
played on the left border of the org chart box (in the org chart and the Selected Items panel) as well as
the expand and collapse buttons for the object.
154 www.nakisa.com
11.3.5 Assistant and Council Filters
If required, the application can display assistant and council org units or positions separately from the reg-
ular structure for easy identification. There are two steps to configuring assistant and council org chart
nodes:
l In the Assistant/Council org chart wizard step, define how assistant and council org chart nodes are
displayed in the User Console.
l In the General Settings hierarchy wizard step, set the filter to identify assistant and council records.
Note: This feature is currently not applicable to Nakisa OrgAudit.
Assistant Filter Settings

A filter is used to identify assistant records, and the positioning of the records is defined for each org chart
style. By default, the application uses the assistant field (technical name: STABS) in infotype 1003
(Department/Staff) to filter assistant records.
To configure the assistant filter:

OrgChart heading.
2. Click General Settings, then go to the Assistant Configuration section.
3. Enter an Assistant Filter to identify assistant records.
By default, Assistant = 'X' is used to retrieve assistant records from the SAP system. If the fil-
ter is left blank, then assistant records are displayed as part of the normal reporting structure.
4. If required, clear the Add Null-Safe Filter checkbox. This filter ensures that assistant records with
the assistant field set to NULL will still be retrieved when the assistant subcategory has been hidden
(from either the Nakisa AdminConsole or from the User Console).
Warning: Nakisa recommends leaving this checkbox selected, otherwise unexpected results may
occur (especially with SQL staged databases). Note that even if this field is cleared and the build is
published, every time the Nakisa AdminConsole is loaded, the field will be selected again.
l To set up the council filter, follow the procedure below.
l To combine similar records into one org chart box, configure the Subcategory Group Settings.
l To set the fields that are displayed in the Selected Items panel, configure the Selected Items Set-
tings.
l To set the fields the user can select to sort the org chart diagram, click Next to configure the Sort
Fields.
Council Filter Settings

Councils are org units, departments, or positions that are not part of the normal reporting structure but
have an impact on the organization. Typical examples of councils include committees and advisory
boards. Once configured, the application displays any council records as independent nodes in columns
to the left of the org chart. The administrator defines the filter to retrieve council records, and then con-
figures the maximum number of boxes per column for each org chart style.
Nakisa Inc. 155

11 Org Charts
Note: Council records are only displayed independently if they belong to the root node currently displayed
in the application. Any council records that belong to another branch are displayed as part of the normal
reporting structure.
To configure the council filter:

OrgChart heading.
2. Click General Settings, then go to the Council Configuration section.
3. Enter a Council Filter to identify council records. If the filter is left blank, then council records are dis-
played as part of the normal reporting structure.
4. If required, clear the Add Null-Safe Filter checkbox. This filter ensures that council records with the
council field set to NULL will still be retrieved when the council subcategory has been hidden (from
either the Nakisa AdminConsole or from the User Console).
Warning: Nakisa recommends leaving this checkbox selected, otherwise unexpected results may
occur (especially with SQL staged databases). Note that even if this field is cleared and the build is
published, every time the Nakisa AdminConsole is loaded, the field will be selected again.
l To combine similar records into one org chart box, configure the Subcategory Group Settings.
l To set the fields that are displayed in the Selected Items panel, configure the Selected Items Set-
tings.
l To set the fields the user can select to sort the org chart diagram, click Next to configure the Sort
Fields.
11.3.6 Subcategory Groups

Subcategories group records in a single org chart box based on specific criteria.
To add a subcategory group:

OrgChart heading.
2. Click General Settings, then go to the Subcategory Group Settings section.
3. Click Add New.
4. Enter the SubCategory Name.
5. Enter a SubCategory Filter for the grouped records. (For example, Title like 'Manager'
6. Select the Default Display. The following display options are available:
l Group displays all records in the group in the same org chart box.
l Show Group Members displays records in the group in individual org chart boxes.
l Hide Group Members hides the org chart boxes for records in the group.
7. Enter the Caption for the group. This caption appears in the org chart box if Group is selected in step
6.
8. Click Update to create the new group.
156 www.nakisa.com
11.3.7 Selected Item Fields

Records are added to the Selected Items panel in the User Console when users flag nodes in the org
chart. Each record is represented by a box in the panel. This procedure sets up the fields that appear in
the boxes and enables e-mail.
To set selected items fields:

OrgChart heading.
2. Click General Settings, then go to the Selected Items Settings section.
3. Click and select the Item Description Field from the drop-down list. You can optionally also set
the second description field. Both fields are displayed in the org chart box in the Selected Items
panel. Typically, the field that contains the name of the record is used (for example, STEXT).
4. Click and select the Email Field. This activates the Send E-mail option in the Selected Items
panel.
11.3.8 Sort Fields

This procedure sets the fields the user can select in the org chart Settings dialog box to sort the org chart
diagram.
Note: Some fields (Boolean, comment, binary, ntext) cannot be used for sorting an org chart. Errors occur
if these field types are selected.
To set the org chart sort fields:

OrgChart heading.
2. Click Sort Fields.
Nakisa Inc. 157

11 Org Charts
6. Click Done when all the required fields are added.
7. Select the Order number from the drop-down list for the required field. The field order is auto-
matically updated.
8. To change the Sort Order, double-click the sort order value to access the drop-down list, then select
Ascending or Descending.
9. Click Next to select the details for the org chart.
11.3.9 Select Details

The Details panel opens when users click an org chart node, and displays additional information about the
selected record. The Details panel is created using the Detail Designer, and the Select Detail form is used
to link the required Details panel to the current hierarchy.
Note: Details panels can also be assigned in the Used in Org Chart form of the Detail Designer.
To assign a Details panel to the hierarchy:

OrgChart heading.
2. Click Select Detail.
3. From the Selected Detail drop-down list, choose the detail for the hierarchy. The list includes all top-
level details created in the Detail Designer.
Note: A hierarchy can be linked to one Details panel only. If the hierarchy was previously linked to
another detail, the link to the original detail is removed.
4. In the Field Mappings section, select the Data Element Field of the selected detail that matches
the hierarchy ID field.
5. Click Next to configure the org chart box views, or click Finish.


158 www.nakisa.com
12 View Designer
12
Learn how to create custom org chart box views.
12.1 View Designer Overview 160

12.2 Accessing the Views Designer 160
12.3 Enabling and Disabling Views 160
12.4 View Caption 160
12.5 Table Layout 161
12.6 Sections 162
12.7 Box Size 163
12.8 Box Color 164
12.9 Color Mapping 164
12.10 Hidden Sections 165
12.11 Condensed Style 165
12.12 Preview Mode 165
12.13 Remove Controls 166
12 View Designer
12.1 View Designer Overview

The application has pre-configured org chart views for each organizational object in the application:
l Org unit
l Position
The org chart box displays specific information about a record, and includes regular and condensed styles
that arrange the diagrams in different formats.
The Nakisa AdminConsole Views Designer provides a design schematic of each org chart box view.
Use this schematic to set up the following interface controls in the org chart box:
l View caption
l Table layout
l Sections and fields
l Box color
l Box size
12.2 Accessing the Views Designer

Access the View Designer from the org chart configuration wizard.
To access the View Designer for org charts:

1. In the menu panel, click Audit View to load the module menu.
2. Under the OrgChart heading, click the required hierarchy (you may have to expand to the org chart to
see the underlying hierarchies).
3. In the wizard panel, click Views.
12.3 Enabling and Disabling Views

Enable a view for the organizational object in the org chart and specify the default view.
To enable a view:
1. Access the Views Designer.
2. Under Enable/Disable Views, select the checkbox next to each view to enable for the object.
3. To set the default view, select the required view.
12.4 View Caption

The View Caption is the name that appears in the org chart panel Views menu.
To set the caption:

1. Access the View Designer.
2. In the Modifying [View Name] section, select the required view.
160 www.nakisa.com
3. Enter a new View Caption.
4. Click Apply.
12.5 Table Layout

A table organizes the layout of the interface controls in the org chart box.
Dotted lines show the boundaries of the table and its nested tables.
The lines form a guideline to aid in the design process, and are invisible to the end-user.
The following controls can be added to a table:
l Nested row and column tables
l Panels
l Sections (fields)
This procedure adds the table in the example above. A new placeholder is provided each time a control
is added to the layout.
Create a table that has one column and many rows to arrange fields vertically in a section.
To create a table with two columns:

1. Click and select Column Table from the menu. The table is added to the layout.
2. Click inside the new table, then add a control to create the left column.
Create a table that has one row and many columns to arrange fields horizontally in a section.
To create a table with two rows:

1. Click next to the left column, and select Row Table from the menu. The table is added to the lay-
out.
2. Click inside the new table, then add a control to create the first row.
3. Click below the first row, and add a control to create the second row.
Nakisa Inc. 161

12 View Designer
Nest the row and column tables to create a more complex layout.
12.6 Sections
A section holds the fields used by the application, and arranges them in specific formats in the org chart
box.
The application gathers these fields from the following sources:
l Data elements specified for the current object
l Data elements specified for the linked objects in the hierarchy
l Data elements created in the Data Center, which are joined to the current object
l Pre-configured XSL sections that read data from the application configuration files
The fields are rendered in the org chart box using these section types:
Section Displays
Analytic Analysis and statistics for the object.
Image Mapping Icons mapped to a specific value.
Name A comma-separated name formatted in bold.
Simple Caption A field value formatted in bold.
Field Value A field name and its value.
Simple Value A field value.
Picture An employee portrait.
Telephone A telephone number.
Email An e-mail icon and the address with an active link.
Mouse over any section in the Views Designer layout to view the data source:
Add sections to a table (created in the Table Layout topic) to display specific fields from the data source in
the org chart box.
162 www.nakisa.com
This procedure adds the sections in the example above. A new placeholder is provided each time a con-
trol is added to the layout.
To create the layout:

1. In the View Designer, under Design Details, click .
2. Click > Column Table.
3. Click > Section > [section] > [data element].
The data source tables are identified as follows:
l Current data element
l Linked data elementestablished in the Data Center
4. Select a field in the Edit Fields dialog box. The fields listed are drawn from the selected data element.
5. Click Apply. The section is added to the left column.
6. Add a Row Table to the right column.
7. Add a Simple Value Section that contains the Lastname and Firstname fields to the top row.
8. Click the arrows to arrange the fields in the required order.
9. Add a Simple Value Section that contains the Position ID field from a linked hierarchy to the bottom
row.
12.7 Box Size

Increase the size of the org chart box once new sections and fields are added to the view.
Note: Make sure the size of the box is large enough to accommodate its caption without cutting it off.
Nakisa Inc. 163

12 View Designer
To change the box dimensions:

3. Under Design Mode, enter the org chart Box Height and Box Width in pixels.
4. Click to switch to preview mode, then verify that the new sections and fields added to the view dis-
play properly.
5. Click to return to design mode.
12.8 Box Color

Change the color of the org chart box.
To change the box color:

3. In the Box Color field, enter an HTML color code, or click to load the color box and select the
required color.
The default color defined by the theme is used when Transparent is selected.
4. Click to switch to preview mode, then verify that the new color is correct.
12.9 Color Mapping

Color mapping changes the color of the org chart box according to a defined field and value.
Note: The org chart box shows the color defined by the application theme when mapping is not used.
The procedure below changes the org chart box color to red if the record has a nationality value of
Canada.
To map colors in the org chart box view:

3. Click to load the Edit Color Mapping dialog box.
4. Select the Nationality field from the drop-down list.
5. Click Add Mapping. The Map From and Map To fields load in the Edit Mappings section.
6. Enter Canada in the Map From field.
7. Enter RED (or the color code #FF0000) in the Map To field.
8. Repeat step 4 to step 7, and map additional field values to a color.
9. Click to delete a mapping when required.
10. Click Apply.
164 www.nakisa.com
12.10 Hidden Sections
Nakisa adds hidden sections to the org chart views, which are available for edit in the View Designer. A
hidden section uses the field value as a condition. It can be configured to show org chart boxes in different
colors depending on the country value, for example.
To view a hidden section:

3. Click to load the Edit Hidden Sections view.
4. Edit the hidden section as required.
12.11 Condensed Style

The condensed style displays a left-hanging vertical chart, and condenses all boxes in the org chart. The
layout of condensed org chart boxes cannot be modified, but the fields displayed in the box can be
changed.
To modify fields displayed in the condensed style:

2. In the Modifying [View Name] section, select the required view. The box layout opens on the Regu-
lar Style tab.
3. Click the Condensed Style tab. The condensed org chart box loads in the designer.
4. If required, modify the box size and color.
5. In the box layout, click Edit.
6. In the Edit Fields form, select the fields you wish to display in the condensed style.
7. Click Apply.
12.12 Preview Mode

Generate a view preview to see the org chart box as it appears in the application.
To preview a view:
3. Under Design Mode, click . The design schematic switches to preview mode.
4. Enter the Record ID, or click to select the required record.
5. Click Go to preview the org chart box as it appears in the application.
Nakisa Inc. 165

12 View Designer
12.13 Remove Controls

These steps remove interface controls from the org chart box view:
l Click Edit in a section, and clear the required checkbox to remove a field.
l Click Delete to remove a control, and all nested controls are removed.
166 www.nakisa.com
13 Listings and Searches
13
Learn how to configure the listing directories and search settings.
13.1 Listing Overview 168

13.3 Data Connection 170
13.4 Fields 171
13.5 Directory Filter 171
13.6 Selected Items Fields 172
13.7 Listing Columns 172
13.8 Search Form 173
13.9 Advanced Search Form 174
13.10 Select Details 174
13.1 Listing Overview

A listing is a real-time search capability used to find organization information contained in the company
human resource data repository. Listings are used to generate advanced searches based on keywords
and priorities, and to limit searches by specific organizational units, positions, and employees in the organ-
ization structure.
The process involves the following steps:
l Enable the listing.
l Add fields from the data source and define the key fields.
l Define the listing filter.
l Set the fields displayed in the listing.
l Set the basic search and advanced search fields.
l Link the required Details panel to the listing.
The application includes the following listings by default:
Listing Description
Audit Runs Provides a list of all audit runs with their respective run dates and num-
ber of errors detected.
Errors by Audit Runs Provides a list of all errors (of all severities and statuses) and the audit
run in which they were identified. The listing also identifies the severity
and object type for the error. By default, the only searchable field in this
listing is the audit run ID.
Open Errors Provides a list of all errors that have a status of "open" or "auto-opened".
The listing columns display information about the error, including:
l The rule that detected the error
l The group (OM, PA, CM) in which the error was detected
l The organizational object type that contains the error
l The severity of the error
l The org unit, position, and employee ID (where applicable) containing
the error
Recently Closed Errors Provides a list of all errors that have been closed or auto-closed within
the last month, starting from today. For example, if today is April 15, the
listing will show all errors closed between March 16 and today. The list-
ing includes the same columns as the Open Errors listing. This listing
only displays errors that have a current status of closed or auto-closed; if
an error was closed in a previous audit run, but was auto-opened in a sub-
sequent one, the error will not appear in this listing, but in the Open
Errors listing instead.
168 www.nakisa.com
Listing Description
Recently Opened Errors Provides a list of all errors that have been opened or auto-opened within
the last month, starting from today. This listing includes the same
columns as the Open Errors listing.
Ignored Errors Provides a list of all errors that have been set to Ignored status.
Last Audit Run Errors Provides a list of all errors (of all severities and statuses) that were detec-
ted during the latest audit run. Errors of all severities and current
statuses are included in this listing. For example, if an error is opened dur-
ing an audit run, but is then set to "closed", it will appear as a closed
error. This listing includes the same columns as the Open Errors listing.
Errors with Recent Provides a list of all errors whose status has been updated within the last
Status Change month, starting from today.
Stale Errors Provides a list of all errors whose status has remained unchanged for
more than a month, starting from today.
All Errors Provides a list of all errors in the audit database. This listing includes the
same columns as the Open Errors listing.
Company Code Provides a list of all the company codes in the organization.
Employee Listing Provides a list of all employees.
Position Listing Provides a list of all positions.
Org Unit Listing Provides a list of all org units.
Note: The Country Listing is currently non-functional.

The Nakisa AdminConsole is used to set up the fields required for each listing, the directory behavior, and
the basic and advanced search forms.
13.2 Enable/Disable
This procedure enables a listing in the User Console.
To enable a listing:
1. In the menu panel, click Listing and select the required listing.
2. Select Yes to enable the listing, or No to disable it.
3. Enter a new Caption using company-specific terms, or leave the default.
4. If the application is configured for multiple languages, click and enter translated text; click to
accept the changes.
5. In the Assign to Module section, select audit in the Module field. The listing will not appear in the
User Console if another value is selected.
6. Click Next to set up the Data Connection.
Nakisa Inc. 169

13.3 Data Connection

In the Data Connection screen, configure the connection to the main data source for organization data.
Note: These fields are already pre-populated when you set up the staged database for either the SAPEx-
tractor or to extract audit data. Use the following procedure if you need to modify the data connection, but
note that it will also affect the data connection for the SAPExtractor, audit extraction, and org charts.
The data connection and data element names used for the current listing are displayed in bold. These
names are retrieved from the corresponding data connections and data elements in the Data Center.
Tip: Click on the icon for information about the listing type and name, data element type and name,
and the data connection type and name. If one of these items was created outside of the Nakisa
AdminConsole, the type is displayed as "Unclassified". Note that for data elements, this means that it
cannot be configured in the Data Center.
To establish a connection to a staged database:

1. In the menu panel, click Listing to load the module, then select the required listing.
2. Click Data Connection.
name.
For example: 192.168.0.148:1521:ora92
l TNS entry name
4. Enter the Initial Catalog to specify the database name for the data source. Skip this step for Oracle
databases.
6. Click Test Connection. A message indicates whether the connection is successful.
7. Click to activate the drop-down list, then select the required Data Table that contains the fields for
the org chart.
8. Enter a Data Filter, if required.
9. Click Next to set up the listing fields.
170 www.nakisa.com
13.4 Fields
Update the fields that are used to set up the listings.
To set the fields:

2. Click Fields.
Note: Do not select fields that begin with MC_ (for example: MC_STEXT). These fields are typically
duplicates that contain the string in upper-case characters and may cause unexpected results when
performing a search in the User Console. Use the field of the same name without the prefix (for
example: STEXT).
7. Select the Key Field that uniquely identifies the record type. A typical example is the org unit ID
field.
8. Modify the field caption, if required:
a. Click to activate the required field.
b. Enter a new caption for the field.
c. Click to accept the caption.
9. Click Next to set up the Directory Filter.
13.5 Directory Filter

Set up a filter to process the records that are displayed when users access a listing.
To filter a directory:
3. Select Start Directory Empty. Users must perform a search in order to populate the list when this
checkbox is selected. An empty directory prevents unnecessary load on the data server if the listing
contains a large number of records.
4. If required, enter a Directory Filter to limit a search to a specific type of record.
5. Enter the Records per page. This sets the default number of records returned on a page when the
user accesses a listing, or performs a search.
6. Enter the Export Limit (between 1 and 10,000). This restricts the number of records users can export
from the application.
7. Click Next to set up the fields used in the Selected Items panel.
Nakisa Inc. 171

13.6 Selected Items Fields

Records are added to the Selected Items panel when users select them from a listing. This procedure
sets up the fields that appear in the selected items boxes and enables e-mail.
Note: The Selected Items Settings may not be available for some listings.
To set selected items fields:

2. Click General Settings, then go to the Selected Items Settings section.
3. Click and select the Item Description Field from the drop-down list (the second description field
is optional). Typically, the Name field is used.
4. Click and select the Email Field. This activates the Send E-mail button in the Selected Items
panel.
5. Click inside the Color field, then select a color. This color is used to identify the object type when a
listing record is added to the Selected Items panel. The color is displayed on the left border of the org
chart box.
6. Click Next to set up the Listing Columns.
13.7 Listing Columns

The following procedures set which fields are displayed for a listing, and which of these fields are sort-
able.
Administrators can also select a different layout template (XSL file) that will customize the listing layout.
Custom templates can modify many aspects of the layout, such as using resource bundles to display
icons instead of text. The templates are added to the build by uploading a ZIP file containing the custom
templates using the method described in Uploading Content, section 17.5 on page 197. Note that the
ZIP file must use the directory structure /Root/Templates/custom/directory.
Note: To create custom XSL files, contact your implementation partner.
To add fields to a listing:

2. Click Display Fields.
7. Select the Order number for the required field from the drop-down list. The field set to ‘1’ is the first
column in the listing grid.
Note: If you change the Order number for a field, it may also clear the Sortable checkbox if it is
selected.
172 www.nakisa.com
8. Select Show by default for the fields that are displayed in the listing by default. The fields that do not
have this checkbox selected are available in the User Console, but not displayed in the listing by
default. They can be enabled by users in the Listing Settings dialog box.
To enable and configure sorting:

1. Click to activate the required rows.
2. Select Sortable.
3. Select the Allowed Sort Order: Ascending, Descending, or Both.
4. If both sort orders are allowed, set the Default Sort Order if required. If the default is left blank, the
listing column is not sorted by default, but the user can sort the column themselves.
To upload and use custom template XSL files:

1. The Listing Layout section contains a drop-down list of available listing layout templates.
Tip: The template available by default is written in blue text.
2. Select the required file from the drop-down list.
3. Click Next to set up the basic Search Form.
13.8 Search Form

Set the available fields, search operator, and validation types used in the basic search form.
To add fields to the search form:

1. In the menu panel, click Listing, then select the required listing.
2. Click Search Fields.
5. Use the page and search controls provided to find and add the required fields.
7. Select the Order number for the required field from the drop-down list. The field order is automatically
updated.
To set up the operator and validation type:

1. Click to activate the required search field value.
2. Select the Operator Type, Default Search Operation, and Field Validation Type.
4. Click Next to set up the Advanced Search Form.
See also:
l About Managing Validations, section 5.3.1 on page 36
Nakisa Inc. 173

13.9 Advanced Search Form

The advanced search form loads when the user clicks the Advanced Search button in a listing. The user
selects multiple fields and values to return more thorough search results. Search filters are also available
to specify multiple values for the same search field.
To add fields to the search form:

2. Click Advanced Search Fields.
3. Click Copy From Search Fields. The same fields, operators, and validations configured for the
basic search form are automatically added.
6. Use the page and search controls provided to find and add the required fields.
8. Select the Order number for the required field from the drop-down list. The field order is automatically
updated.
9. Click Next to select the Detail used by the listing.
13.10 Select Details

The Details panel opens when users click a listing, and displays additional information about the selected
record. The Details panel is created using the Detail Designer, and the Select Detail form is used to link
the required Details panel to the current listing.
To assign a Details panel to the listing:

1. In the menu panel, click Listing, then click the required listing.
2. Click Select Detail.
3. From the Selected Detail drop-down list, choose the detail for the listing. The list includes all top-
level details created in the Detail Designer.
Note: A listing can be linked to one Details panel only. If the listing was previously linked to another
detail, the link with the original detail is removed.
4. In the Field Mappings section, select the Detail Field of the selected detail that matches the key
field of the listing.
5. Click Next to load the Confirm page.
13.11 Confirm and Submit Settings

174 www.nakisa.com
Nakisa Inc. 175

14 Custom Listings
14
14.1 Custom Listing Overview 177
14.2 RDBMS and LDAP Data Element Listings 177
14.2.1 About RDBMS and LDAP Data Element Listings 177
14.2.2 Select a Listing 177
14.2.3 Listing Information 178
14.3 Remove Listings 178
14 Custom Listings
14.1 Custom Listing Overview

If the default listings do not reflect your needs, create custom listings to search for and display different
data and records.
The following method is available to create custom listings:
l RDBMS and LDAP data element listings that retrieve data from RDBMS or LDAP databases.
14.2 RDBMS and LDAP Data Element Listings
14.2.1 About RDBMS and LDAP Data Element Listings

The From Data Element listing wizard uses RDBMS and LDAP data elements to generate listings.
Note: This wizard can also be used to modify the fields of existing listings that use RDBMS and
LDAP data elements.
Workflow
Follow the wizard steps in the same sequence as they are presented in the application.
Creating a listing (or editing an existing listing) involves the following steps:
l Select the listing to edit in the Select a Listing wizard step, or skip the step to create a new listing.
l Define the listing name and caption, and select the required data element in the Listing Information wiz-
ard step.
l Assign the listing to the correct module in the same wizard step.
l Select the key field for the results.
l Submit your changes on the Confirm page.
l Configure the listing.
Note: Once created, a new listing is not secured and is available for all users. To limit access to the list-
ing, secure it in the Add/Remove Secure Items step of the Define Roles wizard, and then grant the
required roles access to it in the Role Mapping step of the Authentication Settings wizard.
14.2.2 Select a Listing

In this wizard step, select an existing listing to modify it, or skip this step to create a new listing.
Note: Only listings that use RDBMS or LDAP data elements appear in this wizard step.
To select an existing listing or create a new listing:

1. In the menu panel, click Listing, then click From Data Element under the New Listing heading.
l To edit an existing listing, select the checkbox for that listing and click Next.
l To create a new listing, simply click Next to set up the listing information.
177 www.nakisa.com
14.2.3 Listing Information
In this wizard step, set up the listing information and select the data element used for the listing.
To select an existing listing or create a new listing:

1. In the Listing Information wizard step, enter the following information in the Listing Information
section:
l Listing Name: Enter a unique name for the listing that identifies it in the Nakisa AdminConsole.
Note: The listing name cannot be empty and cannot contain spaces or underscores (_).
l Caption: Enter the name of the listing that appears in the User Console.
l Data Element: From the drop-down list, select an RDBMS or LDAP data element.
2. In the Assign to Module section, select Audit in the Module field. The listing will not appear in the
3. In the Data Output Information section, select the key field for the results.
4. Click Next to confirm your changes.


2. On the Confirm page, click Submit. The changes are saved to memory, and the new listing appears
under the Listings heading in the menu panel.
The next step is to configure the listing.
14.3 Remove Listings

Any custom listing (or default listings that were built using the Nakisa AdminConsole) can be removed
from the application. This may be necessary if the listing was not created correctly, or is no longer
required.
To remove a listing from the application:

1. In the menu panel, click Listing.
2. Under the New Listing heading, click From Data Element. All listings created using this wizard are
displayed in a table.
l If the listing was created using an RDBMS data element, click From Data Element.
l If the listing was created using an RFC data element, click SAP RFC.
Nakisa Inc. 178

14 Custom Listings
All listings created by the respective wizards are displayed in a table.

4. Select the checkbox next to the listing you wish to remove, then click Delete.
5. Click Finish, then click Submit. The listing is removed from the Listings heading in the menu panel.
179 www.nakisa.com
15 ChartBook
15
Learn how configure ChartBooks and define the default template.
15.1 ChartBook Overview 181

15.3 ChartBook Templates 182
15.4 ChartBook Server Settings 183
15.5 Clustered Environments 183
15.6 ChartBook Captions 184
15 ChartBook
15.1 ChartBook Overview

A ChartBook is an interactive PDF document that is used to view individual branches of the organization
structure. Each page displays the directly reporting org units or positions in the selected branch. The gen-
erated ChartBook document features complete PDF functionality, including bookmarks, a table of con-
tents, an index, and full search capabilities.
There are two available ChartBook modes:
ChartBook Mode Available Tasks

Regular Users are limited to the following tasks:
l Selecting a ChartBook template
l Defining the depth of the generated org chart
l Modifying the ChartBook title
Advanced Users have full access to all ChartBook features, including:

l Creating a cover page
l Adding headers and footers
l Modifying the table of contents, index, and legend style and layout
l Adding password protecting and setting permissions to print, modify, and
copy the generated ChartBook
l Saving and loading ChartBook templates
Note: By default, the ChartBooks included with the application are limited to the Manager, Assistant, HR,
and Executive roles. To change the permissions and ChartBook mode, use the Add/Remove Secure
Items and Edit Roles wizards.
Use the ChartBook module to:
l Enable the ChartBook in the User Console.
l Set the default ChartBook template.
l Set the server where ChartBooks are saved.
l Define the fields that comprise table of contents items, subordinate table records, and index entries.
l Set up ChartBooks in a clustered application environment.
15.2 Enable/Disable
Separate ChartBooks are available for each org chart in the application, including any custom org charts.
Enable the required ChartBooks and assign them to the appropriate module menu in the application.
To enable ChartBook:
1. In the menu panel, click ChartBook.
2. Click the required ChartBook. The Enable/Disable page loads.
3. Click Yes to enable the ChartBook, or No to disable it.
181 www.nakisa.com
4. Optionally, enter a new Caption using company-specific terms, or leave the default value. This cap-
tion appears in the loaded module in the menu panel and in the User Console as the hierarchy name in
the ChartBook wizard.
5. If the application is configured for multiple languages, click and enter translated text; click to
accept the changes.
6. In the Assign to Module section,select toc in the Module field. The CharBook will not appear in the
7. Click Next to set the ChartBook captions.
15.3 ChartBook Templates

Enable and set a default ChartBook template, allowing users to generate ChartBooks with pre-defined set-
tings, including:
l Cover page
l Page format and layout
l Page headers and footers and their contents
l Table of contents format
l Index format
l Org chart hierarchy
l Subordinate table format and contents
l Security options
The ChartBook template provided by default is stored in the following location:
[application directory]/.system/Admin_Config/[build workspace]
/AppResources/chartbooktemplateconfiguration
Any additional ChartBook template imported into the build is stored in the following location:
[application directory]/.system/Admin_Config/[build workspace]
/.delta/AppResources/chartbooktemplateconfiguration
To set the default ChartBook template:

2. In the Default ChartBook Template section, select the Default Template from the drop-down list.
3. To delete a template, select the template from the Delete Existing Template drop-down list, then
click Delete.
4. Click Submit.
To set the default ChartBook templates for each org chart:

2. In the Override Templates for Individual Org Charts section, click next to the org chart whose
default ChartBook template you want to change.
3. In the ChartBook Template column, select the new default template from the drop-down list, or
select Use Default ChartBook Template to use the default template specified in the Default
Nakisa Inc. 182

15 ChartBook
ChartBook Template section.

4. Click .
To add new ChartBook templates:

1. In the User Console, create and save the required template. Refer to the User Guide for more inform-
ation.
2. In the Nakisa AdminConsole, import the template using the Upload Content button or the Add-On
Manager.
3. If required, the imported template can now be selected as the default ChartBook template using the
previous procedure.
4. Publish the build. The new templates are now accessible to all users.
15.4 ChartBook Server Settings

To specify where the generated ChartBooks are saved, to delete saved ChartBooks, and to set the
sender email information for email notifications, you must follow the procedures below.
To specify server settings for saved ChartBooks:

2. Configure the Server Settings for ChartBook:
l To save ChartBooks to the file server (i.e., the location where the application is running), select
File Server.
l To save ChartBooks to an FTP Server, select FTP Server and specify the FTP Server host,
User Name and User Password.
Warning: In a clustered environment, ChartBooks must be saved to an FTP server. See Clustered
Environments for additional ChartBook settings for clustering.
To specify SMTP settings for e-mail notifications:

2. Configure the SMTP Settings for ChartBook with the following mail information: Mail Server Host,
Port, User Name, User Password, User Mail Address.
3. If you need to test the User Mail Address, enter the same address into the Send Test Email To field
and click Send.
Note: If an e-mail address is specified in the ChartBook Generator, it will be sent from the mail
address specified here.
To delete ChartBooks from the server:

2. In the ChartBook section, click Delete All.
15.5 Clustered Environments

In a clustered application environment (either with multiple nodes on the same machine or with multiple
instances), the ChartBook status information and the list that maps ChartBooks to users must be stored
183 www.nakisa.com
in a database to ensure that users do not lose their ChartBooks. Note that generated ChartBook PDF files
must also be stored on an FTP server.
Note: If there are different applications running in the clustered environment, there needs to be a separate
database for each application.
To set up ChartBooks for a clustered environment:

2. In the ChartBook Settings for Clustering section, select Clustering Enabled and enter the fol-
lowing database connection information for the ChartBook information and mapping:
l Select the Server Type, then enter the Server Name that hosts the staged database.
name.
For example: 192.168.0.148:1521:ora92
l TNS entry name
l Enter the Initial Catalog to specify the database name for the data source. Skip this step for
Oracle databases.
l Enter the User Name and Password for accessing the database.
l Click Test Connection. A message indicates when the connection is successful.
3. If it is the first time the database is used for ChartBook, click Recreate Structure.
Note: Recreating the database structure deletes all existing ChartBook entries from the database,
but does not delete generated PDF files on the FTP server.
4. Click Submit.
Warning: In a clustered environment, ChartBooks must be saved to an FTP server. See ChartBook
Server Settings for information on these settings.
15.6 ChartBook Captions

The ChartBooks Details page is used to set the display fields; the field values appear in the generated
ChartBook as captions. There are three sections that define the following captions:
l Table of Contents Caption defines the fields for the table of contents entries, page header entries,
and entries in the PDF bookmark pane.
Nakisa Inc. 184

15 ChartBook
l Subordinate Table Caption defines the fields for the subordinate table at the bottom of each
ChartBook page.
l Index Caption defines the fields used in the index entries.
To set up the captions:

1. In the menu panel, click ChartBook to load the module, then select the required ChartBook.
2. Click Details.
3. From the Select Object list, select an organizational object. This option is available when the top-
level hierarchy has linked subordinates.
4. Select Enable/Disable to activate the required section(s).
5. Select the required field(s) from the Available Fields table, then click to move them to the Fields
in Use list.
6. To remove a field from the Fields in Use list, select the field or click to select all fields, then click
.
185 www.nakisa.com
16 User Preferences
16
Learn how to store user preferences and configure default user interface settings.
16.1 Enabling and Disabling Preferences 187

16.2 Storing User Preferences 187
16.3 Cleaning the Swap File 189
16.4 Default User Console Settings 189
16.4.1 About Default User Console Settings 189
16.4.2 Application Languages 190
16.4.3 Themes 190
16.4.4 Date Format 190
16.4.5 Default Layout 191
16.4.6 Org Chart Modes 191
16.4.7 Accessibility Mode 192
16 User Preferences
16.1 Enabling and Disabling Preferences

The following procedure enables the Preferences menu in the User Console.
To enable the Preferences menu:

1. In the menu panel, click Preferences.
2. In the loaded module in the menu panel, select the Enable Module checkbox to globally enable user
preferences. If you clear this checkbox, the Preferences menu is hidden in the User Console.
16.2 Storing User Preferences

The User Preferences panel defines the method of storing user preferences, such as preferred language,
theme, listing settings, and saved listings. This allows users to quit and return to the application without
having to recreate their personal settings.
The application provides three options to store user preferences:
l No session storage: User preferences are maintained while the browser is opened, but are discarded
once the session is closed.
l Store user preferences in cookie: User preferences are stored as a cookie in the user's browser set-
tings. The cookie is updated each time the user changes preference settings, and retrieves the pref-
erences when the user logs in to the application with the same computer and browser.
l Store session in DB: When a user logs in to the application, their login credentials are mapped to a
unique ID in a separate database. Each time that user logs in, their preferences are retrieved, even if
they log in from a different computer or browser. If the application is set to anonymous login, a unique
ID is created in the database and stored as a cookie in the user’s web browser settings. If that user
quits and returns (using the same computer with the same browser), the cookie is read, and the pref-
erences retrieved. To use this option, you must have access to a database application on a server
other than the Nakisa application server.
The procedure to set each option is outlined below.
No Session Storage
To disable user preference storage:
1. In the menu panel, click Application-wide Settings > User Preferences.
2. Select No session storage.
3. Click Submit.
Store User Preferences in Cookie

To store user preferences in cookies:
2. Select Store user preferences in cookie. The cookie setting form loads in the wizard.
3. Enter the Cookie duration. The duration is reset each time the user changes a preference setting.
187 www.nakisa.com
4. Select the required Storage criteria. There are four available options:
l Preferences: Stores all settings from the Preferences panel, including date format, default lan-
guage, application theme, and org chart mode.
l OrgCharts: Stores user-saved org charts. Note that users cannot save org charts if this setting is
disabled.
l Listings: Stores user-saved listings. Note that users cannot save listings if this setting is dis-
abled,
l Shortcuts: Saves any icons that are moved from the org chart or listings Actions menu to the
panel top bar.
Note: The maximum size for cookies is 4 KB. Consequently, the maximum size can be reached or
exceeded if users save multiple org charts, listings, and/or shortcuts. Users must then delete some
of their saved settings to save new ones. To prevent the cookie from reaching its maximum size,
select the Preferences option only.
5. Click Submit.
Store Session in DB
User preferences are saved in a "swap file", which is a database table with one row per unique user. Each
row contains fields for each of the settings a user can save from the User Console. Each row also has a
date/time stamp field that is updated every time the user logs in. Any changes to his or her preference set-
tings are reflected in changes within the existing table row. The database table grows as the number of
unique users increases. You can reduce the size of the table by deleting rows with date/time stamps
earlier than a specified date.
Note: The data connection name used for the storing preferences is displayed in bold above the database
parameters. Note that this data connection cannot be configured via the Data Center.
To store user preferences in a separate database:

1. In the menu, click Application-wide Settings > User Preferences.
2. Select Store session in DB. The storage database form loads in the wizard.
3. Select the Server Type, then enter the Server Name.
name.
For example: 192.168.0.148:1521:ora92
l TNS entry name
Nakisa Inc. 188

16 User Preferences
4. Enter the Initial Catalog to specify the database that will be used to store user preferences. Skip this
step for Oracle databases.
6. Click Test Connection. A message indicates the success or failure of the connection. You must
have a successful connection to continue.
7. Click Recreate Structure to define the table structure and fields needed to store user preferences.
Warning: If the database already exists, this operation will remove and replace any existing tables.
All user preference settings will be permanently deleted!
8. Select the required Storage criteria. There are four available options:
l Preferences: Stores all settings from the Preferences panel, including date format, default lan-
guage, application theme, and org chart mode.
l OrgCharts: Stores user-saved org charts. Note that users cannot save org charts if this setting is
disabled.
l Listings: Stores user-saved listings. Note that users cannot save listings if this setting is dis-
abled.
l Shortcuts: Saves any icons that are moved from the org chart or listings Actions menu to the
panel top bar.
9. Click Submit.
To delete stored records by record type, select the required Storage criteria and click Delete Selected
Records.
16.3 Cleaning the Swap File

If user preferences are stored in a separate database, the swap file stores the settings for all users of the
application: preferred language, theme, listing settings, and saved listings. Each time a user accesses
the application, their preferences are updated with the log-in date. Administrators should clean the swap
file every two months to maintain a convenient file size.
To clean the swap file:

2. Select the required month, day, and year from the calendar, or enter the date in the field provided
using the following syntax: MM/DD/YYYY.
3. Click Clean Swap File.
4. Click Submit.
16.4 Default User Console Settings
16.4.1 About Default User Console Settings

The Preferences module is used to configure default UI settings for the User Console. Use this module to
define the following settings:
189 www.nakisa.com
l Available and default languages
l Available and default theme
l Date format
l Default screen layout (one-pane or two-pane)
l Available and default org chart modes
16.4.2 Application Languages

Application menus, dialog boxes, headings, and other User Console elements are displayed in the default
language set in the Nakisa AdminConsole. If other languages are enabled, all UI elements are displayed
in the user-selected language. Data is displayed in the languages set in the source data.
Note: Additional languages are installed using the Nakisa Language Pack. Contact your implementation
partner for more information.
To set the available languages:

1. In the menu panel, click Preferences > Preference Settings. The Preference Settings form loads.
2. In the Languages section, select the checkbox to enable the required languages.
3. Select the radio button to set the default application language.
4. Click Submit.
5. If user preferences are stored in a separate database, clean the swap file to reset the defaults.
16.4.3 Themes
The User Console can be displayed using different color themes. The application includes two color
themes by default:
l Classic Theme (blue)
l Gray Theme
Note: Custom themes may be implemented as well. Contact your implementation partner for more
details.
Use the Preference Settings form to define the available and default themes.
To set the application theme:

2. In the Theme section, select the checkbox to enable the required themes.
3. Select the radio button to set the default theme.
4. Click Submit.
16.4.4 Date Format

The date is displayed in the Details panel data (if a date field is included in the design) and printed output
(if users choose to print the date).
Nakisa Inc. 190

16 User Preferences
Set the default date format to ensure consistent display across all application sections.
To set the default date format:

2. In the Date Formats section, select the default format.
3. Click Submit.
16.4.5 Default Layout

There are two possible layout options for viewing information in the User Console:
l One pane: The information appears in a single frame of the application. Clicking on a record opens the
Details panel in a separate tab. Only one tab can be viewed at a time.
l Two panes: Information in the User Console is displayed in two frames.
Set the default layout to have the application launch according to your preferences.
To set the default layout:

2. In the Default Layout section, select the default layout.
3. Click Submit.
16.4.6 Org Chart Modes

The application supports two modes:
l Basic Mode uses HTML to render the diagram.
l Enhanced Mode uses Flex to render the , and offers additional features for users, including an
enhanced print and export wizard. This mode is only available to users when enabled by the admin-
istrator, and requires Adobe Flash Player 10 or higher to be installed in the client browser.
When enabled, users can switch between the two modes in the Application Preferences.
To set the org chart modes:

2. In the Org Chart Mode Configuration section, select the Enhanced and/or Basic checkboxes to
enable the modes in the User Console.
3. If both modes are enabled, select the radio button for the mode that will be loaded by default in the
User Console. Note that the org chart mode selected by the user takes precedence over the default
mode whenever the User Console is loaded.
4. Click Submit.
191 www.nakisa.com
16.4.7 Accessibility Mode
In the User Console, users can switch the application to a text-only interface to provide content that is
more accessible for users with disabilities. Accessibility mode provides text equivalents for every non-
text element used in the application, and the page content can be read by a screen reader such as JAWS
and Window-Eyes.
Refer to the User Guide for more information about how Accessibility mode is enabled.
The option to turn on the Accessibility mode in the User Console can be hidden from the Nakisa
AdminConsole if required.
To hide or display the Accessibility mode option:

1. In the menu panel, click Preferences > Preference Settings.
2. In the Accessibility section, clear the Enable Accessibility Mode Option checkbox to hide the
option in the User Console, or leave the checkbox selected to display the option.
Nakisa Inc. 192

17 Build Management
17
Learn how to import and export application configurations.
17.1 Build Folder Structure 194

17.2 Exporting Builds 195
17.3 Importing Builds 196
17.4 Exporting Configurations 197
17.5 Uploading Content 197
17.6 Resetting Builds 198
17.7 Deleting Builds 199
17.8 Adding Comments to Builds 199
17 Build Management
17.1 Build Folder Structure

Application settings are stored in a specific build that is saved and published by the administrator. Con-
figuration files store the settings required by the user interface components in all Nakisa applications.
The following table lists the default application directory, by operating system:
Operating Default Application Directory

System
Microsoft C:/usr/sap/[NetWeaver host name]/J00/j2ee/cluster/apps/
Windows [Nakisa]/[EAR name without extension]/servlet_jsp/[WAR name
Linux /usr/sap/[NetWeaver host name]/J00/j2ee/cluster/apps/[Nakisa]

/[EAR name without extension]/servlet_jsp/[WAR name without
extension]/root
The following diagram illustrates the folder structure of Nakisa applications:
194 www.nakisa.com
The build folders and customized settings are saved in the [application directory]
/.system/Admin_Config folder.
When the application is deployed, the Admin_Config folder only contains the default builds shipped
with the application. One or more default builds may be included, depending on the Nakisa application. A
build workspace folder is created the first time a build is loaded in the Nakisa AdminConsole.
The following occurs each time a build is loaded in the Nakisa AdminConsole:
l The build workspace is created (if it does not already exist). The following naming convention is used
for the build workspace folder: ___XXX___[Default build name], where 'XXX' is the tenant
number.
l All files contained in the corresponding build folder are copied into the build workspace.
l Any add-on files contained in the /.system/add-ons folder are copied to the build workspace. This
only occurs if add-ons have been implemented in the build.
l All configuration files contained in the /[build workspace]/.delta folder are copied to the build
workspace.
The following occurs when changes to a build are saved:
l Modified configuration files are saved in the [build workspace] folder.
l Modified configuration files are also saved in the /[build workspace]/.delta folder.
The following occurs when a build is published:
l All files contained in the build workspace folder are copied to the main [application
directory] folder.
Changes to the application configurations are recorded in the log file saved in the /[build
workspace]/Log directory. See Application Log Overview, section 20.1 on page 208 for information
about the Admin log.
17.2 Exporting Builds

The resources and settings used by the application are localized in a specific build under the
[application directory]/.system/Admin_Config/[build workspace] directory. A typ-
ical build contains:
l Authentication and security settings
l Data connections
l XML templates that store module, org chart, views, listing, and detail configurations
l XSL files that transform and render XML documents
l Scripts
l Images
You can export a build as a ZIP file that can be used as a backup, or as a means to transfer cus-
tomizations to another Nakisa application server.
Tip: Use this feature to export entire builds. If you wish to export specific customizations, use the Export
Configurations feature instead.
Upon export, the files associated with the build are saved in a ZIP file in the [application
directory]/.system/add-ons/inbox directory on the Nakisa application server. This file contains
Nakisa Inc. 195

17 Build Management
the set of all changes to the currently loaded build, including the selected user authentication method, pref-
erences, and other settings that are not part of AppResources.
Note: Add-ons are not exported with a build. If the configuration files in the build depend on certain add-
ons, then you must make sure that the same add-ons are also installed wherever the build is imported.
To export a build:
1. Access the Nakisa AdminConsole, then load the required build.
2. Modify the build, if necessary.
3. If the Upload Content, Export Changes, Save As, and Publish buttons are not displayed in the top-
right corner, click Save & Publish current build in the menu panel.
4. Click Export Changes. The Choose Build Name dialog box appears.
5. Enter a name for the build in the field provided.
6. Click Export Build.
7. Optionally, click the Download link in the top bar (as shown below), and save the ZIP file to a loc-
ation of your choice.
17.3 Importing Builds

You can import a build from a ZIP file that was created as a backup, or to transfer customizations from
another Nakisa application server. When a build is imported, a new build folder is created in the
[application directory]/.system/Admin_Config directory.
Note that add-ons are not exported with a build. If the configuration files in the build depend on certain add-
ons, then you must make sure that the same add-ons are also installed wherever the build is imported.
Tip: Use this feature to import new, complete builds. If you only wish to import some configuration files
into the current build, use the Upload Content feature.
Note: A build can only be imported if the source build on which it is based is present in the target envir-
onment. For example, if you used a “MyOrganization” configuration to export a ZIP file, then “MyOr-
ganization” must be present in the target system.
To import a build:
1. Access the Nakisa AdminConsole.
2. Click Browse and locate the ZIP file corresponding to the build you wish to import.
3. Click Import Build, then enter a unique name for the build you are about to import. This allows you to
import a build from the same ZIP file more than once.
4. Click Import. The imported build appears in the list of available builds, and a comment identifies it as
an imported build. A new folder is created on the application server for this imported build (all pre-
viously installed builds remain untouched).
5. Select the imported build, then click Load.
196 www.nakisa.com
17.4 Exporting Configurations
The Export Configurations screen provides a tree view of the directory structure and files for each con-
figuration stored in the [application directory]/.system/Admin_Config/[build]
/AppResources directory.
Warning: The Upload Content feature should only be used by advanced administrators.
Tip: Use the Export Configurations feature to export a specific AppResources configuration as an add-
on. If you wish to export an entire build, use the Export Changes feature instead.
The following occurs during the export:
l The add-on archive file that contains the configuration is created.
l The archive is saved in the [application directory]/.system/add-ons/inbox directory.
l The file is named add-on-[name].zip.
l A download link is created.
l The add-on is listed in the Add-On Manager upload list.
Tip: The exported configuration files can also be imported into any build using the Upload Content feature
if the top-level add-on folder is removed from the zip. For example, if you named your exported con-
figuration files export in the Nakisa AdminConsole, the top-level add-on folder name is add-on-
export. This folder must be removed and the contents of the folder re-zipped.
To export a configuration:
1. If required, make updates in the Nakisa AdminConsole. Click Submit to temporarily store the con-
figuration in the session memory.
2. In the menu panel, click Application-wide Settings > Export Configurations.
l Select the required configuration files. Note that selecting a top-level checkbox will select all files
that belong to a specific configuration.
Tip: If you made changes in the current session, the changed configuration files are highlighted,
and the structure is automatically selected in the tree. The associated AppResources setting
appears at the top of the list when a change is made in the current session.
l To search for an existing configuration, enter a partial Name followed by the wildcard character '*'
(for example, connection*) and click Search.The configuration structure that matches the
search loads in the tree.
4. Enter an Add-On Name.
5. Click Export as Add-On. A message indicates when the export is successful.
6. Optionally, click the Download link, then save the archive file to the required directory.
17.5 Uploading Content

Use the Upload Content feature to update configurations files or implement templates for ChartBooks or
printing for the current build. The Upload Content feature allows you to quickly make permanent changes
to the build that will be included if the build is exported. Note that uploading content will overwrite any
Nakisa Inc. 197

17 Build Management
duplicate files. To add features that can be enabled and disabled, and to take loading precedence into con-
sideration, use the Add-On Manager instead.
Warning: The Upload Content feature should only be used by advanced administrators.
Updated configuration files must be in a ZIP file that follows the same folder structure found in the
/Admin_Config/[build workspace] directory. For example, to upload the PositionView_
Standard.xml file, it must be placed in a /AppResources/viewconfiguration directory within
the ZIP file.
Warning: Because Nakisa applications are highly customizable, the folder structure of the ZIP file is not
validated upon import. Create a back-up of your build and ensure the folder structure in the ZIP file is cor-
rect before continuing, to avoid unexpected results.
Imported files are copied to the [application directory/.system/Admin_Config/[build
workspace]/.delta directory, and are enabled once the build is published.
Tip: If you wish to import a complete build, use the Import Build feature instead.
To upload files into the current build:

1. Access the Nakisa AdminConsole, then load the required build.
2. In the top-right area of the interface, click Upload Content. If the button is not visible, click the Save
& Publish current build link in the menu panel.
3. Click Browse, then locate the ZIP file to upload.
4. Click Upload, then click Logout.
5. Log back into the Nakisa AdminConsole, then load the build.
6. Click Publish to enable the changes in the User Console.
17.6 Resetting Builds

When builds are published, all files contained in the build workspace folder are copied to the main applic-
ation directory. Importing many customizations into a build and saving or importing many builds can
cause the application directory to become filled with many extra files. If one of the builds introduced an
error, then it may become impossible to load and publish other functioning builds.
Resetting the build will clean up the root application folder. Note that the root folder is always cleaned up
the same way regardless of which build was reset. All of the files and folders are deleted except for the fol-
lowing:
l [application directory]/.system
l [application directory]/Log
l [application directory]/WEB-INF
l [application directory]/adminUsers.rgstr
Note: The adminUsers.rgstr is an encrypted file that contains the user names and passwords of
administrator users. It does not exist when a fresh build is deployed and is only created when a new
administrator user is created or the password of the default administrator user is changed. This file is
not deleted when resetting a build.
Once the application completes the cleanup, it logs out the administrator, reloads the root directory with
files and folders resembling a new build that has just been loaded but not yet published, and redirects the
198 www.nakisa.com
administrator to the login page. The build needs to be published for the User Console to become available
again.
Note: Resetting a build preserves all changes, customizations, add-ons, and saved builds, which are
found in the [application directory]/.system directory.
To reset a build:
1. Access the Nakisa AdminConsole, then load a build.
2. If the Upload Content, Export Changes, Save As, and Publish buttons are not displayed in the top-
right corner, click Save & Publish current build in the menu panel.
3. Nakisa recommends saving the build before resetting it.
4. Click Reset Build > Log Off and Reset Build.
5. Log back into the Nakisa AdminConsole, and load the required build.
6. In the top-right corner, click Publish.
17.7 Deleting Builds

After saving and publishing a build, it appears in the build selection frame when accessing the Nakisa
AdminConsole. Any custom build appearing in this frame can be deleted. Deleting a build completely
removes its build workspace folder.
Note: Default builds shipped with the application cannot be deleted.
To delete a build:
1. Open the administrator URL. The build selection frame is displayed.
2. Select a custom build, which is identified by the phrase "(user created)" after the Build Name.
3. Click Delete under the Action column.
17.8 Adding Comments to Builds

The Build panel at the top of the Nakisa AdminConsole provides the name, last-modified date, and last-
published date for the selected build. Administrators can include their own comments about configuration
changes made to a build in this panel.
To add comments:
1. Click next to Comments in the Build panel.
2. Enter text in the field provided, then click OK. The comment is added to the Build panel, and the build
selection frame.
3. Click Save.
Nakisa Inc. 199

18 Backing Up and Restoring
18
18.1 Backing Up and Restoring Builds 201
18.2 Backing Up and Restoring the Staged Database 201
18 Backing Up and Restoring
18.1 Backing Up and Restoring Builds

Nakisa recommends backing up builds according to your organization's backup policy, as well as before
any major changes are made to the configurations. The application provides the following tools to back up
and restore builds and configurations:
l Export builds: Creates a ZIP file of all the configurations made in the build. This method is ideal for
backing up a complete build.
l Import builds: Loads the configurations contained in the ZIP file as a new build in the application.
l Export configurations: Creates an add-on file that contains specific settings. This method is ideal for
backing up certain configurations.
l Upload content: Loads the add-on file that contains specific configurations into the currently-loaded
build.
See the respective topics for more details and instructions.
18.2 Backing Up and Restoring the Staged Database

To ensure that large amounts of analytic data, audit history, saved org charts and listing, and settings are
not lost, Nakisa recommends backing up the staged database at least once a month.
Based on the database installed, refer to the following SAP notes and links for more information:
l For SQL databases:
l Note 1420452: FAQ: Restore and recovery with MS SQL Server
l Note 437160: MS Disaster Recovery Articles for MS SQL Server
l Note 193816: Restore with SQL Server
l Note 44449: Backup strategies with the SQL server
l Note 1297986: Backup and Restore strategy for MS SQL Server
l For Oracle databases:
l Note 842240: FAQ: Backup strategy of large and highly-available databases
l Note 605062: FAQ: Restore and recovery
l Note 966117: Oracle Flashback Database technology
l For DB2 databases:
l http://www.ibm.com/developerworks/wikis/download/attachments/116426414/IBM-Backup-and-
Recovery-Guide-of-DB2-in-SAP-Environments.pdf
201 www.nakisa.com
19 Add-On Manager
19
Learn how to import customizations.
19.1 Add-On Manager Overview 203

19.2 Activate an Add-On 203
19.3 Create an Instructions File 204
19.4 Enable an Inactive Add-On 205
19.5 Disable an Add-On 205
19.6 Remove an Add-On 206
19 Add-On Manager
19.1 Add-On Manager Overview

Nakisa add-ons are a mechanism for exchanging discrete application components, primarily used in the
distribution of enhancements, hot fixes, or service packs.
The Nakisa AdminConsole Add-On Manager allows you to do the following:
l Export and transfer changes to administrator builds, or specific configurations, from the test envir-
onment to the operational system.
l Load and test add-on enhancements and customizations provided by Nakisa before publishing live.
l Select how add-ons load in the application so client files always get precedence.
l Disable add-ons that produce unexpected results from loading in the client application.
l Disable and remove add-ons that are no longer required.
Note: You can also use the Upload Content feature to quickly add changes to the build, but these
changes are permanent and do not take loading precedence into consideration; uploading content will
simply overwrite any duplicate files.
The following table provides the directory structure for the Add-On Manager.
Directory Use
[application directory]/.system/add-ons Stores the software extensions (add-on dir-
ectories and application files) used by the
administrator build.
[application directory]/.system/add- Stores the add-on archive files to load in the

ons/inbox Add-On Manager.
It is recommended to save all add-on archive files in the [application directory]

/.system/add-ons/inbox directory.
19.2 Activate an Add-On

The Add-On Manager is used to load and activate an add-on in the build. This process involves the fol-
lowing steps:
l Load an add-on file
l Set the loading precedence between enabled add-ons
l Activate the add-on configurations in the build
Once an add-on is activated, you can publish the build to enable the settings in the live client. See Saving
and Publishing a Build, section 2.5 on page 8 for more information about publishing a build.
Note: There is a special add-on called add-on-customizations that appears in the Add-On Manager by
default. This is reserved for use by Nakisa Professional Services.
Load an Add-On File

Load an add-on stored in the [application directory]/.system/add-ons/inbox directory to
the Add-On Manager.
203 www.nakisa.com
To load from the inbox:
1. In the menu panel, click Application-wide Settings > Add-On Manager.
2. Select the required add-on from the Load from Inbox drop-down list.
3. Click Load from Inbox. The add-on is moved to the Loading Precedence list.
To upload an add-on from a network directory:

1. In the Browse for File section, click Browse.
2. Navigate to the directory where the add-on files are stored.
3. Select the required add-on file and click Open.
4. Click Load. The add-on is moved to the Loading Precedence list.
Set the Loading Precedence

Configure the precedence between add-ons once an add-on is loaded in the Add-On Manager. This
ensures all implicit and forward dependencies are found for a needed function when the application loads.
Client files and manual settings submitted in the Nakisa AdminConsole wizards after activating the add-
on always get precedence.
To set precedence:
1. Select the required add-on from the Loading Precedence list.
2. Click Move Up or Move Down to set the required order.
Activate the Add-On

Activate the add-on configurations in the build.
To activate the add-on:

1. Click Submit in the Add-On Manager once the add-ons are set to load in the required order.
2. Log out of the Nakisa AdminConsole to activate the add-on in the build. The add-on is extracted to a
new directory under [application directory]/.system/add-ons.
3. Log back into the Nakisa AdminConsole, then load the build where the add-on was applied.
4. Publish the build. All settings stored in the add-on are enabled in the application.
19.3 Create an Instructions File

An instructions file named addOnInstructions.txt is typically included with the add-ons provided by
Nakisa.
The file is saved in the add-on archive file, and is read by the Add-On Manager to quickly perform these
tasks when the add-on loads:
l Set the precedence between the new add-on and an existing add-on
l Disable old add-ons in the application
The following table lists typical commands entered in the instructions file.
Nakisa Inc. 204

19 Add-On Manager
Command Description
after [add_on_path] Sets the loading precedence when a new add-on is dependent on
another add-on in order to load.
This command is entered only once in the instructions file.
disable [add_on_path] Moves an existing add-on to the disabled list.

This command is optional, and may be included in the instructions
file more than once, as required.
Use these commands to create an instructions file for add-ons created in the Add-On Manager.
To create an instructions file:

1. Open a text editor, and type the required commands in the file.
2. Save the text file as addOnInstructions.txt.
3. Export the build as an add-on in the Nakisa AdminConsole, then save the text file to the add-on
archive file created by the tool.
19.4 Enable an Inactive Add-On

Enable an inactive add-on in the build when required.
To enable an add-on:
2. Select the required add-on from the Disabled Add-Ons list.
3. Click Enable Add-On. The add-on is moved to the Loading Precedence list.
4. Set the required Loading Precedence.
5. Click Submit and log out of the Nakisa AdminConsole.
6. Log back into the Nakisa AdminConsole. The add-on is enabled in the build.
19.5 Disable an Add-On

Disable an add-on from loading in the operational system in the following scenarios:
l The add-on configuration produces unexpected results in the client
l The add-on configuration is out-of-date and no longer required
To disable an add-on:
1. Click Application-wide Settings > Add-On Manager.
3. Click Disable Add-On. The add-on is moved to the Disabled Add-Ons list.
5. Log back into the Nakisa AdminConsole and click the Save & Publish current build link in the
menu panel. The Export Changes, Save As, Save, and Publish actions load in the top frame.
6. Click Publish. The add-on is disabled in the application.
205 www.nakisa.com
19.6 Remove an Add-On
Remove an add-on that is no longer required. The archive file remains in the [application
directory]/.system/add-ons/inbox directory once the add-on is removed; delete the file to
remove it from the application completely.
To remove an add-on:
3. Click Disable Add-On.
4. Select the add-on from the Disabled Add-Ons list.
5. Click Remove Add-On. The add-on is removed from the [application directory]
/.system/add-ons directory.
7. Log back into the Nakisa AdminConsole and click the Save & Publish current build link in the
menu panel. The Export Changes, Save As, Save, and Publish actions load in the top frame.
8. Click Publish. The add-on is removed from the application.
Nakisa Inc. 206

20 Application Logs
20
Learn about the available application logs and how to change their settings.
20.1 Application Log Overview 208

20.2 Enabling Administrator and Error Logs 210
20.3 Enabling AdminConsole Activity Logs 210
20.4 Changing Error Log Settings 210
20.5 Viewing Error Logs 211
20.6 Viewing AdminConsole Activity Logs 212
20.7 Exporting Error and AdminConsole Activity Logs 212
20.8 Generating Performance Reports 212
20.9 Creating Error Logs 213
20.10 Logs and SAP NetWeaver 214
20.11 Trace Application Errors 214
20.12 Remote Support 215
20 Application Logs
20.1 Application Log Overview

Log records are used by administrators to monitor system operation, perform error analysis, or review
changes made to the application configuration.
Nakisa applications create the following log files:
l Admin log: Records all configuration changes made to the application using the Nakisa AdminCon-
sole. A new Admin log file is created for every day that a configuration change is published.
l Error log: Records application and database errors. Error log files are created in the following ways:
l If no log exists, one is created the first time an error occurs.
l A new log is created once the current log reaches 3 MB in size.
l The Roll Log button creates a new Error log file.
l AdminConsole Activity log: Records information about when users have made changes (such as
saving, publishing, exporting changes, logging in, and uploading content) to the Nakisa AdminCon-
sole. AdminConsole Activity log files are created in the same ways as Error logs. A new log is created
once the current log reaches 3 MB in size.
The following table outlines the default directories where the log files are stored:
Log Type Default Directory

Admin /usr/sap/[system_name]/J00/j2ee/cluster/apps/[Nakisa]/[EAR
name without extension]/servlet_jsp/[WAR name without
extension]/root/.system/Admin_Config/[build workspace]/Log
Error /usr/sap/[system_name]/J00/j2ee/cluster/apps/[Nakisa]/[EAR
name without extension]/servlet_jsp/[WAR name without
extension]/root/Log
AdminConsole /usr/sap/[system_name]/J00/j2ee/cluster/apps/[Nakisa]/[EAR
Activity name without extension]/servlet_jsp/[WAR name without
extension]/root/AdminConsoleLog
The log files are named according to the following convention:
Log Type File name

Admin yyyy-mm-dd.log
208 www.nakisa.com
Log Type File name
Error l Current Error log: cds.log
l Historical logs are generated automatically by the application or manually by
using the Roll Log feature; the naming convention depends on the method the
log was generated.
l If the log file is generated automatically: cds.log.x, where x is a number
from 1-7000.
For example, if there are 10 logs, cds.log.1 is the oldest log, while
cds.log.10 is the most recent (cds.log - without any suffix, is always
the current log).
The numbering scheme works as follows:
l The first time the current Error log reaches 3 MB in size, the number "1"
is appended to the file name and a new current log is created.
l The second time the current log reaches 3 MB, "2" is appended to the file
name and a new current log is created.
l This same process is repeated until the numbers reach 7000.
l If a new log is created after this point, the oldest log is deleted and all pre-
vious logs are renumbered accordingly (i.e. cds.log.2 is renamed to
cds.log.1; cds.log.7000 is renamed to cds.log.6999) , and
"7000" is appended to the file name of the most recent one.
l If the log file is generated manually using Roll Log: cds.log.yyyy-mm-
dd-hh-mm-ss where yyyy-mm-dd-hh-mm-ss is the current date and
time.
AdminConsole l Current Error log: adminconsole.log

Activity l Historical logs are generated automatically by the
application: adminconsole.log.x, where x is a number from 1-7000.
For example, if there are 10 logs, adminconsole.log.1 is the oldest log,
while adminconsole.log.10 is the most recent (adminconsole.log -
without any suffix, is always the current log).
The numbering scheme works as follows:
l The first time the current AdminConsole Activity log reaches 3 MB in size,
the number "1" is appended to the file name and a new current log is created.
l The second time the current log reaches 3 MB, "2" is appended to the file
name and a new current log is created.
l This same process is repeated until the numbers reach 7000.
l If a new log is created after this point, the oldest log is deleted and all pre-
vious logs are renumbered accordingly (i.e. adminconsole.log.2 is
renamed to adminconsole.log.1; adminconsole.log.7000 is
renamed to adminconsole.log.6999) , and "7000" is appended to the
file name of the most recent one.
See also:
Nakisa Inc. 209

20 Application Logs
l Enabling Administrator and Error Logs, section 20.2 below

l Enabling AdminConsole Activity Logs, section 20.3 below
l Changing Error Log Settings, section 20.4 below
l Viewing Error Logs, section 20.5 on the facing page
l Viewing AdminConsole Activity Logs, section 20.6 on page 212
l Exporting Error and AdminConsole Activity Logs, section 20.7 on page 212
l Generating Performance Reports, section 20.8 on page 212
l Creating Error Logs, section 20.9 on page 213
20.2 Enabling Administrator and Error Logs

Use the Log Manager to enable or disable the Admin and Error logs. See Application Log Overview, sec-
tion 20.1 on page 208 for details on the log file names and locations.
To enable the logs:

1. In the menu panel, click Debug Tools > Log Manager.
2. In the Enable/Disable Log section, select the checkbox to enable the required log settings.
The following log settings are available:
l Enable Log Module: Logs application errors.
l Enable Database Tracing: Logs database errors.
l Enable Admin Log Module: Logs configuration changes made in the Nakisa AdminConsole.
20.3 Enabling AdminConsole Activity Logs

Use the Activity Manager to enable or disable AdminConsole Activity logs. See Application Log Over-
view, section 20.1 on page 208 for details on the log file names and locations.
To enable the logs:

1. In the menu panel, click Debug Tools > Admin Activity Manager.
2. In the Admin Console Logger Settings section, select the checkbox Enable Admin Console
Activity Logging.
3. Select Encrypt Log Entries to encrypt the information recorded in the log file. Note that the inform-
ation is not encrypted when it is displayed in the Nakisa AdminConsole.
4. Click Select Activities to Log and select the required actions to log. Click OK.
20.4 Changing Error Log Settings

The information written to the Error log has three severity levels:
210 www.nakisa.com
l INFO: Informational messages indicate when normal situations occur, for example, when the server is
unable to deliver a notification message to a user who is logged off, when a user logs in, the authen-
tication method used, or the user population. Note that user logouts are not logged.
l WARNING: A warning referencing a task signals a condition that does not prevent the completion of the
task, but might indicate that some action is needed on behalf of the administrator.
l ERROR: An error referencing a task signals a condition that might prevent the task from completing suc-
cessfully, depending on the setting of other parameters. Errors indicate that administrative action is
needed.
The application writes log entries of all severity levels (trace levels) to the Error log file by default. The fol-
lowing log severity levels are available:
l Errors, Warnings, and Information
l Errors and Warnings
l Errors only
Switching the severity level can help with the tracing of issues with the application.
Note: The decision to switch severity levels is left to the discretion of the system administrator.
To switch the severity level value:

2. In the Set logging level section, select the required logging level.
3. Click Submit to save your changes.
Note: Increasing the log severity level has an impact on overall performance.
20.5 Viewing Error Logs

A log viewer is available in the Nakisa AdminConsole to provide quick access to Error log entries.
Note: The log viewer is used to view the Error log only.
To view logs:
The View Log section displays the Error log for the current session by default.
2. Select the Error log you wish to view from the drop-down menu.
The current log is named cds.log. See Application Log Overview, section 20.1 on page 208 for
details on the naming convention for historical logs. The first 25 lines of the log file are displayed.
l Info messages are displayed in black text.
l Warning messages are displayed in orange text.
l Error messages are displayed in red text.
3. Use the navigation buttons to view the First, Previous, Next, or Last 25 lines in the log file.
Nakisa Inc. 211

20 Application Logs
20.6 Viewing AdminConsole Activity Logs

A log viewer is available in the Nakisa AdminConsole to provide quick access to AdminConsole Activity
log entries.
To view AdminConsole Activity logs:

1. In the menu panel, click Debug Tools > Admin Activity Manager.
The Select Log File section displays the AdminConsole Activity log for the current session by
default.
2. Select the log you wish to view from the drop-down menu.
The current log is named adminconsole.log. See Application Log Overview, section 20.1 on page
208 for details on the naming convention for historical logs. The first 25 lines of the log file are dis-
played.
3. Use the navigation buttons to view the First, Previous, Next, or Last 25 lines in the log file.
20.7 Exporting Error and AdminConsole Activity Logs

The Error log and AdminConsole Activity log are available to export through the Nakisa AdminConsole.
By exporting the Error log, the user can have a copy of the log to save locally.
To export the Error log:

2. In the View Log section, click Export Logs to export all of the logs.
3. Click the Download Logs link that appears to download a ZIP file containing the Error log files.
Tip: You can optionally export logs and system information together. See Viewing and Exporting System
Information, section 6.2 on page 53 for more information.
To export the AdminConsole Activity log:

1. In the menu panel, click Application-wide Settings > Admin Activity Manager.
2. In the Select Log File section, click Export to Excel to export the selected log.
3. Click the Download link that appears to download a ZIP file containing the selected AdminConsole
Activity log file.
20.8 Generating Performance Reports

Generating a performance report collects and summarizes data found in an Error log file. There are two
types of performance reports:
l The Detailed Performance Report provides the following information per action, displayed chro-
nologically:
l Time when the action occurred
l Action name
212 www.nakisa.com
l Total action time (in milliseconds)
l Name of processor (Java class) that performs the action
l Total RFC calls
This section is split into two components:
l Number of all RFCs called for the action
l Sum of all instances that each individual RFC was called
l Total RFC times
This section is split into two components:
l Total time (in milliseconds) of all RFCs called for the action
l Sum of the time (in milliseconds) for each individual RFC
l The Summary Performance Report gives the following information per action, displayed chro-
nologically:
l Time when the action occurred
l Action name
l Name of processor (Java class) that performs the action
l Total action time (in milliseconds)
l Total RFC calls for the action
l Total time (in milliseconds) of all RFCs called for the action
To generate a performance report:

2. In the View Log section, select the log file for which you want to generate performance reports.
3. In the Select an action section, click Generate Performance Report.
4. Click the Download Report link that appears to download a ZIP file containing the two performance
report files, in the format:
l logs-detailed-yyyy-mm-dd-hh-mm-ss.csv
l logs-summary-yyyy-mm-dd-hh-mm-ss.csv
where yyyy-mm-dd-hh-mm-ss is the time when the reports were generated.
Tip: The Roll Log button is useful for generating reports for specific time periods or actions. See Creating
Error Logs, section 20.9 below for details.
20.9 Creating Error Logs

The application automatically generates Error log files upon login to the Nakisa AdminConsole, but you
can also force the creation of a new Error log file.
To manually create a new Error log file:

2. In the Select an action section, click Roll Log.
The application renames the current log file to cds.log.yyyy-mm-dd-hh-mm-ss (where yyyy-mm-
dd-hh-mm-ss is the current time), and creates a new cds.log file to continue recording the day's log.
Nakisa Inc. 213

20 Application Logs
Tip: Creating a new log file is useful when you want to generate reports for a specific action. In this case,
you would click the Roll Log button to create a new log file, perform the required action, then click the Roll
Log button again, thus creating an Error log file containing only those log entries relevant to the performed
action.
20.10 Logs and SAP NetWeaver

Administrators can update the provider properties to send Nakisa application log messages to SAP
NetWeaver.
To direct Nakisa application log messages to SAP NetWeaver:

1. Navigate to the [application directory]/.system/application/Log directory of the
application.
2. Open the provider.properties file.
3. Un-comment the following lines:
l com.nakisa.log.provider=com.nakisa.framework.utility.log.SAPLogProvid
er
l sap.logger.location=com.nakisa.application
l sap.logger.category=Nakisa
4. Comment out the following lines:
com.nakisa.log.provider=com.nakisa.framework.utility.log.Log4JLogProvid
er
5. Update the values of sap.logger.location and sap.logger.category for the system, if
required. These are the values that identify the Nakisa error messages within the SAP NetWeaver
Administrator log viewer
6. Save and close provider.properties.
7. Restart the Nakisa application from the SAP NetWeaver Administrator control panel.
Note: It is not possible to direct log entries to the Nakisa application log and the NetWeaver logging sys-
tem at the same time.
To view Nakisa application log messages in SAP NetWeaver:

1. Log in to the SAP NetWeaver Administrator control panel.
2. In the Show menus, choose General View and SAP Logs (Java).
3. Click Show View Properties.
4. In the Search By menus, choose Category and contains, then enter Nakisa in the search text field.
5. Click Find next. The log messages generated by the Nakisa application are displayed.
20.11 Trace Application Errors

Transaction SLG1 (Application Log: Display Logs) is used to find and trace application errors logged in the
system by the Nakisa RFC function modules.
214 www.nakisa.com
Refer to the ZNAKISA_OBJECT Object and Sub-Objects section of the Nakisa Transport Package
Installation and Specifications Guide (located in the Documents/InstallationGuides folder in the
Visualization Solutions by Nakisa 4.3 ZIP file) for a complete list of sub-objects for each Nakisa function
module.
To view logs for Nakisa objects:

1. Log on to the SAP system and start transaction SLG1.
2. Enter 'ZNAKISA_OBJECT' as the Object to view all logs generated by Nakisa applications.
3. Enter the required Subobject to view log errors generated by a particular Nakisa RFC function mod-
ule.
4. Select the required Time Restriction. Application logs are saved in the system for seven days.
5. Click Execute.
20.12 Remote Support

The manager URL provides access to the Nakisa AdminConsole for remote application support:
http://[hostname]/[virtual directory]/manager.jsp
Error logs can be reviewed remotely with the Log Viewer, but access to the Nakisa admin log is unavail-
able using this URL.
The following actions are disabled in the Nakisa AdminConsole when the read-only administrator
accesses the application remotely:
l Submit in all setup wizards
l Save As, Save, and Publish build
l Create new admin user
l Change admin password
l Delete admin users
Follow the standard SAP remote access procedures to locate SAP logs for troubleshooting and support
purposes. Information on setting up remote service connections to SAP is located on the SAP Support
Portal under http://service.sap.com/access-support.
Nakisa Inc. 215

21 Troubleshooting
21
21.1 Error Message: Could not read properties 217
21.2 Error Message: Invalid JAVA_HOME 217
21.3 Cannot extract data to DB2 database 218
21.4 Published changes are unavailable to users 219
21.5 User login screen does not load 219
21.6 User interface does not display correctly 220
21.7 Cannot load the Print and Export wizard 221
21.8 Error Message: Internal Error 221
21.9 Org Chart diagram is missing 222
21.10 Error Message: Invalid login 222
21.11 Unable to navigate through AdminConsole wizards 223
21 Troubleshooting
21.1 Error Message: Could not read properties

Problem
The error "Could not read properties file" is received when launching the application.
Explanation
The JAVA_HOME environment variable is not set.
Solution
Set the JAVA_HOME environment variable in the Microsoft Windows System Properties.
Procedure
1. Right-click My Computer and select Properties. The System Properties dialog box appears.
2. Click Advanced.
3. Click Environment Variables. The Environment Variables dialog box appears.
4. Click New. The New System Variable dialog box appears.
5. Enter 'JAVA_HOME' as the Variable name.
6. Enter the directory path to Java (for example: C:/Program Files/Java/[Java_version]) as
the Variable value, then click OK.
7. Click OK to close Environment Variables.
8. Click OK to close System Properties.
21.2 Error Message: Invalid JAVA_HOME

Problem
The error "Invalid JAVA_HOME" is received when launching the application.
Explanation
The JAVA_HOME environment variable is not set.
Solution
Set the JAVA_HOME environment variable in the Microsoft Windows System Properties.
Procedure
1. Right-click My Computer and select Properties. The System Properties dialog box appears.
2. Click Advanced.
3. Click Environment Variables. The Environment Variables dialog box appears.
4. Click New. The New System Variable dialog box appears.
5. Enter 'JAVA_HOME' as the Variable name.
217 www.nakisa.com
6. Enter the directory path to Java (for example: C:/Program Files/Java/[Java_version]) as
the Variable value, then click OK.
7. Click OK to close Environment Variables.
8. Click OK to close System Properties.
21.3 Cannot extract data to DB2 database

Problem
An error occurs when extracting data to an IBM DB2 database. One of the following error messages is
written to the application log:
"DB2 SQL error: SQLCODE: -964, SQLSTATE: 57011" (which indicates that the transaction log for the
database is full)
"DB2 SQL error: SQLCODE: -286, SQLSTATE: 42727" (which indicates that the table space is too small)
Explanation
The transaction logs have run out of room and must be increased in size, or the system temporary and reg-
ular table space page sizes are not set to 32 KB. Note that if the DB2 user account assigned to the applic-
ation has full administrator privileges, the application will automatically increase the table space sizes.
Solution
The administrator must increase the transaction log sizes. If the application does not have administrator
privileges, the administrator must also increase the system temporary and regular table space page size.
Procedure
Transaction logs
To increase the database's primary and secondary log files, the administrator must run the following com-
mands, where [db_name] needs to be replaced by the name of the database used for staging:
l UPDATE DATABASE CONFIGURATION FOR [db_name] USING LOGPRIMARY 10
l UPDATE DATABASE CONFIGURATION FOR [db_name] USING LOGSECOND 2
Each transaction log file is 10 MB. With these commands, ten primary log files are allocated all the time,
and secondary log files are allocated and deleted as needed, up to a maximum of two files.
Table spaces
To increase the system temporary and regular table space page sizes to 32 KB, the administrator must
run the following commands with the appropriate names and directories:
l CREATE BUFFERPOOL [bufferpool name 1] SIZE 8000 PAGESIZE 32K
l CREATE REGULAR TABLESPACE [regular tablespace name] PAGESIZE 32 K MANAGED BY
SYSTEM USING ('[directory 1]') BUFFERPOOL [bufferpool name 1]
l CREATE BUFFERPOOL [bufferpool name 2] SIZE 8000 PAGESIZE 32K
l CREATE SYSTEM TEMPORARY TABLESPACE [temporary tablespace name] PAGESIZE 32K
MANAGED BY SYSTEM USING ('[directory 2]') BUFFERPOOL [bufferpool name 2]
For example, the commands may be run as follows:
Nakisa Inc. 218

21 Troubleshooting
l CREATE BUFFERPOOL ORGAUDIT_POOL SIZE 8000 PAGESIZE 32K

l CREATE REGULAR TABLESPACE ORGAUDIT_SPACE PAGESIZE 32 K MANAGED BY
SYSTEM USING ('ORGAUDIT_SPACE') BUFFERPOOL ORGAUDIT_POOL
l CREATE BUFFERPOOL ORGAUDIT_POOL_TEMP SIZE 8000 PAGESIZE 32K
l CREATE SYSTEM TEMPORARY TABLESPACE ORGAUDIT_32K PAGESIZE 32K MANAGED
BY SYSTEM USING ('ORGAUDITSMS_32K_1') BUFFERPOOL ORGAUDIT_POOL_TEMP
Refer to the IBM Technical Library article "DB2 Basics: Table spaces and buffer pools" for more inform-
ation.
21.4 Published changes are unavailable to users

Problem
After making changes to and publishing a build from the AdminConsole, users already connected to the
server are unable to see the changes, or experience unexpected behavior.
Explanation
Cache or memory issues may be interfering with the display.
Solution
Ask the user to refresh his or her web browser display. If the problem persists, restart the Nakisa applic-
ation server.
21.5 User login screen does not load

Problem
The login screen does not load.
The user cannot log in.
Explanation
JavaScript is disabled in the Web browser.
Solution
Enable JavaScript in the browser Internet options.
Procedure
Microsoft Internet Explorer:
1. Click Tools on the menu bar, then select Internet Options. The Internet Options dialog box appears.
2. Click the Security tab, then click Intranet.
3. Click Custom Level to open the Security Settings - Local Intranet Zone dialog box.
4. Click Enable for Active Scripting in the Scripting section.
219 www.nakisa.com
5. Click OK to close the dialog boxes.
6. Press F5 to refresh the browser.
Mozilla Firefox:
1. Click Tools on the menu bar, then select Options.
2. Click Content and select the Enable JavaScript checkbox.
3. Click OK to close the dialog box.
4. Restart Firefox.
21.6 User interface does not display correctly

Problem
The application interface does not display correctly.
Explanation
Screen resolution is too low.
JavaScript is disabled in the Web browser.
Solution
Set your computer screen resolution to 1024 by 768 or higher in the Windows Display Properties.
Enable JavaScript in the browser Internet Options.
Procedure
1. Right-click the Windows Desktop and select Properties. The Display Properties dialog box appears.
2. Click the Settings tab.
3. Drag the Screen resolution bar and increase the value to 1024 by 768 or higher.
4. Click Apply. The screen adjusts to the selected resolution.
5. Click Yes to save the new settings.
6. Click OK.
Procedure
2. Click the Security tab, then click Intranet.
3. Click Custom Level to open the Security Settings - Local Intranet Zone dialog box.
4. Click Enable for Active Scripting in the Scripting section.
5. Click OK to close the dialog boxes.
6. Press F5 to refresh the browser.
Mozilla Firefox:
2. Click Content and select the Enable JavaScript checkbox.
Nakisa Inc. 220

21 Troubleshooting
3. Click OK to close the dialog box.

4. Restart Firefox.
21.7 Cannot load the Print and Export wizard

Problem
The Print and Export wizard does not load after selecting Print from the Actions menu.
Explanation
Pop-up windows are disabled in the Web browser.
Solution
Enable pop-up windows in the browser Internet options.
Procedure
2. Click the Privacy tab.
3. Clear the Turn on Pop-up Blocker checkbox in the Pop-up Blocker section.
4. Click Apply and OK.
Mozilla Firefox:
2. Click Content, then clear the Block pop-up windows checkbox.
3. Click OK.
21.8 Error Message: Internal Error

Problem
The user receives an "Internal Error".
Explanation
An error referencing a job signals a condition that might prevent the job from completing successfully,
depending on the setting of other parameters.
Errors indicate that administrative action is needed.
Solution
Perform error analysis using the log messages created by Nakisa applications.
221 www.nakisa.com
Procedure
Log messages are written to the application log files named according to the date when a change or error
occurs in the application or Nakisa AdminConsole: yyyy-mm-dd.log.
The Error log records application, configuration, and database messages, and indicates three severities:
INFO, WARNING, and ERROR. This log is saved to the /Log folder in the main application directory.
The Admin log records Nakisa AdminConsole activity. The configuration file modified, the user who made
the modification, and the changes made to the application is recorded. This log is saved to the /Admin_
Config/[build]/Log folder.
21.9 Org Chart diagram is missing

Problem
The org chart diagram is missing when the user opens a hierarchy.
Explanation
The data source connection string is not set or incorrectly configured.
Root ID for the hierarchy is not set.
Solution
Open the Nakisa AdminConsole, then verify the following for each hierarchy:
l Check the connection settings in the Data Connection setup wizard.
l Check the Hierarchy fields in the General Settings setup wizard.
Procedure
Refer to the following sections:
l Data Connection provides information about the connection settings used to retrieve data from the
company server.
l Hierarchies provides information about setting up the hierarchy root ID.
21.10 Error Message: Invalid login

Problem
The user is unable to log in to the application with their user name and password, even though the cre-
dentials provided are correct.
Explanation
The log-in fails if the user does not have a role, regardless of authentication.
Nakisa Inc. 222

21 Troubleshooting
Solution
Check the security settings in the Nakisa AdminConsole to ensure user authorization and roles are cor-
rect.
Procedure
Refer to the following sections:
l Defining Roles
l Mapping Roles
21.11 Unable to navigate through AdminConsole wizards

Problem
Unable to navigate through the Nakisa AdminConsole wizards after deploying the application on SAP
NetWeaver.
Explanation
Relative URLs are disabled.
Solution
Enable relative URLs in the AS Java Config Tool.
Procedure
1. Log on to the hosting server as an administrator.
2. Navigate to the /usr/sap/[system_name]/j00/j2ee/configtool directory, then run
configtool.sh (in Linux), or configtool.bat (in Microsoft Windows).
The AS Java Config Tool opens.
3. Click Yes, if prompted.
4. Select View, Expert Mode from the main menu to enter Expert Mode.
5. Expand cluster-data, Template, managers, then select ClassLoaderManager in the left pane. The
Manager properties load in the right pane.
6. Select the ForceResourceClose key in the table.
7. Enter false as the Custom Value in the Custom Property Data section, then click Set Custom
Value.
8. Select File, Apply Changes from the main menu.
9. Restart the application server instance.
223 www.nakisa.com
22 Glossary
22 Glossary
The following table lists the terms and definitions specific to the Nakisa AdminConsole.
Term Definition
Admin Log A function that traces application configuration changes.

module
Administrator The interface used by administrators to configure Nakisa applications.

Console
analytic A tool for measuring specific information, such as gender, age, or performance, in an
organizational chart.
analytic oper- The calculation method for an analytic.

ation
analytic scope The calculation range of analytic data in an organizational chart.
analytic type The method of calculating shared positions.
anonymous An authentication method that provides access to the application without a user-spe-
login cific account.
assistant filter An SQL filter that includes or excludes assistants.
authentication The method of granting users access to the application.

mechanism
authentication The data source that contains user access information.

source
build A saved configuration that contains data connection, security, and feature settings for
the application.
build panel The top section of the Administrator Console that displays details on the current build.
build selection A list of builds that loads when the Administrator Console is accessed.
ChartBook A printed copy of an org chart.
child exists fil- An SQL filter used to identify whether a hierarchy node has a child.
ter
Child hierarchy A hierarchy that is linked to a parent hierarchy in an org chart. A child hierarchy may
also have its own child hierarchy linked to it.
column table A Details Designer and View Designer placeholder that displays elements in the table
element side by side.
condensed An org chart box view that is smaller than the regular style. See regular style.
style
data table The name of the relational database table used to configure the current feature or task.
224 www.nakisa.com
default org The defined top level of an org chart that does not have a parent.
chart root
Details A customizable schematic of graphical user interface controls in the application

Designer Details panel.
Details panel The panel that displays additional information on a selected employee, org unit, or pos-
ition record.
direct count An analytic scope that includes the counts of a single organizational unit.
directory filter An SQL filter that limits directory search results to a specific type of record.
dotted rela- The situation where an employee holds more than one position and/or reports to more
tionship than one manager.
dotted rela- A SQL filter that displays employees reporting to multiple managers in an org chart
tionship filter node with dotted lines as borders.
element ID The field containing the unique ID for an employee, position, or org unit.
field
email section A View Designer element that displays the selected field as an e-mail address.
employee The defined data source that maps users from Active Directory to the same user
source record in the application.
employee type A View Designer element that displays an icon representing the employment status of
section a record. Different employee types include full-time, part-time, and contract.
export limit The maximum number of records that can be printed or exported to a third-party applic-
ation such as Microsoft Excel.
field link A Details Designer and View Designer function allowing information that is not
included in the current record to be displayed.
field value sec- A Details Designer and View Designer element that displays the field name and value.
tion
field/value sec- A Details Designer element that displays the field name and value for multiple fields.
tion multiple
flag org chart A feature accessed in the org chart box menu that adds the specified org chart box to
box the Selected Items panel. See Selected Items panel.
forest brows- The method of retrieving information from an Active Directory forest.
ing mech-
anism
forms login An authentication method that prompts users for a user name and password to access
the application.
group by The field of the child hierarchy that matches the value in the Link Using field of the par-
ent hierarchy. The method used to configure linked hierarchies. See link using.
group child An SQL filter used to identify whether a child hierarchy is linked to the parent hier-
Nakisa Inc. 225

22 Glossary
exists filter archy.
head count The total number of employees in an organizational unit
hidden section A concealed section in the View Designer that uses the value of a field as a condition.
hierarchy The structural relationship of employees, positions, or org units.
hierarchy ID The field used to create a hierarchy structure, typically the unique ID of an employee,
field position, or org unit.
hierarchy par- The field that contains data representing the supervising manager, position, or org unit.
ent field
hierarchy root The top level of a hierarchy that does not have a parent node.
image section A Details Designer element that displays the specified field as a portrait.
indirect count An analytic scope that includes counts of an organizational unit and its subordinate
organizational units.
initial catalog A parameter that specifies the database name for the data source in an SQL con-
nection string.
link using The field of the parent hierarchy that matches the value in the Group By field of the
child hierarchy. The method used to configure linked hierarchies.
linked hier- A hierarchy that is joined to another hierarchy by a common value. An employee hier-
archy archy can be linked to a position hierarchy, for example.
listing A dynamic table that displays employee, org unit, or position information.
listing section A Details Designer element that displays the selected field values as a listing.
Log module A function that traces application errors.
module A self-contained application component that has features and/or tasks of a similar
focus.
name section A Details Designer and View Designer element that displays only the field value.
name section- A Details Designer and View Designer element that displays only the field value for
multiple multiple records.
node An individual element in a hierarchy that is branched to parent and/or child nodes
based on structural relationships.
org chart A diagram, consisting of one or more hierarchies, that shows the organization struc-
ture and the relationships and relative ranks of its parts.
org chart box An individual element of an organizational chart that displays record information in a
box.
org chart root The top level of an org chart. The org chart root does not have a parent org chart box.
org chart style A way of displaying org charts. A vertical style displays all org chart boxes vertically,
for example.
226 www.nakisa.com
org chart view The layout of information displayed in an org chart box.
OrgChart mod- The component that displays employee, position, or org unit information in organ-
ule izational charts.
OrgModeler The database containing scenario information.

database
panel element A Details Designer and View Designer placeholder with an editable title.
parent descrip- The field describing the manager, typically the name or title. This value appears when
tion field starting the org chart one level above an employee who reports to multiple managers.
Parent hier- A hierarchy that has a child hierarchy linked under it in an org chart. A parent hierarchy
archy may also have its own parent hierarchy.
picture section A View Designer element that displays the selected field as a portrait.
Profile window A pop-up window that displays the details of a record.
publish A task in the Administrator Console used to save and apply application changes. Pub-
lished changes are visible by users.
record selector A tool for selecting single or multiple records from a listing or org chart.
regular style The normal org chart box layout. The regular style is larger than the condensed style,
allowing more information to be displayed in the org chart box. See condensed style.
ReturnSet Cap- The field value that is displayed when users choose a record from the record selector.
tion
ReturnSet The field value (typically the unique ID) that is sent back to the application when users
Value select a record from the record selector.
RFC Remote Function Call. The function that fetches data from the SAP server and per-
forms basic processing on it.
Root hierarchy A hierarchy that is not linked under any other hierarchy in an org chart. Root hier-
archies do not have parent hierarchies.
Equivalent to a "top-level hierarchy".
row table ele- A Details Designer and View Designer element that displays elements in the table ver-
ment tically.
scenario A "what-if" situation that is created to help manage organizational changes.
Scenarios mod- The component used to create and manage "what-if" situations in order to understand
ule and analyze the impacts of organizational changes.
search base The fully-qualified Active Directory user name that is used as the starting point in an
LDAP search.
search limit The maximum number of entries returned when the application performs a request on
Active Directory or ADAM.
section ele- A Details Designer and View Designer element where the displayed fields and/or val-
Nakisa Inc. 227

22 Glossary
ment ues are defined.
secure item An application feature or task that has access restricted to specific roles. See role.
Selected The panel that displays flagged org chart boxes or selected listing records.
Items panel
serial file A file needed to activate the application. This file specifies the available modules, lan-
guages and total number of records the application can access.
Settings panel The panel where users define their display preferences for org charts and listings.
shared pos- A position that has more than one assigned employee.
ition
simple caption A View Designer element that displays the value of the selected field. Only one field
section may be selected.
simple value A View Designer element that displays the value of multiple fields.
section
subcategory A grouping of similar employees or positions that can be displayed in one org chart
group box.
swap file A file that stores user-defined settings, such as preferred language and theme, saved
listings and hierarchies, listing and org chart settings.
tabs element A Details Designer placeholder that creates a new tabbed detail.
task An activity or set of activities performed by users to add, modify or delete data stored
on the company server directly from the application.
telephone sec- A View Designer element that displays the selected field as the telephone number.
tion
Top-level hier- A hierarchy that is not linked under any other hierarchy in an org chart. Top-level hier-
archy archies do not have parent hierarchies.
Equivalent to a "root hierarchy".
User Console The application interface where users access Nakisa modules, tasks and features.
validation The process of ensuring consistent and correct data input between users.
Windows Integ- A method that automatically authenticates users based on their Windows login cre-
rated login dentials. Users must be on the same domain as the authentication server.
228 www.nakisa.com
23 Index
builds
A comments, adding to 199
expoting 195
Add-on Manager, about 203
importing 196
add-ons
loading 6
disabling 205
panel, in user interface 8
inactive, enabling 205
saving and publishing 8, 194
instruction files, creating 204
loading and activating 203
C
removing 206
AdminConsole caption editor, using 45
Internet options, enabling for 7 captions
launching 6 ChartBook, setting up 184
securing 21 editing 45
administrator logs, enabling 208 exporting and importing 46
administrator password, changing 21 captions, in views 160
administrator users, adding 21 ChartBook
Anonymous, as authentication mechanism 27 about using 181
application-wide settings 33 captions, setting up 184
application errors, tracing 214 enabling and disabling in User console 181
application logs 207 modes 181
audit data, extracting 66 templates 182
audit runs, about 90 collapsible panels, adding to layout 118
authentication. See user authentication 27 color mapping, in org chart boxes 164
authorization objects 13 company logo, defining 34
condensed style, in View Designer 165
B configurations, exporting 197
connection strings, about 12
box color, modifying 164
CSV files
box size, modifying 163
captions, exporting to 46
build panel, in user interface 8
build workspaces, location 6
Nakisa Inc. 229

23 Index
tabs, adding to 119

D details, about 111
data center, overview 100

E
data connections
establishing 150 emergency users, about 18
managing 100 employee source, in user authentication 30
data elements error logs, enabling 208
creating 103 error messages, customizing 45
using 104 errors, tracing 214
data elements, about 111
data extraction G
starting 59
general settings, configuring 34
databases, connecting to 151
dates, default format 190
H
debug tools 52
Detail Designer hidden sections, in org chart views 165
layout elements 129 hierarchies
details child, setting up 153
design, modifying 112 in org charts 152
joined, creating 115 linking 154
linked, creating 114 parent, setting up 152
linking to hierarchies 142
linking to listings 144 I
linking to org charts 143
images, defining 34
profile and top-level, creating 112
title, adding 116
J
Details Designer
about 111 joined details, creating 115
Details panel
assigning listing to 174 K
designing 111
keywords
layout elements 129
in data extraction 58
sections, adding 120
style, customizing 125
table layout, specifying 117
230 www.nakisa.com
23 Index
size 163
L org chart views, hidden sections 165
org charts
layout elements, in Details panel 111
enabling 148
linked details, creating 114
linking to details 143
listings
overview 146
about 168
OrgAudit
connecting to data source 170
hierarchies, about 146
Details panel, assigning to 174
enabling and disabling 169
P
fields updating 171
linking to details 144 panels
log viewer, using 211-212 styles, customizing 125
logos, defining 34 portrait images, defining 34
logs preferences, application default 190
administrator, enabling 208 preview mode, views 165
error, enabling 208 Profile window, designing 111
sending to SAP NetWeaver 214 publishing, builds 8, 194
severity level, specifying 210
viewing 211-212 R
logs, application 207
remote support, application 215
M roles
access, denying 26
mapping, roles 30 creating 25
menu panel, in user interface 8 default, setting 25
MS Excel, exporting caption to 46 deleting 26
mapping 30
N permissions, managing 26
securing items for 23
Nakisa AdminConsole. See AdminConsole 6
user, defining 23
O rules
adding 86
org chart boxes defined 67, 86
color, modifying 164 modifying 89
mapping colors 164 templates 86
Nakisa Inc. 231

23 Index
users
S adding and removing 22
authentication, setting 27
SAP data
emergency 18
source, connecting to 56
roles, defining 23
SAP server, connecting to 102
SAPExtractor
V
destination database, connecting 57
search forms, setting up 173-174 validations
sections, in views 162 auto-complete 42
secure items, for roles 23 auto-complete popup 43
serial file, uploading 7 configuring 36
simple, validating 36 DB list 39
styles editing 44
condensed 165 list 38
swap files, cleaning 189 popup 40
simple 36
T View Designer
accessing 160
table layouts
overview 160
Views 161
views
table layouts, in Details panel 117
enabling and disabling 160
tabs, creating in layout element 119
previewing 165
template rules, about 86
themes, application default 190
W
U wizards
Export Configurations 197
UI. See user interface 7
user authentication
employee source, setting 30
mechanism, selecting 27
setting 27
user console, launching 9
user interface, elements explained 7
user preferences, storing 187
232 www.nakisa.com
Headquarters Europe Asia Pacific
Nakisa Inc. Nakisa GmbH Nakisa
733 Cathcart Altrottstraße 31 24-12
Montreal, Quebec H3B 1M6 69190 Walldorf 10 Anson Road, International Plaza
Canada Germany Singapore 079903
Phone: +1 (514) 228-2000 Phone: +49 (0) 6227-734070 Phone: +65 6822-5991
Fax: +1 (514) 286-9786 Fax: +65 6822-5990
For more information, please visit us at www.nakisa.com

OrgAudit VSN43 Admin en

Diunggah oleh

Informasi Dokumen

Judul Asli

Hak Cipta

Format Tersedia

Bagikan dokumen Ini

Bagikan atau Tanam Dokumen

Opsi Berbagi

Apakah menurut Anda dokumen ini bermanfaat?

Apakah konten ini tidak pantas?

Hak Cipta:

Format Tersedia

OrgAudit VSN43 Admin en

Diunggah oleh

Hak Cipta:

Format Tersedia

Visualization Solutions by Nakisa 4.

3 SAP Connection and Authorization 11

Nakisa Inc. iii

10 Details Designer 110

11 Org Charts 145

12 View Designer 159

13 Listings and Searches 167

14 Custom Listings 176

16 User Preferences 186

17 Build Management 193

18 Backing Up and Restoring 200

19 Add-On Manager 202

20 Application Logs 207

Nakisa Inc. vii

1.1 About Nakisa 2

1.1 About Nakisa

1.2 About the Application

1.3 What's New

1.4 Related Documentation

1.5 Technical Support

2.1 Application Overview 6

2.1 Application Overview

2.2 Launching the Nakisa AdminConsole

To launch the Nakisa AdminConsole:

2.3 Uploading the Serial File

To upload the Serial file:

2.4 Using the Interface

Nakisa logo: Accesses the Nakisa website.

2.5 Saving and Publishing a Build

To save and publish changes to a build:

2.6 Launching the User Console

To access the User Console:

3.1 Connection String

SYSNR SAP system number

USER SAP user name

PASSWD SAP user password

CLIENT SAP client number

GROUP Name of the SAP server group.

SYSNR SAP system number

USER SAP user name

PASSWD SAP user password

CLIENT SAP client number

3.2 User Types

3.3 Authorization Objects

Authorization Check for RFC Access and underlying HR module objects

Authorization for File Access

Archive Link: Authorizations for Access to Documents

CO-CCA: General Authorization Object for Cost Center Accounting

CO-CCA: Cost Center Master

Authorization for Table Maintenance (using standard tools such as SM30)

HR: Master Data (used for HR infotype authority checks)

Object Field Value

PERSA * (Personnel area)

PERSG * (Employee group)

PERSK * (Employee Subgroup)

SUBTY * (Subtype are subdivisions of infotypes)

VDSK1 * (Organizational Key)

HR: Master Data - Personnel Number Check

Object Field Value

PSIGN * (Interpretation of assigned personnel number)

SUBTY * (Subtypes are sub-divisions of info types)

Object Field Value

ISTAT * (Planning Status)