PDSA XML Builder Utility

Transcription

1 PDSA XML Builder Utility This utility is handy for building XML files or XSD Schema files from tables, stored procedures that return result sets, or views in your database. We use this utility to generate XML files for prototyping new applications, creating XSD files for Crystal Report or SQL Server Reporting Services, or sometimes to even transfer data from one system to another. NOTE: Currently this utility only works with SQL Server 2000 and To use this utility fill in the Connect String that points to the database you wish to run against. Select the table, view or stored procedure and generate the file. Figure 1 shows you what this utility looks like.

2 Figure 1. Build XML and/or XSD files from tables, views and stored procedures. Below is a description of the various fields that you fill on the various tabs to utilize this utility to generate XML and XSD files. 2 PDSA XML Builder Utility

3 Step 1: Connection Tab The first tab (Figure 2) is where you will fill in the SQL Connect String field. Place the appropriate connection string to your SQL Server 2000 or 2005 database in this field. After entering the connection string, click on the Test Connection button to ensure that you can reach the database. If you wish to clear all the fields on the complete utility, click on the Reset button. Figure 2. Step 1: Connection Tab PDSA XML Builder Utility 3

4 Step 2: SQL Tab The Step 2: SQL Tab (Figure 3) is where you will enter your SQL to generate the XML from. It is very important to realize that this utility should only be used with SELECT statements. We try to stop other statements, but with stored procedures you will be responsible for ensuring that inappropriate stored procedures are not called. From the Object Type drop-down list, select Table, View or Stored Procedure. After selecting one of these types, the PDSA XML Builder will load the appropriate objects from your database. When you click on an object in the Objects list box, a SELECT statement will be generated for a Table or View, or a call to a stored procedure will be generated. If you have many tables, views and stored procedures, you may use the Search Filter text box to limit the list to just those that match the characters that you type in. This can help you find a specific table/view/sp quickly. Delete characters from this text box, to get back to the complete list. You are also allowed to simply enter a valid SELECT statement or call to a stored procedure directly into the SQL to Submit field. 4 PDSA XML Builder Utility

5 Figure 3. Step 2: SQL Tab Generating XML from a Stored Procedure Careful consideration must be given when generating XML from a stored procedure. First off, you should only execute those stored procedures that actually return data, and not one that performs some action query. If the stored procedure you select from the list box has any input parameters, they will be listed on the line after the call to the stored procedure. You will need to fill in an appropriate value into each parameter in order to have the stored procedure execute correctly and return data that can be used to generate XML from. PDSA XML Builder Utility 5

6 Figure 4. XML Builder using a stored procedure In the example shown in Figure 4 you would need to insert a value of 1 between the two single quotes. So the code submitted to generate the XML would look like the following: exec 1 6 PDSA XML Builder Utility

7 Step 3: Generate Tab When you generate the XML file (Figure 5), you need to specify the root element name. For example, if you are generating XML from the pdsausers table, then the resulting XML file will look like the following: <NewDataSet> <pdsausers> <iuser_id>12</iuser_id> <sappname>testapp</sappname> <sfirstname>joe</sfirstname> </pdsausers> </NewDataSet> The <pdsausers> element is created from the name that you input into the XML Node Name field. Fill in the XML Output Folder with the location where you wish to generate the XML file to. Fill in the XSD Output Folder with the location where you wish to generate the XSD file to. folders The Row Threshold field is defaulted from the.config file for this utility. If your SQL Query generates more rows than the value in this field you will be prompted for whether or not you wish to continue. To restrict the amount of rows generated from your SQL query, use TOP n in your SQL query. There is no way to limit the rows returned from a stored procedure. You have the option to Generate XML and/or Generate XSD files by checking or un-checking the appropriate check boxes on this tab. In addition you may be prompted to overwrite any XML or XSD files that already exist in the specified folder. You will be given a chance to replace the files, or this utility can automatically overwrite them if the Prompt to Overwrite check box is unchecked. PDSA XML Builder Utility 7

8 Figure 5. Step 3: Generate Tab 8 PDSA XML Builder Utility

9 Step 4: Output After the generation of the XML and/or XSD files are complete, the complete contents of the XML/XSD file(s) will be placed into the text boxes on the Step 4: Output tab (Figure 6). You have an option to copy the XML and/or XSD contents to the clipboard by clicking on the appropriate button above the corresponding text box. Figure 6. Step 4: Output Tab PDSA XML Builder Utility 9

10 Info Msgs Tab Instead of constantly giving you message boxes when things go wrong, the XML Builder utility will place all error messages, and a lot of informational messages into the appropriate list boxes on the Info Msgs tab. You have the option of copying all informational messages to the clipboard by clicking on the Copy Info Msgs button. You have the option of copying all error messages to the clipboard by clicking on the Copy Error Msgs button. This will be helpful if you ever need to tech support with a question on this utility. Figure 7. Info Msgs Tab 10 PDSA XML Builder Utility

11 Configuration File PDSA XML Builder Utility In the installation folder where you install this utility is a.config file named PDSAXMLBuilder.exe.config. In this config file you will find many settings. It is imperative that you not interfere with the settings in here in anyway. If you modify the wrong thing, it could cause the utility to break. After each time you generate, the information like the connection string used, the output folders, the prompt to overwrite flag and other information is automatically stored into this.config file so the next time you run this utility that information will be preserved. Tech Support As this is a very low cost utility, we do not accept phone calls related to the usage of this product. However, you may us at support@pdsa.com. We provide support only to licensed customers for the first 90 days of the usage of this product. We also welcome any feedback, or comments related to the improvement of this product. PDSA XML Builder Utility 11

12 Summary We hope you get a lot of use out of this utility. We use this utility quite often to generate XML for prototypes, or just to build some XML to feed a web service, any many other uses. We are sure you will find many uses for it as well. 12 PDSA XML Builder Utility