Setup Properties

The following Setup Properties are available for use with the Mashup Adapter. Click on a link to go directly to that section.

•    Add Column XML

•    Convert XML

•    Display Replacement Variables

•    Display XSL

•    Enforce Post Input

•    Infer Schema

•    No Items Found XML

•    Output as XML Only

•    Output XML Web Part Name

•    Pass Through XML

•    Reset Null Values

•    URL to XML

•    XSL Mapping

Add Column XML

Used to add a column to the data collected from the external XML sources. This is useful if you want 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>

</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 (Optional) - String

The expression used to store data within the column.

Convert XML

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

Note: This procedure will occur after the Mapping XSL has been applied.

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 would like 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”.

Display Replacement Variables

Specify any parameters that should be replaced within the display XSL. Separate each parameter with a semi-colon. For each parameter specified, use the parameter name in the XSL as "%parameter%".

Display XSL

XSL used to display the XML captured from an external XML source. This property also supports the Common Use Variables stated at the beginning of this help topic. Inside of your XSL, you can use the following variables:

•    [currentmonthend] – The last day in the current month

•    [currentmonthstart] – The first day in the current month

•    [currentweekend] – The last day in the current week

•    [currentweekstart] – The first day in the current week

•    [currentyearend] – The last day in the current year

•    [currentyearstart] – The first day in the current year

•    [hostname] – The host name of the site where the web part resides (e.g., www.company.com)

•    [me] – The currently logged in user

•    [meemial] – The currently logged  in user’s email

•    [mei] – Includes the ID of the user along with their display name

•    [meid] – The currently logged in user’s ID

•    [meloginname] – The currently logged in user’s name (domain\user)

•    [onemonthagoend] – The last day of last month

•    [onemonthagostart] – The first day of last month

•    [onemonthfromnowend] – The last day of next month

•    [onemonthfromnowstart] – The first day of next month

•    [oneweekagoend] – The last day of the previous week

•    [oneweekagostart] – The first day of the previous week

•    [oneweekfromnowend] – The last day of next week

•    [oneweekfromnowstart] – The first day of next week

•    [quarter1end] – The last day in the first quarter of the current year

•    [quarter1start] – The first day in the first quarter of the current year

•    [quarter2end] – The last day in the second quarter of the current year

•    [quarter2start] – The first day in the second quarter of the current year

•    [quarter3end] – The last day in the third quarter of the current year

•    [quarter3start] – The first day in the third quarter of the current year

•    [quarter4end] – The last day in the fourth quarter of the current year

•    [quarter4start] – The first day in the fourth quarter of the current year

•    [sitesecuritytype] – The protocol type of the site where the web part resides (e.g., http://)

•    [siteurl] –  The absolute path to the site where the web part resides (e.g., http://www.company.com/sites/site1)

•    [today] – Today's date

•    [todayrfc] – The current date in RFC format (2010-01-01T14:00:00Z)

•    [twoweeksagoend] – The last day of the week before last

•    [twoweeksagostart] – The first day of the week before last

•    [twoweeksfromnowend] – The last day of the week after next

•    [twoweeksfromnowstart] – The first day of the week after next

NOTE 1: The filter functions [SiteTitle] and [SiteURL] functions are no longer supported.

NOTE 2: The date functions listed above look for list items with a date format of month/date/year (e.g., June 15, 2007 stored as 6/15/2007). As a result, it is not recommended that they be used if international date structures are utilized (e.g., June 15, 2007 stored as 15/6/2007).

 

 

Options:

•    "[file]="

Use this option to specify a URL to an XSL Stylesheet Template

Example: [file]=<%SiteURL%>/Connections/TasksXSL.xml

•    <xsl:stylesheet>…</xsl:stylesheet>

Use this option if you would like to specify the XSL Stylesheet XML directly within the property

Example:

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">

<xsl:template match="/">

<table>

<tr>

<xsl:for-each select="NewDataSet/Table1">

                <td>

<xsl:value-of select="Title" />

</td>

</xsl:for-each>

</tr>

</table>

</xsl:template>

</xsl:stylesheet>

 

Enforce Post Input

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

Infer Schema

When enabled, tells the web part to attempt to create a schema for the XML data collected. This is enabled by default.

No Items Found XML

Specify the XML to display if no items are returned.

Example:

<NewDataSet/>

Output as XML Only

When enabled, will only display the web part contents within a web part page, preventing 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.

Output XML Web Part Name

Identify 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 property Output as XML Only property.

Default: %Auto%

Example: MyWebPart

Page Call: default.aspx?OXMLWPName=MyWebPart

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>

</PassThrough>

PTDefault (Optional) – String

The default text that will be sent to the page from which data is being requested, if the parameter is not passed into the page.

PTName (Required) – String

The name of the parameter to be passed onto the page from which data is being requested.

PTRequest (Required) – String

The name of the parameter being received by the 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

Reset Null Values

When enabled, null values captured from the external XML source will be treated as empty strings.

Table Name

Overrides the generic table name written during an XML output.

URL to XML

The URL(s) to the data source that the display will reference and Mashup for data. Separate each source URL with a semicolon (e.g., http://mycompany.com;http//anothercompany.com). 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

XSL Mapping

Used to map data collected from each connection into a single output. This negates the need to use XSL for mapping in a vMash Design. This means mapping columns with different names to a single column.

Column

The column that will be created in the output.

Path

The path to the data collected from the XML. Include only the parent path to the parent node, not the child data.

Mapping

The node to look for within the XML that contains the data you want to consume and place into the column. This does not support attributes.

Example:

<Configuration>

                <Match>

                                <Column>PID</Column>

                                <Path>NewDataSet/Table1</Path>

                                <Mapping>project_id</Mapping>

                </Match>

                <Match>

                                <Column>PID</Column>

                                <Path>NewDataSet/Data</Path>

                                <Mapping>ProjectID</Mapping>

                </Match>

                <Match>

                                <Column>Status</Column>

                                <Path>NewDataSet/Table1</Path>

                                <Mapping><!--If Empty, then no data, but create Node anyway--></Mapping>

                </Match>

                <Match>

                                <Column>Status</Column>

                                <Path>NewDataSet/Data</Path>

                                <Mapping>Status</Mapping>

                </Match>

</Configuration>

XSL Row Mapping

Used for mapping columns to rows of data, and mapping data collected from each connection into a single output. This negates the need to use XSL for mapping in an hMash Design. This means appending columns in a single row.

Parent Path

The path to the parent row that will be displayed

Parent Columns

The columns to display from the parent row. Separate each column with a comma.

Parent ID

The ID of the parent to be matched to the Child ID.

Child Path

The path to the child row that will be displayed

Child Columns

The columns to display from the child row. Separate each column with a comma.

Child ID

The ID of the child to be matched to the Parent ID.

 

Example:

<setup>

<mashup>

<ParentPath>/NewDataSet/Table1</ParentPath>

<ParentColumns>project_id,field1,field2</ParentColumns>

<ParentID>project_id</ParentID>

<ChildPath>/NewDataSet/Data</ChildPath>

<ChildColumns>one,two</ChildColumns>

<ChildID>project_id</ChildID>

</mashup>

</setup>