Section 1 - Sailpoint Tool Installation
Section 1 - Sailpoint Tool Installation
SailPoint Technologies, Inc. makes no warranty of any kind with regard to this manual, including, but not limited to, the implied
warranties of merchantability and fitness for a particular purpose. SailPoint Technologies shall not be liable for errors contained
herein or direct, indirect, special, incidental or consequential damages in connection with the furnishing, performance, or use of
this material.
Restricted Rights Legend. All rights are reserved. No part of this document may be photocopied, reproduced, or
translated to another language without the prior written consent of SailPoint Technologies. The information contained in
this document is subject to change without notice.
Use, duplication or disclosure by the U.S. Government is subject to restrictions as set forth in subparagraph (c) (1) (ii) of
the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 for DOD agencies, and subparagraphs
(c) (1) and (c) (2) of the Commercial Computer Software Restricted Rights clause at FAR 52.227-19 for other agencies.
Regulatory/Export Compliance. The export and reexport of this software is controlled for export purposes by the U.S.
Government. By accepting this software and/or documentation, licensee agrees to comply with all U.S. and foreign export
laws and regulations as they relate to software and related documentation. Licensee will not export or reexport outside
the United States software or documentation, whether directly or indirectly, to any Prohibited Party and will not cause,
approve or otherwise intentionally facilitate others in so doing. A Prohibited Party includes: a party in a U.S. embargoed
country or country the United States has named as a supporter of international terrorism; a party involved in
proliferation; a party identified by the U.S. Government as a Denied Party; a party named on the U.S. Government's
Entities List; a party prohibited from participation in export or reexport transactions by a U.S. Government General Order;
a party listed by the U.S. Government's Office of Foreign Assets Control as ineligible to participate in transactions subject
to U.S. jurisdiction; or any party that licensee knows or has reason to know has violated or plans to violate U.S. or foreign
export laws or regulations. Licensee shall ensure that each of its software users complies with U.S. and foreign export
laws and regulations as they relate to software and related documentation.
Trademark Notices. Copyright © 2017 SailPoint Technologies, Inc. All rights reserved. SailPoint, the SailPoint logo,
SailPoint IdentityIQ, and SailPoint Identity Analyzer are trademarks of SailPoint Technologies, Inc. and may not be used
without the prior express written permission of SailPoint Technologies, Inc. All other trademarks shown herein are
owned by the respective companies or persons indicated.
Contents
Course Overview ...................................................................................................................................................................... 7
Introduction .......................................................................................................................................................................... 7
The Virtual Machine Environment .............................................................................................................................. 7
Shortcuts/Applications Provided ................................................................................................................................ 8
Section 1: Installing, Identity Cubes, Onboarding Applications ........................................................................... 9
Exercise #1: Installing IdentityIQ ................................................................................................................................... 11
Objective ............................................................................................................................................................................... 11
Overview .............................................................................................................................................................................. 11
Assess Your Implementation Role ............................................................................................................................. 11
Prepare Application Server and Install IdentityIQ War File ........................................................................... 12
Configure Extended Searchable Attributes ............................................................................................................ 13
Configure the Database .................................................................................................................................................. 15
Initialize IdentityIQ and Verify your Installation ................................................................................................ 17
Exercise #2: Patching IdentityIQ..................................................................................................................................... 19
Objective ............................................................................................................................................................................... 19
Overview .............................................................................................................................................................................. 19
Patch Installation .............................................................................................................................................................. 19
Exercise #3: Configuring IdentityIQ .............................................................................................................................. 21
Objective ............................................................................................................................................................................... 21
Overview .............................................................................................................................................................................. 21
Configure the Email Redirector .................................................................................................................................. 22
Configure IdentityIQ Object Expiration ................................................................................................................... 22
Configure IdentityIQ Auditing ..................................................................................................................................... 24
Configure IdentityIQ Logging ...................................................................................................................................... 26
Exercise #4: Populating Identity Cubes – Loading Authoritative Data ........................................................... 27
Objective ............................................................................................................................................................................... 27
Overview .............................................................................................................................................................................. 27
Define Employee Application ...................................................................................................................................... 29
Aggregate the Employee Data ..................................................................................................................................... 32
Define Contractor Application and Load Contractor Data............................................................................... 34
Confirm that the aggregations were successful ................................................................................................... 36
Understanding What We Just Did .............................................................................................................................. 37
Objective ............................................................................................................................................................................... 86
Overview .............................................................................................................................................................................. 86
Start the local LDAP Server .......................................................................................................................................... 86
Loading the LDAP Application .................................................................................................................................... 87
Refresh Identities ............................................................................................................................................................. 89
Exercise #9: Exploring the Identity Refresh Task.................................................................................................... 90
Investigate the Default Refresh Identity Cube Task ........................................................................................... 90
Constrain the Refresh Identity Task ......................................................................................................................... 91
Course Overview
Introduction
The exercises contained in this document are meant to accompany the Fundamentals of IdentityIQ
Implementation training lecture materials.
These exercises are run within a Virtual Machine environment, which contains the following
software:
During these Implementer Training exercises, we will be installing and configuring the following:
Shortcuts/Applications Provided
The Virtual Machine environment includes several useful shortcuts.
Shortcuts
Clear
Desktop
gedit – A common Linux text editor Launcher to start the IdentityIQ Console
o To change the keyboard input to your native keyboard, navigate to System >
Preferences > Keyboard > Layouts and click Add. Use the dropdowns to select
your keyboard and variant. Once you have selected your keyboard, click Add in the
bottom right corner.
• Install IdentityIQ
• Patch IdentityIQ
o Enable Logging
o Employees
o Contractors
• Onboard additional account and group data from additional non-authoritative (systems of
interest) application sources
o Flat File (CSV) data feeds containing user accounts and group data
o Logical Application
o Multiplexed Application
The diagram on the following page provides a visual representation of the systems which will be
onboarded in this section and utilized throughout this course. The numbers correspond to the
Application onboarding exercises.
Overview
Our training scenario represents a typical implementation cycle with a customer. The client has
provided us with the following:
• A running database server with host, port and login information provided
• Adjust the IdentityIQ Hibernate files to support our installation. Our installation needs to
support the following:
• Generate the IdentityIQ database schema files and use these to create the IdentityIQ
database within the MySQL database instance
• Initialize IdentityIQ
If No:
• Use the scripts provided in this virtual machine to complete the installation. See
Appendix, Scripted IdentityIQ Installation for instructions.
If Yes:
• Continue to next step: Prepare Application Server and Install IdentityIQ War File.
b. Alternatively, you can open a Linux terminal window and type the following
command:
StopTomcat
Note: If this is the first time this VM has been used, Tomcat should already be stopped.
cd InstallImages
Note: For help navigating in Linux, see Basic Linux Commands, Appendix-1.
b. Confirm that the IdentityIQ zip file is in the directory. Enter the following command
to view the contents of the directory.
ls
unzip identityiq-7.2.zip
d. Within the InstallImages directory, locate the identityiq.war file and copy it to the
installation directory for IdentityIQ:
/home/spadmin/tomcat/webapps/identityiq
Copy Options:
Option 1: Use the file browser to copy and paste the file.
Option 2: Use the Linux copy command. At the $ command prompt, enter:
cp identityiq.war /home/spadmin/tomcat/webapps/identityiq
In a standard implementation, the implementation team is responsible for adding the extended
attributes to the Hibernate XML file. In our training environment, the Hibernate XML file has
already been configured with these two named extended attributes.
In this exercise, you will replace the default Hibernate XML file with the pre-configured
Hibernate XML file, and you will review the configuration to ensure it meets requirements.
Copy Options:
Option 1:
Use the file browser to copy and paste the file. When prompted, click Replace.
Option 2:
Use the Linux copy command. At the $ command prompt, specify the file name
and directory listed above in the following command:
d. In the object directory, open the IdentityExtended.hbm.xml file using any editor;
gedit is provided in the VM and is a good editor for viewing and editing XML files.
About gedit: If red highlights are displayed, there is a syntax error in the XML. This
may be a sign that you’ve accidentally changed the file.
e. Find the entries for the named extended attributes, empId and status. Complete the
missing components of the definitions below.
f. This exercise confirms that the empId and status extended attributes will be created in
the database, with indexes. Later in this training course, after IdentityIQ is installed, you
will create these extended attributes within IdentityIQ. Until they are created within
IdentityIQ, you will see errors that they are not defined in the Identity object
configuration.
2. Project requirements also tell us that we will need additional searchable and indexed extended
identity attributes, but we don’t yet know which ones. For these, we will use the 10 default
placeholder attributes, but we want all 10 to be indexed, rather than the default of 5 indexed.
a. Confirm that the Hibernate XML file is configured to support 10 searchable and indexed
placeholder attributes per identity. Complete the missing components of the definitions
below:
________________________________ />
<property name="extended7" type="string" length="450"
index="spt_identity_extended7_ci"/>
<property name="extended8" type="string" length="450"
index="spt_identity_extended8_ci"/>
<property name="extended9" type="string" length="450"
index="spt_identity_extended9_ci"/>
<property name="extended10" type="string" length="450"
index="spt_identity_ _ci"/>
___________
b. How many identity extended attribute placeholders are configured by default? (Hint:
check the in-line documentation at the top of the file)
_____________________________________________________________________________________________________
_____________________________________________________________________________________________________
d. How many extended attribute placeholders are configured with a database index by
default?
_____________________________________________________________________________________________________
e. How many extended attribute placeholders in this Hibernate file are configured to have
a database index?
_____________________________________________________________________________________________________
chmod +x iiq
a. Run the following command from the Linux terminal to generate the database
schema files:
./iiq schema
3. Load the MySQL Schema file into MySQL to create the IdentityIQ database
mysql –u root –p
Enter password: root
b. Within the MySQL command line utility, type the following to load the schema into
MySQL:
c. When the command finishes running, type the following to confirm that the
identityiq database has been created properly. The other databases are not
important. Make sure that identityiq is in the list of databases.
+--------------------+
| Database |
+--------------------+
| information_schema |
| identityiq |
| identityiqPlugin |
| mysql |
| performance_schema |
| trakk |
| prism |
+--------------------+
7 rows in set (0.00 sec)
4. Analyze the Database Settings that IdentityIQ will use to connect to the database. You will
not edit this file for the training environment. The default values will work in our
environment with no modifications.
a. Navigate to and open the configuration file for the IdentityIQ database:
/home/spadmin/tomcat/webapps/identityiq/WEB-INF/classes/
iiq.properties
b. The table below lists the most commonly edited values. View the iiq.properties file
and fill in the blanks in the table for the three missing default values.
Note: For best performance, it is VERY important to update the default JDBC driver supplied
with IdentityIQ to the most current driver supplied by your database vendor.
./iiq console
Note: In the training environment, the console can also be run from the desktop
shortcut.
c. Upon console start-up, you will see two error messages. What is causing the error
messages? Hint: See page 1-13, number 1f.
_________________________________________________________________________________________________
d. At the console command prompt, load the default IdentityIQ objects using the
following command:
2. Start the Tomcat Application Server and wait 30 to 60 seconds while the application server
starts.
StartTomcat
To monitor the start process in the log file, use the desktop shortcut, Tail Tomcat Standard
Out. The server has started when you see the phrase: INFO: Server startup in xxxxx ms.
Note: there are Bookmarks provided within the Firefox Browser for the IdentityIQ
login page and others that we will use throughout this course.
c. If you can successfully log in and see the IdentityIQ application, then your
installation was successful. If not, let your instructor know.
Overview
The patch process involves three major steps. Note that each patch install may not require all three
steps. Always read the release notes for any patch in their entirety before patching a system.
• Deploy new product code (deploy the patch jar file in our install directory)
• Upgrade the database tables to support any changes required by the patch
o New Tables
o Deprecated Tables
• Run the patch script to convert any data as required by the new patch
Patch Installation
1. Stop the Tomcat Application Server.
Option 1: From the desktop, run the shortcut labeled “Stop Tomcat” or
a. Use the File Browser to locate the identityiq-7.2pX.jar (where 'x' represent the
patch version) file under /home/spadmin/InstallImages and copy it to the
installation directory for IdentityIQ:
/home/spadmin/tomcat/webapps/identityiq
b. Within the MySQL command line utility, type the following to upgrade the IdentityIQ
schema:
c. Wait for the patch command to finish and watch for any errors. You should see two
errors regarding the extended attributes Employee ID and Status; we have not yet
completed defining these attributes to IdentityIQ. If you also see a Pool not open
error, ignore it.
d. Run the IdentityIQ Console either through the provided desktop shortcut or through
a Linux terminal.
e. Run the following command and confirm that the version and patch are 7.1p1.
>about
4. Start the Tomcat Application Server and wait while the application server starts.
Overview
In order to support our client’s needs, we will be turning on some
troubleshooting/debugging/auditing features of IdentityIQ to support our development efforts:
• Configure the Email Redirector to send all system-generated emails to a local file instead of
an SMTP Mail Server. This file is useful for debugging email notifications without sending
real emails to users.
• Configure Auditing to log certain audit events into the Audit Table.
2. Within IdentityIQ, from the system setup gear, , select Global Settings and select
IdentityIQ Configuration. Configure the following two options under Email Settings.
Notes:
• This is the location in the UI where you can also configure the default Email
Templates used for many notification types within the IdentityIQ application.
• When you are ready to connect IdentityIQ to an SMTP mail server to send out real
email notifications, change this configuration page to point to an SMTP mail server.
2. In the General Actions tab, configure the following four options by checking the box next to
each:
_________________________________________________________________________________________________________
_________________________________________________________________________________________________________
_________________________________________________________________________________________________________
_________________________________________________________________________________________________________
Note: You can turn on auditing for actions in the system, but can also turn on auditing for
any changes to identity attributes or even the create/update/deletion of system objects.
Also, it is possible to use the SailPoint API to audit additional items of your own choosing
during rules or workflow steps.
a. Log out of IdentityIQ and attempt to log in using an incorrect username and
password: example: foo/foo
c. Navigate to Intelligence Advanced Analytics and from Search Type drop down,
select Audit
d. Don’t adjust any parameters for the search; just choose Run Search from the
bottom left
e. Confirm that you see entries showing the login failure and the successful login:
7. While here, notice that Advanced Analytics provides detailed searching across IdentityIQ.
i. How many Standard Attributes are there for searching identities? ________
iii. You increased the number of indexed searchable attributes defined in the
IdentityIQ database. However, no searchable attributes have been defined to
IdentityIQ. You will define attributes as searchable in upcoming exercises.
Note: This will overwrite the default log4j.properties file with options added for the class
environment.
2. This sample log configuration file will send all IdentityIQ logging output to the file:
/home/spadmin/logs/iiq_training_rolling.log
3. Finish the configuration process by restarting the Tomcat application server to reload the
log4j.properties file. Restart the application server from a terminal window (type the
commands listed below) or use the shortcuts on the desktop.
StopTomcat
StartTomcat
Note: You can view the success of both commands in the Tomcat Standard Out log.
4. Launch the desktop shortcut named: Tail IdentityIQ Log and leave this window running.
This window will show any log messages generated by IdentityIQ as we work through the
lab exercises.
5. You can edit the log4j.properties file to change the logging levels used by IdentityIQ. We
will periodically adjust this file as we work through the exercises.