Workplace Lookup Field Advanced Settings

Additional Update Fields

An XML string property that allows a user to configure the lookup so that when a value is selected, additional fields in the list are updated with content configured from the data source.
The Additional Update Fields property accepts an XML string that should contain the following schema:

<UpdateFields>
     <Field>
         <Title InternalName="true/false">FieldName</Title>
        <FieldValue>
                1):xpath=xpath value
               2)<values>
                        <value type="xpath/text">xpath value or text</value>
                  </values>
        </FIeldValue>
   </Field>
</UpdateFields>

For each field to be updated, there should be a Field node that contains two child nodes: a Title node and FieldValue node. You can specify an internal field name by providing an InternalName attribute set to true in the Title Node. For the FieldValue node, you can provide a single xpath statement in the following format ": xpath=" with the right side of the equation being your query value.

In addition to the xpath query, users can specify a more complex value by utilizing the Values XML fragment as seen in the other properties. The XML should contain a parent node of values and child nodes of value. Each value node should have an attribute type set to either text or xpath. If text is specified, static text should be provided. Otherwise, if you have specified xpath, a valid xpath statement should be provided. The FieldValue node represents the data that will be stored to the field specified in the Title node.

Below is a sample of the property in use.

<UpdateFields>
                <Field>
                                <Title InternalName="false">Description</Title>
                                <FieldValue>
                                                <values>
                                                                <value type="xpath">CorasWorks/NewDataSet/Table1/Status</value>
                                                                <value type="text"> -</value>
                                                                <value type="xpath">CorasWorks/NewDataSet/Table1/ListID</value>
                                                </values>
                                </FieldValue>
                </Field>
                <Field>
                                <Title>test</Title>
                                <FieldValue>:xpath=CorasWorks/NewDataSet/Table1/Priority</FieldValue>
                </Field>
</UpdateFields>

Append Source to URL

This checkbox allows you specify whether or not the referring URL should be included in the lookup’s link value on the item’s display form.

• If the checkbox is selected, the URL will be appended to the item’s link

• To exclude the URL in the link value, de-select the checkbox

Create New Item URL

Use this property to specify the URL that will be opened so that users can create additional/new Lookup Items without having to leave the current form. It is optional and is only utilized when the search-enabled lookup type is being used. As with other CorasWorks URL properties, this property supports the Common Use Variables stated at the beginning of this help topic.

Default Value

A string value that can be set to either pre-select a given value in the drop-down-enabled lookup, or populate the text box with a default text value for the search-enabled lookup.

Note: When utilizing the drop-down-enabled lookup, you can specify a default index value rather than a default text value by using the following string command: index=#

Example: index=2

Enforce Post Input

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

Initial Lookup Text

This property applies only when the DropDown lookup type is selected.

The text value the Workplace Lookup will display as the default or top selection in the drop-down of choices. This value also represents an empty value in the SharePoint list.

Default: empty

Example: Please Select From The Choices

Loading HTML

Allows you to specify any text or HTML value that will be displayed within a search-enabled lookup’s selection form page while any busy activity is occurring. If no value is specified, the user will be presented with the default loading screen with the spinning gears animation.

Lookup ID Key Source

The XML node location of the value that will be used by the Workplace Lookup to assign a unique identification key to each choice item. If the Lookup Configuration has been set up to utilize a different Lookup Value to Store and URL to XML, this property becomes required for the Workplace Lookup to function correctly. This property can be specified in one of two ways:

1) A simple xpath query, represented by the following:
:xpath=(your xpath query here)

2) An XML string, which allows you to specify a more complex value consisting of multiple xpath queries and static text values. The XML string will contain a values root node with child value nodes representing your individual string pieces. The value nodes contain a single attribute type which tells the property whether it should treat the value as static text or an xpath query. The attribute values are type="text" or type="xpath".

Default: empty

Example:             :xpath=NewDataSet/Table1/Title
                                <values>
                                                <value type="xpath">NewDataSet/Table1/Title</value>
                                                <value type="text"> - </value>
                                                <value type="xpath">NewDataSet/Table1/Description</value>
                                </values>

TIP: If there is no single value that you can use to uniquely identify each choice, try using the second property to join two or more values to create one unique value.

Lookup Link Source

The XML node location of the value that will link the choice back to its parent details. This link is utilized on the item display form from within SharePoint. This property is optional. It can be specified in one of two ways:

1) A simple xpath query, represented by the following:
:xpath=(your xpath query here)

Default: empty

Lookup Selection Setup

The XML node location of the display text to be presented by the lookup to users as the choices for selection. This property can be specified in one of two ways:

1) A simple xpath query, represented by the following:
:xpath=(your xpath query here)

2) An XML string, which allows you to specify a more complex value consisting of multiple xpath queries and static text values. The XML string must contain a values root node with child value nodes representing your individual string pieces. The value nodes contain a single attribute type which tells the property whether it should treat the value as static text or an xpath query. The attribute values are type="text" or type="xpath".

Default: empty

Lookup Type

(Available only with version 2.0 and higher.) Select DropDown or Search Enabled to display the appropriate type of Workplace Lookup control suited for your needs. The DropDown option is the basic version 1.0 lookup control, while the Search Enabled lookup is geared towards high performance, allowing you to look up/search fields that might contain large amounts of data.

Default: DropDown

Lookup Value to Store

The XML node location of the value that will be stored in the SharePoint list when the item is selected and the list item is saved. This property is optional; if no value is provided, the lookup will utilize the value represented by the URL to XML . This property can be specified in one of two ways:

1) A simple xpath query, represented by the following:
:xpath=(your xpath query here)

Default: Value of the URL to XML property

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., < < and > >).

Example:

<Pass>

<PTRequest>SearchString</PTRequest>

<PTName>SearchString</PTName>

</Pass>

</PassThrough>

Return All Search Items

Select this option when utilizing the Search Enabled lookup type to force a user to search on a value before any data is returned. This can prevent users from straining a web server when working with lookups that have large data sets.

Sequence Number

Controls the sequence for which all Workplace Lookups in the list will execute. Specify any number greater than 10,000.

Show Appended Fields

This checkbox is used to specify whether or not the update field values should be displayed in the results for the search-enabled lookup.

• If the checkbox is selected, the update values will be displayed within the grid

• If the checkbox is not selected, you will only see the values of the lookup items within the grid

URL to XML

The URL of the data source referenced by the Workplace Lookup to populate its choices. This property also supports the Common Use Variables stated at the beginning of this help topic.

Default: Empty

Examples: http://domain.com/LookupDataSources/Contacts
<%SiteURL%>/LookupDataSources/Contacts

URL to XML with Filter

This is a required setting; if left blank, no data will be returned. It establishes a connection to the filtered data source connection. This only applies when the Search Enabled lookup type is selected. This property also supports the Common Use Variables stated at the beginning of this help topic.

Note: The Workplace Lookup will pass a query string parameter "filter=" with the value of the search filter on the right side of the equation. If using the External Data Provider, you will need to make sure you have provided this parameter as part of the values nodes.