SWIFTBUILD USER GUIDE

Prepared by: Last Updated: Document Ref:

Rapid Solutions and Consulting Limited septembre 9, 2010 Installation and User Manual

Copyright 2009, Rapid Solutions and Consulting Limited. All Rights reserved.

TABLE OF CONTENTS
Page
INTRODUCTION.......................................................................................................................................................................3 INSTALLING ON MICROSOFT WINDOWS........................................................................................................................3 USING SWIFTBUILD................................................................................................................................................................8 4 FLD AND HTML LOG FILES.............................................................................................................................................17 5 HTML INJECTIONS PREREQUISITE STEPS:............................................................................................................18 SUBSTITUTION TOKENS IN THE BWE FILE..................................................................................................................21 APPENDIX A: TROUBLESHOOTING.................................................................................................................................22 ORACLE FORMS FROZEN, HANGING.............................................................................................................................24 .....................................................................................................................................................................................................24 ISSUE: ORACLE APPLICATIONS HAS LAUNCHED BUT DOES NOT COMPLETE, I.E. DOES NOT CLOSE ITSELF, IT HANGS................................................................................................................................................................. 24 COMMON CAUSE: DIAGNOSTICS IS NOT ENABLED IN ORACLE APPS. .........................................................24 LOOKING AT THE CURRENT FLD LOG FILE, YOU CAN PINPOINT WHICH FLD COMMAND THAT WAS LAST EXECUTED, IF IT LOOKS LIKE: ............................................................................................................................24 THEN YOU WILL NEED TO ENABLE DIAGNOSTICS IN ORACLE APPS OR EXECUTE THE SCRIPT: SYSADMIN-PROFILE-SITE-SUBSTITUTION-ENABLE.FLD........................................................................................25 APPENDIX B: KNOWN ISSUES............................................................................................................................................26

SWIFTBuild User Guide.doc Confidential

Page 2 of 27

Introduction
SWIFTBuild is a tool to guide you through the steps required to process package you need to apply which previously called Builder Wizard.

Installing on Microsoft Windows

Download the Installer file from RSC download Web site. Run the installer file (example: swiftbuild-1.2.exe) or the unpacked version (ZIP file)

Figure 1: first installation screen

SWIFTBuild User Guide.doc Confidential

Page 3 of 27

1. Specify preferable location to install

Figure 2: Choosing the installation folder

SWIFTBuild User Guide.doc Confidential

Page 4 of 27

2. SWIFTBuild allows you to review the installation summary before continuing

Figure 3: Reviewing Pre-Installation summary

SWIFTBuild User Guide.doc Confidential

Page 5 of 27

3. Click on Install button to run the installation

Figure 4: Installing SWIFTBuild

SWIFTBuild User Guide.doc Confidential

Page 6 of 27

4. A Congratulation screen will appear when the installation is completed. Click Finish to quit

Figure 5: Completed Installation

5. After completing the Installation, a SWIFTBuild shortcut Icon will appear both on your Desktop and in the Program Menu:

and

SWIFTBuild User Guide.doc Confidential

Page 7 of 27

Using SWIFTBuild
This section explains how to use the SWIFTBuild to create a new Oracle Application Instance step by step. Before running injectors, you must have both BWP and BWE file which placed in the same folder. SWIFTBuild Launch

Launch SWIFTBuild by double clicking on its icon located on your Desktop or click on your Quick Lunch to start application or double-click the sb.bat if you installed SwiftBuild manually (note that in this case, you will need to install Java JRE 1.6 prior clicking the BAT file)

swiftbuild.lnk
swiftbui ld.lnk

SWIFTBuild User Guide.doc Confidential

Page 8 of 27

 BWE setup screen This screen will ask you to setup a SWIFTBuild Environment and save it as a file ( .BWE is the files extension) from either local drive or network drive where you place it on. A BWE file contains all information related to the connection to the target server (IP address, port number, FTP setups, etc.) that is necessary prior to running the injectors. SWIFTBuild will not allow you to go further until the information has been validated. If you have been supplied with a BWE / BWP pair of files by your implementation partner, you should be sure to select the correct files and not use the default.

Figure 10.1: BWE Selection Edit, Load and Save buttons are at your available if you wish to modify any fields and load/ save from a file.

SWIFTBuild User Guide.doc Confidential

Page 9 of 27

Environment encryption:
All the parameters below can be saved to a file (with a .bwe extension) that can be encrypted. The benefit is that the file can then be sent to other people for use in SwiftBuild without risking showing confidential information. To use that capability, just click on the checkbox Encrypt BWE file before saving the file:

Environment parameters:
Here is a completed reference of each parameter and what needs to be keyed in: Please replace the highlighted values in RED with you server configuration. Consult your System Administrator for any parameters you are unfamiliar with. Host Name = trcmal11510p1.dbaora1.com It contains the host name to access Oracle forms server.

Connection Method= SFTP or FTP or SSH It contains the protocol chosen necessary for a FTP or SSH connection to be established in order to transfer scripts or launch ADADMIN, ADPATCH. The possible values are: SSH for a secure connection or FTP for an unsecured one. SFTP is SSH but authentication is done via a private key file. Host user name = applerpp It contains the login necessary for a connection to be established in order to transfer scripts or launch ADADMIN, ADPATCH. Host password = Applerpp It contains the password necessary for a connection to be established in order to transfer scripts or launch ADADMIN, ADPATCH. Private key location = D:\swiftsuite-dev\trunk-dev-sb\deploy\privatekey.txt It contains the private key necessary for a SFTP connection to be established in order to transfer scripts. FLD script folder = erpp/scripts It contains the location where the injectors will be transferred to on Oracle Applicationss host. Note that Oracle EBS stores the location in the environment variable: FORMS60_TRACE_PATH. This variable can be edited in the file: /erpp/erppappl/ERPP_hostname.env on Oracle EBS 11.5.10.2. Make sure that the values in this environment variable and FLD script folder and FLD URL are the same; otherwise the injection will stop at the login page (Oracle not able to find the script). FLD Log folder = erpp/scripts It contains the location where the injectors FLD logs are stored on Oracle Applicationss host.

SWIFTBuild User Guide.doc Confidential

Page 10 of 27

FLDURL=http://testserver.com:8000/dev60cgi/f60cgi?record=%s.log%20play=%s It contains the full URL required to launch Oracle Applications playback files. You will need to update it and change the host/port and folder parameter. FLD Form user name = applerpp It contains the user name necessary to connect to Oracle Application forms. FLD Form password= Applerpp It contains the password necessary to connect to Oracle Application forms. Extra properties Extra properties (example: replacement tokens) can be entered via that window.

SWIFTBuild User Guide.doc Confidential

Page 11 of 27

Note that you can save any configuration changes to a file that you have made by clicking to Save Click Next button when you are finished validating the configuration changes.

SWIFTBuild User Guide.doc Confidential

Page 12 of 27

Figure 10.3: BWE Selection

SWIFTBuild User Guide.doc Confidential

Page 13 of 27

BWP selection screen

This screen will ask you to select a SWIFTBuild Package file (.BWP is the files extension) from either local drive or network drive where you place it on. A BWP file contains all the injectors to be applied to an Oracle Application Instance. Examples of injectors are Playback files (FLD used to build an instance), HTML pages to display manual steps to be done, Linux scripts, adadmin, adpatch activities, etc. The SWIFTBuild will not allow you to go further if the selected file is not a BWP file or if the format is not recognized (e.g., corrupted file, etc.). As you can see Figure 9: BWP Selection below, the content of the selected package will be displayed for your information. Click Next button if nothing special is required after selecting the file.

Figure 9: BWP Selection

SWIFTBuild User Guide.doc Confidential

Page 14 of 27

Running the Injectors

Figure 13: Running the Injectors At this screen (above), you can select all or some of the injectors to be run and click the Start button when you are ready to build your instance, apply configuration changes or apply patches. The selected injectors will be run in order and if there is no prerequisite setup in the target instance, the wizard may be paused when running that injector (Pause between each script). Users can also stop the run when appropriate by clicking on Stop button. The log file can be saved and viewed at any time by clicking on Save log button. It is highly recommended to save the log file (button Save log) every time the SWIFTBuild runs in case of errors and to attach it when requesting support from Rapid Solutions and Consulting.

SWIFTBuild User Guide.doc Confidential

Page 15 of 27

On this screen, there are buttons to help you select specific injectors to run. For selecting all of the scripts For toggling the script checked mark between and . For selecting all of the scripts under the first selected script. For selecting all of the scripts above the first selected script. Once an injector is completed, the check box will be unchecked and the next injector in the sequence will be executed until every injector is run.

Figure 14: Injectors running progress Once an injector is completed, the check box will be unchecked for all. After you finish running SWIFTBuild, you recently can access Oracle Application which contains your configurations.

SWIFTBuild User Guide.doc Confidential

Page 16 of 27

4 FLD and HTML Log files

FLD log files are downloaded from the Oracle server to a local folder when clicking theView Current FLD log or get FLD log files button. HTML log files are automatically created to the local folder when running a HTML script. The location of this local folder is a sub-folder of My Documents Windows folder. That sub-folder name is controlled by the property OUTPUT_FOLDER in the
engine.properties file.

So the log files are in the My Documents\swiftbuild-output\ folder for the default value.

SWIFTBuild User Guide.doc Confidential

Page 17 of 27

5 HTML injections prerequisite steps:

Prior to injecting HTML data, you must install and configure Firefox http://www.mozilla.com/en-US/firefox/upgrade.html Note that if you change the default installation path of Firefox, then you must change this property in the engine.properties file:
# path to Firefox executable: FIREFOX_PATH=C:/Program Files/Mozilla Firefox/firefox.exe

Firefox configuration: In order for SwiftBuild to close Firefox browser once the script completes, the following change must be made: - Type: about:config in the URL prompt (1) - Type: dom.allow_scripts_to_close_windows in the Filter prompt (2) - Right-Click on the record and click Toggle to change the value to TRUE (3) - Close Firefox.

SWIFTBuild User Guide.doc Confidential

Page 18 of 27

Also, in Tools->Options: uncheck the box Open new windows in a new tab instead, then click OK

If the following popup occurs when Firefox starts, then check the box: Remember this decision and click on the button Allow

If that popup still reoccur for the next script, then do the following:

Close Firefox Open the file: Page 19 of 27

SWIFTBuild User Guide.doc Confidential

C:\Documents and Settings\<Current-user>\Application Data\Mozilla\Firefox\Profiles\<XXX>.default\prefs.js

Then add 3 following lines user_pref("capability.principal.codebase.p0.granted", "UniversalXPConnect"); user_pref("capability.principal.codebase.p0.id", "file:///C:/Documents and Settings/<current_user_name>/My Documents/swiftbuildoutput/temp/startup.xul"); user_pref("capability.principal.codebase.p0.subjectName", ""); Make sure to replace <current_user_name> by the current Windows user logged in. Make sure to use the / character and not \ in the above path. Save and restart the injection.

SWIFTBuild User Guide.doc Confidential

Page 20 of 27

Substitution tokens in the BWE file

You can use this feature to hide login information (like passwords) in the FLD scripts: If the FLD script contains a line with a word starting and ending with ### then that word will be replaced at injection time by the value of the property keyed in the BWE screen. Example: if the FLD script contains the following login line:
VALUE FNDSCSGN SIGNON PASSWORD 1 ###ORACLE_PWD### Then what you need is to enter the following property in the BWE screen:

SWIFTBuild User Guide.doc Confidential

Page 21 of 27

Appendix A: Troubleshooting
SwiftBuild cannot be started:

Please, reinstall SwiftBuild into a different folder, not Program Files and try again.

Oracle forms not playing back the script, it stops at the Login screen. Please make sure that you followed the steps in the document:
https://sites.google.com/a/erapidsuite.com/documents/Home/manuals/formsplayback But if after that it still does not work, then please check the following: The order of the parameters in the FLD URL, ie "record=" must be used and it must appear before "play=". Furthermore, these two parameters must be separated by "%20" and nothing else. Example: http://server.com:24604/dev60cgi/f60cgi?record=%s.log%20play=%s

Oracle forms Threading bug

SWIFTBuild User Guide.doc Confidential

Page 22 of 27

1) Due to a threading bug in the R11 Forms Applet (see Oracle Metalink Note: 300386.1 and Bug:
4183450), injections into an R11 server should not be performed from a multi-processor PC, as the injection will frequently encounter Oracle Forms errors. When injecting into an R11 server, be sure that the Windows installation in which youre running SwiftBuild has only one available processor something easily confirmed by opening the Windows Task Manager, clicking on the Performance tab, and observing how many CPU graphs are displayed. (There should be only one). R12 injections are not affected by this issue. a) Please note that the above documented bug can and does occur during normal (non-SwiftBuild) use of Oracle Forms on a multi-processor/multi-core machine, but at a much lower frequency. It is due to the speed at which SwiftBuild interacts with the Forms Applet that the frequency of the error increases such that it becomes problematic.

Java Heap size

2) Sometimes Oracle Apps hangs during injecting, mainly because the JAVA heap size is too small. To increase the JAVA heap size, please do the following: Control panel -> Java or Jinitiator (depending which is used by the browser, if in doubt, repeat for all of them) -> Java tab -> View -> in Runtime parameters, put -Xmx256M

SWIFTBuild User Guide.doc Confidential

Page 23 of 27

Oracle Forms Frozen, hanging

f

Issue: Oracle Applications has launched but does not complete, i.e. does not close itself, it hangs. Common cause: Diagnostics is not enabled in Oracle Apps. Looking at the current FLD log file, you can pinpoint which FLD command that was last executed, if it looks like: MENU CUSTOM DIAGNOSTICS EXAMINE

SWIFTBuild User Guide.doc Confidential

Page 24 of 27

USER_EXIT RESPONSE VALIDATE 2 LOC OFFICE_SITE_FLAG "N" USER_EXIT RESPONSE OK 2 LOC OFFICE_SITE_FLAG "N" USER_EXIT RESPONSE DONE OK Then you will need to enable Diagnostics in Oracle Apps or execute the script: SYSADMIN-Profile-SiteSubstitution-Enable.fld

SWIFTBuild User Guide.doc Confidential

Page 25 of 27

Appendix B: Known Issues

1. Sometimes, in some environments, the installation from the Executable file (installshield) fails with the following error: The trust relationship between this workstation and the primary domain failed. (1789)

This is a known bug in the InstallShield installer, we may fix it sometime in the future, for now, and the workarounds are:

to reinstall or to try installing on a different machine or installing SwiftBuild from the ZIP file (just unzip all the files and run the BAT file) or

Exit and rejoin the Windows Active Domain: http://support.microsoft.com/kb/162797

2. Java system tray icons not closed when the script completes. Hovering the mouse over them will force Windows to close them. Also you can disable the checkbox in the Control panel-> Java; so that the icons never show up in the system tray. See below.

SWIFTBuild User Guide.doc Confidential

Page 26 of 27

*********************************** END OF DOCUMENT *****************************************************

SWIFTBuild User Guide.doc Confidential

Page 27 of 27