=========================================================================
    IBM Security Access Manager for Enterprise Single Sign-On (ISAMESSO)
                 Cached Wallet Maintenance Script
 =========================================================================
 
	Release date 		: 8 JUL 2015
	Script version 		: 1.0.4
	Target IMS version 	: 8.2.x
	Target Database		: Ms SQL Server 2008/2012

	The cached wallet maintenance script removes expired/duplicated cached 
	wallets	based on the creation host name with the condition that it must be
    greater than 30 days from the creation time.
	
	In order to improve the efficiency of the maintenance script, 'SIMULATE' and 
	'DELETE' modes are designed to work with random sets of users when <max users> 
	is greater than 0. This leads to possibilities of different execution results that 
	shares the same parameter value of <max users>.


 1. Creating the stored procedure

	Create this stored procedure in the ISAMESSO schema.
	
	Make sure the database login account that you use in the following tasks has: 
	 * Current schema set to ISAMESSO schema. 
         * Privileges to 
	   - create,drop,execute on stored procedure
	   - select,insert,delete,update on ISAMESSO database tables.


	1.1 Using Microsoft SQL Server Management Studio
	-------------------------------------------------

	1.1.1 Open the script "sp_pruneCachedWallet"
	      In the Microsoft SQL Server Management Studio, Select "File > Open". 
	      Browse to the script "sp_pruneCachedWallet" and open it. 

	1.1.2 Replace <TARGET DATABASE NAME>, <ISAMESSO SCHEMA OWNER> and Insert the 
	      following command at the first line in "sp_pruneCachedWallet.sql"
		  ----------------------------
		  USE <TARGET DATABASE NAME>
		  GO
		  EXECUTE AS USER = '<ISAMESSO SCHEMA OWNER>';
		  GO
		  ----------------------------
	1.1.3 Execute the script and make sure "Command(s) completed successfully." is displayed.
		
		  
 2. Verifying the creation of a stored procedure
	
	Once the stored procedure is created successfully, execute the following 
	command to verify the script creation:
	
	exec sp_pruneCachedWallet 'ABOUT','',0 
	
	You must get the similar output as the following if the script is created successfully.
	------------------------------------------------------
	-  ISAMESSO Cached Wallet Maintenance Script 		 -
	-   - Database Name    : IMS_DB						 -
	-   - Schema Name      : IMS_SCHEMA					 -	
	-	- Script version   : 1.0.0						 -
    -	- Database version : Microsoft SQL Server 2008 	 -
	------------------------------------------------------
	
	
 3. Using the maintenance script

	  * The database account that is used has the following privileges:
	      - Select, insert, delete, update data in the ISAMESSO schema
	      - Execute stored procedure 
	 
	Maintenance Script Syntax: 
	
	exec sp_pruneCachedWallet '<del mode>', '<retain date>', <max users> 
	
	where:
	
    	<del mode> - Mandatory, text, case sensitive. Replace <del mode> with one of the
    	 		     following values:
			'ABOUT'      Displays script information
			'DELETE'     Performs actual delete 
			'HELP'       Displays script syntax and example
			'SIMULATE'   Simulates deletion without actual delete
			  
		<retain date> 	- Optional, text, date in YYYYMMDD format
						- Process only cached wallets created before the specified date
						- Leave blank to process all wallets
			   
		<max users> - Mandatory, numeric, maximum number of IMS users to be processed
					  Replace <max users> with one of the following values:
           			0		Process all the ISAMESSO users.
					X   	Process 'X' number of ISAMESSO users. 		
						

	
 4. Examples

	4.1 Simulate deletion of up to 5K random users' dangling cached wallets without performing 
		actual delete. 
	
		exec sp_pruneCachedWallet 'SIMULATE','',5000 
	
	4.2 Delete up to 10K random users' dangling cached wallets created
	    before 1st Jan 2011.
	
		exec sp_pruneCachedWallet 'DELETE','20110101',10000 
	
	4.3 Simulate deletion of all users' dangling cached wallets without performing actual 
	    delete. 
	
		exec sp_pruneCachedWallet 'SIMULATE','',0 
		
		
 5. OPTIONAL: Advanced Performance Tuning
 
 	Consult with your Administrator before doing the performance tuning task.
 
 	 5.1 Script execution
 	 		
 	 		You can disable or remove the following database triggers 
 	 	so that the maintenance script execution performance in IMS 8.1 is improved.
 	 		
			- IMSIdentityAttributeDelete
			- IMSIdentityUniqueAttributeDelete
			- IMSSociAttributeDelete