CA - ITPAM - Quick Start Guide
CA - ITPAM - Quick Start Guide
INSTALL BASIC STANDALONE COMPONENTS CREATE SIMPLE HELLO WORLD PROCESS THIS IS A DRAFT DOCUMENT FEEDBACK IS WELCOME
LEGAL NOTICE
This publication is based on current information and resource allocations as of its date of publication and is subject to change or withdrawal by CA at any time without notice. The information in this publication could include typographical errors or technical inaccuracies. CA may make modifications to any CA product, software program, method or procedure described in this publication at any time without notice. Any reference in this publication to non-CA products and non-CA websites are provided for convenience only and shall not serve as CAs endorsement of such products or websites. Your use of such products, websites, and any information regarding such products or any materials provided with such products or at such websites shall be at your own risk. Notwithstanding anything in this publication to the contrary, this publication shall not (i) constitute product documentation or specifications under any existing or future written license agreement or services agreement relating to any CA software product, or be subject to any warranty set forth in any such written agreement; (ii) serve to affect the rights and/or obligations of CA or its licensees under any existing or future written license agreement or services agreement relating to any CA software product; or (iii) serve to amend any product documentation or specifications for any CA software product. The development, release and timing of any features or functionality described in this publication remain at CAs sole discretion. The information in this publication is based upon CAs experiences with the referenced software products in a variety of development and customer environments. Past performance of the software products in such development and customer environments is not indicative of the future performance of such software products in identical, similar or different environments. CA does not warrant that the software products will operate as specifically set forth in this publication. CA will support only the referenced products in accordance with (i) the documentation and specifications provided with the referenced product, and (ii) CAs then-current maintenance and support policy for the referenced product. Certain information in this publication may outline CAs general product direction. All information in this publication is for your informational purposes only and may not be incorporated into any contract. CA assumes no responsibility for the accuracy or completeness of the information. To the extent permitted by applicable law, CA provides this document AS IS without warranty of any kind, including, without limitation, any implied warranties of merchantability, fitness for a particular purpose, or noninfringement. In no event will CA be liable for any loss or damage, direct or indirect, from the use of this document, including, without limitation, lost profits, lost investment, business interruption, goodwill or lost data, even if CA is expressly advised of the possibility of such damages.
TITLE AND PUBLICATION DATE: CA IT PAM Best Practices: Quick Start Guide April 2010
Publication Date: April 2010
ACKNOWLEDGEMENTS
Principal Authors and Technical Editors George Curran Anders Magnusson Terry Pisauro
CA PRODUCT REFERENCES
This document references the following CA products:
CA IT Process Automation Manager (CA IT PAM) CA Embedded Entitlements Manager (CA EEM)
FEEDBACK
This is a draft document feedback is welcome! Please email us at [email protected] to share your feedback on this publication. Please include the title of this publication in the subject of your email response. For technical assistance with a CA product, please contact CA Technical Support at http://ca.com/support. For assistance with support specific to Japanese operating systems, please contact CA at http://www.casupport.jp.
Contents
CA IT Process Automation Manager Quick Start Guide 7
Overview ...................................................................................................................... 7 Before You Begin ........................................................................................................... 7 Step 1: Install and Configure CA Embedded Entitlements Manager ....................................... 8 Install EEM ................................................................................................................. 8 Create IT PAM Security Objects .................................................................................... 8 Set ITPAMAdmin and ITPAMUser Passwords ................................................................... 9 Step 2: Install CA IT Process Automation Manager Prerequisites ........................................ 10 JBoss Installation ...................................................................................................... 10 Hibernate Installation ................................................................................................ 10 JDBC Installation ...................................................................................................... 11 Step 3: Install CA IT Process Automation Manager Domain ............................................... 11 Configuration Screen ................................................................................................. 12 Select Start Menu Folder ............................................................................................ 12 General Properties .................................................................................................... 12 EEM Security Settings................................................................................................ 12 Database Settings ..................................................................................................... 13 Additional JARs Installation ........................................................................................ 13 Choose Connectors ................................................................................................... 13 Step 4: Launch the CA IT Process Automation Manager Console ........................................ 13 Step 5: Install the CA IT Process Automation Manager Agent ............................................ 14 Step 6: Access CA IT Process Automation Manager Client ................................................. 15 Authentication Failure ................................................................................................ 15 Step 7: Define Hello World Process .............................................................................. 16 Lock the Default Environment ..................................................................................... 16 Add Touchpoint to the Default Environment.................................................................. 17 Add a New Orchestrator Folder Hello World................................................................ 17 Add New Process Hello World ................................................................................... 17 Add Actions to Process Hello World ........................................................................... 18 Add Stop Operator .................................................................................................. 19 Connect Operators .................................................................................................... 19 Step 8: Test Hello World Sample Process...................................................................... 20 Summary .................................................................................................................... 21
installing CA IT PAM accessing the user interface testing CA IT PAM by creating and running a very basic Hello World process
These procedures require a suitable target environment for the installation that already includes the following:
Real or virtual system running Microsoft Windows Server 2003 with current maintenance applied Microsoft SQL Server 2005 (any edition), with mixed mode security enabled and current maintenance applied, installed locally or on an accessible remote host Most recent build of the Java 1.6 JDK (be sure to run the installation procedure that will perform the integration with the browser as opposed to simply copying the content of Java to the target system)
Procedures for installing the operating system, database server, and Java and for verifying connectivity are not covered in this document. You will also need to obtain the installation media for CA IT PAM (downloadable from http://support.ca.com) and make it available to access from the target system.
Install EEM
The installation package for EEM is located under the \EEM subdirectory on CD 2 of the CA IT PAM installation media. To launch the installation application for Windows execute the following command: EEMServer_8.4.100.0_win32.exe Provide the following when prompted:
Provide a password for the EiamAdmin user ID when prompted. Note: Be sure to note this password as you will need to supply it later in the installation directory.
Browse to the Java installation that will be used. This is the directory that contains the \bin sub-directory for Java JDK 1.6 (see Before You Begin)).
The default security certificate password is itpamcertpass. To change this password edit the password attribute value in the following element in that document:
<Register certfile=itpamcert.p12 password=itpamcertpass/>
2. 3.
Open a command shell console window and navigate to the \iTechnology sub-directory and confirm that the safex.exe file exists. Execute the following command to create the IT PAM certificate file, EEM security groups and users:
safex.exe h <hostname> -u EiamAdmin p <Password> -f ITPAM_eem.xml
l This command also creates the itpamcert.p12 file in the \iTechnology sub-directory and populates the required security objects for CA IT PAM in EEM. For security reasons, you should remove the CA IT PAM configuration XML file (ITPAM_eem.xml). TIP: Should you encounter a problem the ITPAM objects created can easily be removed by copying the UnRegisterITPAM.xml (also located in the \EEM sub-directory on CD 2 of the CA IT PAM installation media) to the \iTechnology sub-directory then running the command: safex.exe h <hostname> -u EiamAdmin p <Password> -f UnRegisterITPAM.xml
The default passwords for the ITPAMAdmin and ITPAMUser user IDs are specified in the IT PAM XML configuration file for EEM (see Create CA IT PAM Security Objects); however, the actual values are intentionally encrypted. Since these passwords will be needed later, you need to reset them using the EEM user interface by doing the following: 1. 2. 3. Use the EEM UI shortcut created by the EEM installation (All Programs -> CA -> Embedded Entitlements Manager -> EEM UI) to launch the application When the EEM login screen is displayed, choose ITPAM from the Application drop down list. Specify EiamAdmin in the user text box.
Provide the EiamAdmin password that was set when EEM was install (see 4. 5. 6. Install EEM) After successful login choose the Manage Identities tab Specify itpam in the Value text box on the Search User dialog and click Go. Two users (itpamadmin and itpamuser) should be displayed under the \Users folder in the Users tile.
7. 8.
Click on either user ID and scroll down in the Global User Details panel in the right hand pane to the Authentication tile. Select the Reset Password action from the Authentication tile Two text boxes, New Password and Confirm Password should be displayed
9.
10. Click the Save button on the bottom or top of the right hand pane 11. Repeat the process for the other user ID The passwords for the itpamadmin and itpamuser should now be reset to known values. Log out and exit the EEM administrative UI.
To install the required third party components, execute the following command from CD 1 of the CA IT PAM source media: Third_Party_Installer_windows.exe When the Setup 3rd Installer starts, do the following: 1. 2. 3. 4. Click Next on the Welcome screen. Select I accept the agreement on the License Agreement screen and click Next. On the Select Destination Directory panel it is recommended that you edit the default entry C:\Program Files\ITPAM to read C:Program Files\CA\ITPAM Click Next when the Prerequisites for ITPAM installation screen appears and follow the procedures provided in the next sections.
JBoss Installation
The JBoss Installation should display the path to the installation source ZIP file. By default this is: D:\ITPAM\CD1\JBoss\jboss-4.0.3SP1.zip If this is not correct, browse to select the correct path and click Next when you are done. Click Next to proceed do NOT enable Use Domain option. The required JBoss components will now be unpacked and installed to the \ITPAM directory. When completed, the Hibernate Installation screen will be displayed.
Hibernate Installation
Do the following for the Hibernate Installation screen:
1.
If the default entry displayed is incorrect, browse to locate the correct source file. By default this is:
D:\ITPAM\CD1\hibernate\hibernate-3.0.jar
The required Hibernate fillies will be unpacked and installed. When this is completed the JDBC Jars Installation screen will be displayed.
JDBC Installation
Do the following on the JDBC Jars Installation screen: 1. 2. 3. Click Add Files Select MS SQL 2005 from the drop-down list If the default source location displayed for the JDBC JAR file is incorrect, browse to the correct location. By default this is:
D:\ITPAM\CD1\drivers\sqljdbc.jar
4.
Click Next
The required file(s) will be copied to the proper location. The Tapi Jars Installation screen will display next. However, since installation and configuration of telephony services is not required for this example and is beyond the scope of this document, click Next to continue. Installation of third party prerequisites is now complete. Click Next on the Prerequisites for IT PAM installation panel to continue to the CA IT PAM Domain installation.
Execute CA_ITPAM_Domain_windows.exe from the root of CA IT PAM installation media CD 2. As a continuation of the third party installation process (see Step 2: Install CA IT Process Automation Manager Prerequisites). After verifying the path to CD 2 on the Completing the 3rd Party Installer Setup Wizard screen that appears at the end, click Finish to proceed.
Once the Installation Wizard is launched, do the following: 1. 2. 3. Click Next to proceed from the Welcome screen. On the License Agreement screen select the I accept the agreement and click Next. When prompted, browse to locate the root directory of the installed Java JDK (see Before You Begin). This is the directory that contains the \bin sub-directory. Click Next to proceed.
11
The installer will begin copying files to the target system. Follow the procedures provided in the next sections to continue.
Configuration Screen
When the Configuration Screen screen is displayed do the following:
Accept the default values and click Next. Do NOT enable the Configure Load Balancer option. On the Set Certificate Password screen enter and confirm the password (default itpamcertpass) set when the EEM certificate file was created (see Create CA IT PAM Security Objects) then click Next
General Properties
Accept the defaults on the General Properties screen unless this will cause a port conflict with other installed applications and enable the Install as Windows Service option. Tip! For future reference you should do a screen capture of this dialog. Click Next to proceed to the EEM Security Settings dialog.
5. 6. 7. 8.
Enter the EEM Certificate Password (default itpamcertpass) specified when the IT PAM certificate file was generated (see Create CA IT PAM Security Objects) Click Test EEM Settings to verify the entries are correct. Click OK in response to the Performing a testmay take a few minutes message When Verify EEM settings login dialog appears enter user name itpamadmin and the password set previously for the itpamadmin user in EEM (see Set ITPAMAdmin and ITPAMUser Passwords)
Assuming all the correct values were entered a dialog indicating Connect was Ok, User provided belongs to user group was Ok and User is an admin is Yes should appear. If necessary correct the entries and re-test.
Database Settings
The Database Settings screen will appear. Do the following: 1. 2. 3. 4. 5. 6. 7. Select MS SQL 2005 from the Type of Database drop-down list Provide a database user ID with sufficient privileges to create a database, logins and grant privileges (sa is recommended) in the User Name text box Provide the password for this user in the Password text box Update the Database Server, Database Port and Driver Jar entries if necessary Click the Create Database button to create the itpam database and test connectivity by clicking the Test Database Settings button When successful click Next Check the copy from main repository check box on the Reporting Database Setting dialog and verify connectivity by clicking the Test Database Settings button. Do NOT click the Create Database button. When successful click Next
8.
Choose Connectors
The Choose connectors that need to be installed/updated dialog lists a number of connectors for various CA products. For the purposes of this exercise, none of these connectors is required. Therefore, click Next to proceed. The CA IT PAM installation process will now copy files and configure the application. When this process completes, the Completing the IT PAM Domain Setup Wizard dialog will display. Click Finish to exit the wizard.
On the server, select the shortcut created by the installation process. If the recommendations provided in the Step 3: Install CA IT Process Automation Manager Domain section were followed, this is All Programs -> CA -> ITPAM Domain -> Start ITPAM Client. On the server, or from a remote system, launch the following URL:
http://<server>:<port, default 8080>/itpam/
13
Note that Java JRE or JDK 1.6 must be properly installed and integrated with the browser on the remote system. Login to the application using the itpamadmin user ID and corresponding password (see Set ITPAMAdmin and ITPAMUser Passwords). After successful login the CA IT Process Automation Manager will open. Note: Depending on browser type, version and configuration an attempt to launch the management console may result in only a blank page. Typically, this is because the URL is not included in the current list of trusted sites for the browser. To resolve this issue, simply add the URL to the list of trusted sites for the browser.
4. 5. 6.
7.
8. 9.
10. Optionally, edit the Display Name value on the General Properties screen and verify the Agent Port value. By default this is 7003 (see Step 3: Install CA IT Process Automation Manager Domain). 11. Select both the Install as Windows Service and Start Agent After Installation options and click Next The installation wizard will begin extracting and installing the required agent files to the target system. When the Completing the ITPAM Agent Setup screen displays, click Finish.
On the server, use the shortcut created by the installation process. If the recommendations in the section Step 3: Install CA IT Process Automation Manager Domain were followed this should be All Programs -> CA -> ITPAM Domain -> Start ITPAM Client Optionally, from the server or from a remote system, launch the following URL:
http://<server>:<port, default 8080>/itpam/
Note that Java JRE or JDK 1.6 must be properly installed and integrated with the browser on the remote system to use this option. Login to the application using the itpamadmin user ID and corresponding password (see Set ITPAMAdmin and ITPAMUser Passwords). Upon successful login the CA IT Process Automation Manager will open. To launch the ITPAM client click the ITPAM Client link in the upper right hand corner.
Authentication Failure
The CA IT PAM client is a Java Web Start application based on the Java Network Launching Protocol (JNLP). Certain proxy configuration settings or auto-configuration scripts may interfere with the download and launch process. The most typical symptom of this is a Failed to Authenticate error message. To work around this issue, do the following:
Disable any proxy auto-configuration scripts in the browser settings, if defined If a proxy server is defined or can be defined, add an exclusion for the CA IT PAM server
Alternatively, if browser proxy reconfiguration is problematic, change the browser configuration settings for Java itself. To do this: 1. 2. Open the Windows Control Panel dialog Launch the Java applet The Java Control Panel appears. 3. 4. 5. Click the Network Settings button on the General tab Enable the Direct Connection option on the Network Settings dialog Click OK on both dialogs
If the client fails to open after implementing one of the above workarounds contact CA support for additional information.
15
CA Embedded Entitlements Manager (EEM) was correctly installed and required security objects were created and configured (see
Step 1: Install and Configure CA Embedded Entitlements Manager) CA IT Process Automation Manager prerequisites were installed correctly (see Step 2: Install CA IT Process Automation Manager Prerequisites) CA IT Process Automation Manager domain installation was completed (see Step 3: Install CA IT Process Automation Manager Domain) CA IT Process Automation Manager management console was accessible and a CA IT Process Automation Agent was successfully installed (see Step 5: Install the CA IT Process Automation Manager Agent) CA IT Process Automation Manager client UI has been launched (see Step 6: Access CA IT Process Automation Manager Client)
The task of defining the Hello World process consists of the following steps: 1. 2. 3. 4. 5. 6. 7. 8. Lock the Default Environment Add the Hello World Touchpoint to the Default Environment and unlock it Add the Hello World Orchestrator Folder Add the new process Add actions to the process Add Normal Stop operators to the process Connect Operators Test the process
17
Add Start Operator To add a Start operator select the Start operator icon from the Common panel and drag it to the right-hand panel. A Start operator icon should now appear in the right-hand panel. Add Watch File Operator To add a Watch File operator, do the following: 1. 2. Right-click on the right-hand process definition panel and select File Watch Module from the in-context menu that appears. Select Watch File from the in-context sub-menu. A Watch File operator icon should now appear in the right-hand panel. 3. Right-click on the new Watch File operator then select the item Properties from the in-context menu that appears. A Properties of Watch_File_1 panel appears to the far right. 4. 5. 6. 7. Click on the Information bar Change the entry in the Name text box from Watch_File_1 to Watch_File_Hello Click the File Watch bar. For the purpose of example enter C:\\Hello as path and name of the file to watch for in the File/directory name test box Note: The entry must be encapsulated in double quotes and the double backslashes are required. 8. 9. Enter 30 in the Expiration timer (secs) text box to specific that the process should wait 30 seconds for the file to appear Verify the Condition value is set to Presence
10. Click the Execution Settings bar 11. Locate the Touchpoint text box and click the Select button 12. Expand the tree in the Object Browser dialog that appears and select the previously defined example Touchpoint (Hello World App Server, see Add Touchpoint to the Default Environment) node 13. Click OK The Touchpoint text box should display Hello World App Server.
14. Click Apply at the bottom of the panel to save the changes. Add Script Operator Next, to add the Script operator do the following: 1. 2. Right-click on the right-hand process definition panel Select Process Module from the in-context menu that appears then select Start Script from the in-context sub-menu. A Start Script operator icon should now appear in the right-hand panel. 3. Right-click on the new Start Script operator then select the item Properties from the in-context menu that appears. A Properties of Start_Script_1 panel appears to the far right. 4. 5. 6. 7. 8. Click on the Information bar Change the entry in the Name text box from Start_Script_1 to Start_Script_Hello Click the Script bar Click on the button below the label Inline Script Enter the command below in the text area of the Inline Script dialog that appears: echo Hello World > C:\Hello.txt 9. Click the OK button on the Inline Script dialog
10. Finally, click the Execution Settings bar 11. Locate the Touchpoint text box and click Select 12. Expand the tree in the Object Browser dialog that appears and select the previously defined example Touchpoint (Hello World App Server, see Add Touchpoint to the Default Environment) node 13. Click OK The Touchpoint text box should display Hello World App Server. 14. Click the Apply button at the bottom of the panel to save the changes.
Connect Operators
At this point all the operators required for the Hello World example process should have been added to the process definition panel and the necessary properties should have been set (see Add Actions to Process Hello World). The next step is to define a process flow by connecting the operators. To do this: 15. Locate the small black triangle at the bottom of the Start operator. Click on it and drag it to the Watch_File_Hello operator.
19
16. Right-click on the Watch_File_Hello operator and select Completed from the incontext menu that appears 17. Click on and drag the green check mark that appears below the Watch_File_Hello operator and drag it to the Start_Script_Hello operator 18. Right-click on the Watch_File_Hello operator once again and select Timeout from the in-context menu that appears 19. Click on and drag the hourglass icon that appears below the Watch_File_Hello operator to the Abnormal Stop operator 20. Right-click on the Start_Script_Hello operator and select Completed from the incontext menu that appears 21. Click on and drag the green check mark that appears below the Start_Script_Hello operator to the Normal Stop operator 22. Right-click on the Start_Script_Hello operator and select Failed from the in-context menu that appears 23. Click on and drag the red X that appears below the Start_Script_Hello operator to the Abnormal Stop operator The Hello World sample process is now complete. Save the process by selecting File, Save from the menu.
To test the process, do the following: 1. Open a Windows explorer folder and navigate to the root of the C: drive
2. 3.
In the IT PAM Client UI click the run icon (a green circle with a white arrow) on the toolbar in Hello World process definition panel When prompted to Monitor New Process click Yes A process monitoring panel should appear and stop at the Watch_File_Hello operator.
4.
Within 30 seconds create a file in the root of the C: drive named Hello The Watch_File_Hello operator should detect the existence of the file and the process should move to the Start_Script_Hello operator The Start_Script_Hello should write the text Hello World to a file named Hello.txt in the root of the C: drive
The process should move to the Normal Stop operator and terminate. The process diagram in the process monitor panel should appear similar to the following:
Notice that the File_Watch_Hello, Start_Script_Hello and Normal Stop operators are all green, indicating successful execution.
Summary
The exercises outlined in the document were obviously not intended to make the reader a CA IT Process Automation Manager expert or implement a production-ready instance of the application. Hopefully, the experience helped familiarize you with the CA IT PAM installation, configuration and tools. You can also use this CA IT PAM instance for further self-paced learning, reference and testing of more complex use cases.
21