Scenario Properties General Tab (XQuery)

 

XQuery support is available only in Stylus Studio XML Professional Edition.

You can display the Scenario Properties dialog box for an XQuery script by clicking Browse next to the scenario name field. Although a scenario is not required in order to create an XQuery, it is quite common to apply an XQuery to a source XML document in order to perform some processing on the XML. Scenarios help you facilitate this operation.

A scenario allows you to preview the results of applying an XQuery. Scenario settings include the name of an XML source document, the values of any parameters in the XQuery script, and the type of performance metrics you want Stylus Studio to capture, if any.

A scenario can be associated with only one XQuery and only one XML source document. However, you can associate any number of scenarios with an XQuery, and you can associate any number of scenarios with an XML source document.

Fields

Existing Scenarios

Lists the scenarios that have already been defined for the current XQuery. To view the settings for a scenario, click the name of the scenario. Stylus Studio displays its settings in the General tab.

To add a new scenario, click Add. If Add is not active, type information in the fields in the General tab and click OK.

To copy an existing scenario, click the scenario you want to copy and click Clone. A new scenario is created with a default name in the Scenario Name field. All other settings are the same as those of the scenario on which you based the copy.

To delete a scenario, click it and then click Delete.

Scenario Name

The name of the new scenario. You can use the default name, or create one of your own. You can specify any characters that are allowed in Windows file names.

Main Input

Specify the absolute path for the source XML document against which you want to run the XQuery to in this scenario. If you want, click Browse to the right of the field to select to the path.

Output URL

Optionally specify or select an absolute path for the file that contains the result of previewing the XQuery. Each time you click Preview Result, Stylus Studio automatically updates the contents of this file, as well as displaying the result in the Preview window. If you specify a file that does not exist, Stylus Studio creates it.

Use Relative Paths

Select this option when you want all paths related to this scenario to be relative to the XQuery. This is often convenient; however, you might want to always keep your XML source files in a particular location. In such a situation, do not select this option. This allows you to reference your XML files with an absolute path. You can move your XQuery to a different directory and the absolute path for the source file is still correct.

Preview Result in an External Application

Displays the result in the default application for the output method specified for the XQuery. For example, if the output method for the scenario is HTML and if Internet Explorer is the default application for displaying HTML files, Stylus Studio displays the resulting HTML in Internet Explorer, as well as in the XQuery Preview window.

Button

Add creates a new scenario.

Clone copies the selected scenario except for the scenario name.

Delete removes the selected scenario.

Browse the file system to select the source XML document.

For More Information

Creating an XQuery Scenario

Getting Started with XQuery in Stylus Studio

Building an XQuery Using the Mapper

 
Free Stylus Studio XML Training: