Setup Properties

The following Setup Properties are available. Click on a link to move directly to that section.

•    Add Column XML

•    Convert XML

•    Enforce Post Input

•    No Items Found XML

•    Output as XML

•    Output XML Web Part Name

•    Pass Through XML

•    Show Data

•    Store Content Before Analysis

•    URL to XML

 

Add Column XML

Used to add a column to the data collected from the external XML sources. This is useful if you would like to set a default value for a column if the initial column is null, like a currency field.

Go to http://msdn2.microsoft.com/en-us/library/system.data.datacolumn.expression(VS.71).aspx for more information.

Example:

<AddColumn>

<Column>

<ColumnName>ZeroOfGroup1</ColumnName>

<ColumnType>System.Int32</ColumnType>

<Expression>IsNull(1*[Group Value0], 0)</Expression>

</Column>

<Column>…</Column>

</AddColumn>

ColumnName (Required) - String

The name of the column you want to add.

ColumnType (Optional) - String

The type of column you want to add. Please see Convert XML/ColumnType for available options.

Expression (Required) - String

The expression used to store data within the column.

 

Back to Top

 

Convert XML

Use this property to convert fields collected from the external XML from a String to a different type.

Example:

<Convert>

<Column>

<ColumnName>Start Date</ColumnName>

<ColumnType>System.DateTime</ColumnType>

</Column>

<Column>…</Column>

</Convert>

ColumnName (Required) – String

The name of the column you want to convert.

ColumnType (Required) – String

The System Type you want to convert the column to.

Options:

•    System.Boolean

•    System.Byte

•    System.Char

•    System.DateTime

•    System.Decimal

•    System.Double

•    System.Int16

•    System.Int32

•    System.Int64

•    System.SByte

•    System.Single

•    System.String

•    System.TimeSpan

•    System.UInt16

•    System.UInt32

•    System.UInt64

TableName (Optional) – String

The name of the table which contains the column to convert. The TableName comes from the Table node used in the XML. For instance if your xml looks like “<Data><Title>Hello</Title></Data><Data><Title>World</Title></Data>”
the name of your table is “Data”.

 

Back to Top

 

Enforce Post Input

When enabled, forces any information to be passed into the page as a post request versus a get request. This disables the ability to add ?Parameter=Value to the page.

Back to Top

 

No Items Found XML

Specify the XML to display if no items are returned.

Example:

<NewDataSet/>

Back to Top

 

Output as XML

When enabled, displays only the web part contents within a web part page, removing anything else from showing on the page. After this feature is enabled, you will need to add "?OverrideXML=true" or "?version=coras" to the URL in order to modify the web part properties.

Back to Top

 

Output XML Web Part Name

The OXMLWPName that must be called if you want this web part to run. If ?/&OXMLWPName=THISPROPERTY is not found in the URL or Post to this page, the web part will not run. Use this in combination with the Output As XML Only property.

Default: %Auto%

Example: MyWebPart

Page Call: default.aspx?OXMLWPName=MyWebPart

Back to Top

 

Pass Through XML

Use this property to pass page parameters onto the page specified in the URL to XML property. This supports the Common Use Variables stated at the beginning of this help topic. You must encode the < and > symbol when using the parameters (e.g., < &lt; and > &gt;).

Example:

                <PassThrough>

                                <Pass>

                                                <PTType>get</PTType>

                                                <PTRequest>SearchString</PTRequest>

                                                <PTName>SearchString</PTName>

                                                <PTDefault>[Me]</PTDefault>

                                </Pass>

                                <Pass>…</Pass>

</PassThrough>

PTDefault (Optional) – String

The default text to be sent to the page that you are requesting data from, if the parameter is not passed into this page.

PTName (Required) – String

The name of the parameter to be passed onto the page that you are requesting data from.

PTRequest (Required) – String

The name of the parameter being received by this page.

PTType (Required) – String

Controls the type of pass through. Use "post" to store the parameters in the header of your request, or use "get" to store them in the URL.

Options:

•    post

•    get

Back to Top

 

Show Data

When enabled, displays the data being collected by this web part, presented within a custom grid. However, if you attempt to collect too much data, you could inadvertently crash your browser because too much data is trying to be rendered.

Back to Top

 

Store Content Before Analysis

Used to store content into the data table before analysis.  The data that will be collected can be created from an expression, it can come from a get/post request from another page, or it can be a static value. The difference between this and the Add Column XML property is that this process occurs before any analysis is completed, versus after.

Example:

                <ExtraPreData>

<Data>

<ColumnName>Event Start</ColumnName>

<ColumnType>System.String</ColumnType>

<PageRequest>StartDateNew</PageRequest>

</Data>

<Data>…</Data>

</ExtraPreData>

Column Name

The name of the column you want to add.

ColumnType (Optional) - String

The type of column you want to add. Please see Convert XML/ColumnType for available options.

ColumnValue (Optional) – String

The static value to be stored within the property.

Expression (Required) - String

The expression used to store data within the column.

PageRequest (Optional) – String

The Page Request variable to collect when this page is called. This can come from either a get request or a post request.

Back to Top

 

URL To XML

The URL to the data source that the Business Data Analysis Adapter will reference for data to display.  This property also supports the Common Use Variables stated at the beginning of this help topic.

Default:  empty

Example:             http://domain.com/GridDataSources/Tasks
                                <%SiteURL%>/GridDataSources/Tasks

Back to Top