XML Document Templates

Creating XML Document Templates

  1. In the Explorer Tree, select the Template Information object.

  2. There are options in creating an XML document template at this point.

  1. The Creating an Entity screen will be displayed.

  2. Select the Spreadsheet entity type by left-clicking on the XML radio button.

  3. Click on the Next button on the bottom right of the screen.

  4. In the Entity Name field, enter the desired name for the XML document template.

  5. In the Datasource pop-list, select the desired datasource or (use default).

  1. In the Based On pop-list,select the template on which the new XML document template will be based.  Any mutable blocks assigned to the XML document template selected will be copied to the new XML document template.  Select (NONE) to create a template that is not based on any other template.

  2. Click on the Next button on the bottom right of the screen.

  3. The Adding New Block screen will be displayed.

  4. See the Adding Blocks to XML Documents section for the next steps.

Modifying XML Document Templates

  1. In the Explorer Tree, expand the Template Information object and select the template XML document that you wish to modify.

  1. Display the XML document properties.  These will either be displayed in Alphabetical or Logically, depending on the setting of the [Sort Alphabetically/Logically] button.  The following instructions are assuming that the properties are sorted logically.

  2. In the Name property, the name that you entered when creating the template will be displayed.  It can be changed, if desired.

  3. In the Description property, enter a user-defined description for this template.  The default is the type of template followed by the template name. (i.e. Spreadsheet:TEMPLATE)

  4. In the Datasource pop-list, the datasource that you selected when creating the template will be displayed.  It can be changed, if desired.

  1. In the Allow Anonymous pop-list, select true if anonymous users should have access to this template.  Select false if anonymous users should not have access to this template.  This is the default setting for XML documents created from this template.

  2. The Inherits From pop-list displays the template from which this template was created, grayed out.  This value cannot be changed.

  3. In the Default Mode pop-list, select the view type that will be displayed by default for this template.  Choices include Run Report and Parameter Form.  This is the default setting for XML documents created from this template.

  4. In the Parameter Screen Width property, enter the width in pixels for the parameter form created for this template.  This is the default setting for XML documents created from this template.

  5. In the Parameter Screen Height property, enter the height in pixels for the parameter form created for this template.  This is the default setting for XML documents created from this template.

  6. In the Target Host property, enter the server to which the XML document output will be sent for executable XML documents.  For example, if you wanted to pass the output of this XML document to another Xephr server.

  7. If an entry is made in the Target Host property, in the Target is Secure property, select true or false to indicate whether the target host is secure and will need to be connected to using SSL.  When this property is set the true, the target host will be connected to using SSL.  

  8. If an entry is made in the Target Host property, in the Target Entity property, enter the name of the entity on the target host to which the executable XML output will be passed.

  9. If an entry is made in the Target Host property, in the Target User property, enter the user name for connecting to the target host.

  10. If an entry is made in the Target User property, in the Target Password property, enter the password for connecting to the target host.  The password will be hidden as a series of fourteen asterisks.

  11. In the Results Disposition property, select Return to Caller, FTP, EMail, or Store as File.  

    When Return to Caller is selected the results to the query will be returned to the calling browser.  
    When FTP is selected, the results to the query are sent as a file to a defined FTP server.  Additional properties are displayed when FTP is selected.
    When EMail is selected, the results to the query are sent as a file to the defined email addresses.  Additional properties are displayed when EMail is selected.
    When Store as File is selected, the results to the query are sent as a file to the defined location.  Additional properties are displayed when Store as File is selected.

  12. If the Results Disposition property is set to FTP, in the FTP Host property, enter the FTP host to which the file will be uploaded.

  13. If the Results Disposition property is set to FTP, in the FTP User property, enter the FTP user name for logging into the FTP server.

  14. If the Results Disposition property is set to FTP, in the FTP Password property, enter the FTP password for logging into the FTP Server.

  15. If the Results Disposition property is set to FTP, in the FTP Binary property, select true or false.  When set to true, the file will be uploaded using binary transfer mode.  When set to false, the file will be uploaded using ASCII transfer mode.

  16. If the Results Disposition property is set to FTP, in the FTP Directory property, enter the directory on the FTP server to which the file will be uploaded.

  17. If the Results Disposition property is set to FTP, in the FTP Passive property, select true or false.  When set to true, the file will be uploaded to the FTP server using passive mode.

  18. If the Results Disposition property is set to EMail, in the EMail From property, enter the email address that will be placed in the From field when the file is emailed.  Global variable references can be entered in this field.

  19. If the Results Disposition property is set to EMail, in the EMail Subject property, enter the subject line for the email that will contain the results.   Global variable references can be entered in this field.

  20. If the Results Disposition property is set to EMail, in the EMail Message property, enter the message for the email that will contain the results.   Global variable references can be entered in this field.

  21. If the Results Disposition property is set to EMail, in the EMail Query property, enter the query that will return the list of email addresses to which the email will be sent.   Global variable references can be entered in this field.

  22. If the Results Disposition property is set to Store to File, in the Target Filename property, enter the directory and file name for the file.

  23. The Created on property displays the date and time on which this template was created and cannot be changed.

  24. The Modified on property displays the date and time on which this template was last changed, and cannot be modified.

  25. When all changes have been made, press the [Save] button in the Main Toolbar.

Xephr is a registered trademark of NDS Systems, LC.

Copyright © 2007 NDS Systems LC.