PL/SQL Developer and TOAD IDE Integration Configuration

Transcription

1 PL/SQL Developer and TOAD IDE Integration Configuration SCM Solutions provides this document as a guideline only and does not guarantee error free usage of either ID integration solutions discussed in this document. Different versions of the Harvest VCI, TOAD, PL/SQL Developer or the VCS Plugin may cause inconsistent results. There are a number of detailed usage instructions that must be followed to ensure a successful implementation. SCM Solutions does not provide support for this integration. If, however, you would like to request assistance with this, or any, Harvest or IDE implementation/integration, please us at support@scmsolutions.ca and we will attempt to provide assistance. The SCM Team. Harvest provides two integrations to 3 rd party Integrated Development Environments (IDEs) The Harvest VCI Plugin and the Eclipse Plugin. The VCI supports any IDE implementing Microsoft s Souce Code Control Specification (SCCS) while the Eclipse Plugin supports development on the Eclipse platform. The SCCS plugin was tested for PL/SQL Developer and TOAD. Both can be used to successfully version source files in Harvest directly in the IDE. As with, the rest of the application, some set up is required to use the plugin in particular the set up of the Harvest project binding file (a file that is checked into and versioned in Harvest ending in the extension hp~ ). The following outlines how VCI works for PLSQL Developer and TOAD. 1.1 PL/SQL Developer Binding File Set Up Before you can use IDE integration with Harvest, you must set up a binding file that is versioned in Harvest and that defines which files are part of the bound project (e.g. can be checked in & out from the IDE). The bound file list does not need to include ALL files in the repository and more than one binding file can be set up in Harvest. For example, different binding files can be set up for each team working in Harvest. In this case, each binding file would contain only the files applicable to that development team. As well, PL/SQL Developer does not come with IDE Integration out of the box. A plugin (VCS Plugin) must also be installed to use IDE integration. Installing it is simply a matter of unpacking the zip file and running setup.exe. A copy is available for download from the PL/SQL Developer website. Once installed, the plugin must be configured to use Harvest as the SCC provider. This is done by going to the PL/SQL Developer s Tools > Plugin Configuration menu, selecting the VCS plugin and setting up the configuration options as shown below:

2 More information on the settings can be found in the documentation for the PL/SQL Developer VCS plugin Creation of a new Binding File 1. Create an empty binding file with extension hp~ for example, Test_SQL.hp~ 2. Check this file into Harvest as a new file. NOTE: There is a bug in the PL/SQL Developer VCS plugin that causes the IDE to crash if the *.hp~ file is installed in the same directory as the source. As such, you must check it into the parent directory of the source files you wish to bind. 3. Log into Harvest and check out all the files you wish to add to the binding file into a local working directory on your hard drive, taking care to include the directory containing the *.hp~ file. Your local working directory should have a structure that looks somewhat like the following: C:\Working_Directory\Bind_File_Name.hp~ Source_Directory\Files and Subdirectories containing files that will be bound 4. Now check out all the files you wish to bind to the IDE for update (into the same working directory as indicated above). 5. Open PL/SQL Developer. 6. Click the VCS > Open Project menu. 7. Ensure the System is set to Harvest. 8. Hit the browse button beside the project. 9. Login using your Harvest ID when prompted. 10. Select your Harvest context: 11. A dialog will pop up. In the dialog: 12. A log window should open indicating the project was successfully bound. 13. Now you can add the files you wish to work with into the hp~ file. Click the VCS > Add File menu.

3 14. A windows dialog will open for you to select files. Select all the files you want to work with in the bound IDE project. Ensure you do not select any *.sig or hscc.log files these are created for use by the VCS plugin. 15. Click OK. The files that you checked out in step 4 should be released and bound for IDE integration. You can validate this in Harvest by seeing that there are no more R tagged files in the package and there should be a new version of the *.hp~ file. If you look at the contents of the *.hp~ file you should also see a listing of the files you added Working in a Bound Project Once the *.hp~ file is set up and your project is bound, you should be able to work with it on a day to day without much effort. This is done as follows: 1. After opening PL/SQL developer, you need to initialize your Harvest context. To do so, select the VCS > Open Project menu. 2. Ensure the System is set to Harvest. 3. Hit the browse button beside the project. 4. Login using your Harvest ID when prompted. 5. Select your Harvest context: 6. A dialog will pop up. In the dialog: a. In the first box, browse to the local working directory. b. Using the repository browser, browse to the directory where the *.hp~ file is checked in (see above). You should see the *.hp~ file listed. Select it and click OK. 7. A log window should open indicating the project was successfully bound. Note: steps 2-6 only need to be done if the context changes (e.g. new package, different binding file, etc.) If the context didn t change, just accept the defaults when you are presented with the dialog after step #1 (you will be prompted to login to Harvest though). 8. You can now work with Harvest from within the IDE: a. To get the latest version of a file, select VCS > Get Files and select the file you want to get. b. To check a file out for update, select VCS > Check out, select the file you want to get and select Update and OK on the dialog that appears. c. To check a file in, select VCS > Check in from the file editor you are working in. d. To add a file to Harvest, select VCS > Add File from the file editor containing the new file you want to check in. For further information see the documentation for the VCS plugin for PL/SQL Developer. 1.2 TOAD Binding File Set Up Before you can use IDE integration with Harvest, you must set up a binding file that is versioned in Harvest and that defines which files are part of the bound project (e.g. can be checked in & out from the IDE). The bound file list does not need to include ALL files in the repository and more than one binding file can be set up in Harvest. For example, different binding files can be set up for each team working in Harvest. In this case, each binding file would contain only the files applicable to that development team.

4 In addition, you must configure the TOAD Team coding feature to use Harvest as the SCC provider. This is done by going to the TOAD View > Options menu, selecting the Team Coding section and setting up the configuration options as shown below: Note: The Team Coding options refer to a internal feature of TOAD that allows for control of objects in the DB schema. This is not required for use of the SCC capabilities of TOAD and is recommended to be turned off Creation of a new Binding File 1. Create an empty binding file with extension hp~ for example, Test_SQL.hp~ 2. Check this file into Harvest as a new file. 3. Log into Harvest and check out all the files you wish to add to the binding file into a local working directory on your hard drive, taking care to include the directory containing the *.hp~ file. Your local working directory should have a structure that looks somewhat like the following: C:\Working_Directory\Bind_File_Name.hp~ Source_Directory\Files and Subdirectories containing files that will be bound 4. Now check out all the files you wish to bind to the IDE for update (into the same working directory as indicated above). 5. Open TOAD. 6. Open the Procedure Editor window. 7. Right click and select Source Control > Select Project. 8. Login with your Harvest ID. 9. A window will open prompting you for the Harvest context. 10. Select your Harvest context: 11. A dialog will pop up. In the dialog:

5 12. A log window should open indicating the project was successfully bound. 13. Now you can add the files you wish to work with into the hp~ file. To do so, you must open each one, one at a time and right click in the procedure editor and select the Source Control > Add Files menu. Ensure you do not select any *.sig or hscc.log files these are created for use by the VCS plugin. 14. Enter a comment and hit OK. 15. A windows dialog will open for you to select files. Select all the files you want to work with in the bound IDE project. 16. Click OK. Repeat step for each file. The files that you checked out in step 4 should be released and bound for IDE integration. You can validate this in Harvest by seeing that there are no more R tagged files in the package and there should be a new version of the *.hp~ file. If you look at the contents of the *.hp~ file you should also see a listing of the files you added. NOTE: Because TOAD lacks the ability to add files to the binding file in a group (e.g. you need to do this one at a time), it is recommended to use PL/SQL Developer to create all binding files Working in a Bound Project Once the *.hp~ file is set up and your project is bound, you should be able to work with it on a day to day without much effort. This is done as follows: 1. After opening TOAD, you need to initialize your Harvest context. To do so, open a procedure editor, right click and select Source Control > Select Project. 2. Login with your Harvest ID. 3. A window will open prompting you for the Harvest context. 4. Select your Harvest context: 5. A dialog will pop up. In the dialog: 6. A log window should open indicating the project was successfully bound. 7. You can now work with Harvest from within the IDE. Note: In all cases, you must have the file open from disk before you can use the SCC plugin (this is a limitation of the TOAD implementation of SCC): a. To get the latest version of a file, right click and select Source Control > Get Latest File. b. To check a file out for update, right click, select Source Control > Check out and select Update and OK on the dialog that appears. c. To check a file in, right click and select Source Control > Check in. d. To add a file to Harvest, right click and select Source Control > Add File from the file editor containing the new file you want to check in.