Primary Content

The Primary Content page is default category. You need to configure one or more elements in this page to get started using this web part.

Primary Content contains the following:

 

Table 1. Primary Content

Element	Description
Title	Allows you to enter a title for the Web Part, or accept the default. This field is mandatory.
Catalog	See Catalog.
Form Type	Allows you to choose one of the following: • DisplayEntity — The form is used to display an entity (all fields are read-only). • NewEntity — The form is used to create a new entity. • EditEntity — The form is used to edit an entity.
Form Layout	For more information, see Form Layout
Display Fields	For more information, see Display Fields

Catalog

This property defines the entity and the operations related to the entity.

Entities contain the following elements:

Table 2. Catalog

Element	Description
Advanced Mode	Turn on if you want to edit Catalog in XML format. <Catalog>    <Entity Name="entityName" System="systemName" Service="serviceName" Default="true/false">       <Properties>          <Property Name="propertyName" Type="typeName" Value="propertyValue" />          <Property Name="propertyName" Type="typeName" Value="propertyValue" />       </Properties>       <Operation Name="operationName" Method="methodName" Default="True/False" >          <Parameter Source="sourceType" SessionName="sessionName" SourceName="sourceName" Type="parameterType" Name="parameterName" Usage="usageType" Value="value" />          <Parameter Source="sourceType" SessionName="sessionName" SourceName="sourceName" Type="parameterType" Name="parameterName" Usage="usageType" Value="value" />       </Operation>    </Entity>    <Entity> ..</Entity> </Catalog>
System	Allows you to specify the system name that is defined in the System Integration configuration file. If the system name does not exist in the System Integration configuration file, you will get an error.
Service	Allows you to specify the service name that is defined in the System Integration configuration file. The service name that you specify here must belong to system that you specify in the System attribute. If the service name does not exist in the System Integration configuration file, you will get an error.
Name	Allows you to specify the name of the entity which must be unique within this Catalog. The name does not have to match with any name in your external system. However, it is recommended that you use a descriptive name for your entity. This field is mandatory.
Set Session Name	Allows you to enter name of the session variable where the edited or newly created item is stored when it is saved, or the item that is being displayed or edited is stored when it is loaded.
Reset Session Names	Allows you to reset (set to NULL) the value of the session variable whose name is specified in this attribute. Specify multiple names by separating them with commas.
Default	Allows you to define this entity as the default for the list form. If this element is not specified, the first entity that is listed in the catalog becomes the default entity. The default operation of the default entity is the operation that is used to retrieve the data when the list form is loaded for the first time in edit or display mode.

You can add operations to your entities by configuring the following elements:

Table 3. Operations

Element	Description
Name	Allows you to specify the name of the operation. This name does not have to match with any name in your external system. This name is used to refer to this operation in the Action property. This field is mandatory.
Method	Allows you to specify the real name of the operation in your external system. For example, it may refer to the name of a web service method. Or it may refer to the name of a stored procedure in your SQL Server database.
Default	Allows you to define this operation as the default. The default operation is the first operation that is called to retrieve the entity to be displayed or edited. If this attribute is not specified, the first operation listed in the entity becomes the default operation.

You can define parameters for the operation by configuring the following elements:

Table 4. Parameters

Element	Description
Name	Allows you to specify the name of the parameter.
Source	Allows you to define the source of this parameter. The source can be one of the following: • DefaultValue — the value of the parameter that is the default • NullValue — the value of the parameter is blank • FixedValue — the value of the parameter that is defined in the Value attribute • HttpRequest — the value of the parameter that is retrieved from the HTTP parameters in the page URL. The name of the HTTP parameter is defined in the SourceName attribute. As an example, say the current page URL is http://mysite.com/default.aspx?ProductType=Hardware. If the SourceName attribute is ProductType, the value of the ProductType HTTP parameter, which is Hardware, is used as the value of the parameter. • Input — the value of the parameter that is retrieved from one of the input fields in the form. You specify the name of the input field in the SourceName attribute. Additionally, you can retrieve the current user information as the value of the parameter. You can specify one of the following name in the SourceName attribute to retrieve the current user information: • RowFromAnotherWebPart — the value of the parameter that is retrieved from the row that is consumed from another web part. You specify the name of the field that is consumed in the SourceName attribute. • Session — the value of the parameter that is retrieved from the row that is stored in the session. You specify the name of the session in the SessionName attribute. You specify the name of the field that is consumed in the SourceName attribute. • ComplexType — the value of the parameter is an object based on the Type attribute and Member definition inside the Parameter. Array and nested complex types are supported. • Array — the value of the parameter is an array of values • XML — the value of the parameter that is dynamically built when the condition is execute at runtime
Usage	Allows you to define the direction for this parameter. The options are In, Out, InOut, or ReturnValue.

You can define one or more Property elements.

Table 5. Properties

Element	Description
Name	Allows you to specify the name of the property. Refer to the documentation for the DAO Provider to your external system will tell you the name of the property that you must define.
Type	Allows you to specify type of value that is specified in the Value attribute. Example: System.String.
Value	Allows you to specify the value of the property.

Form Layout

This property enables you to define the layout of the fields in the List Form. If this property is not defined, the List Form will display the fields in two column format: the first column is the field title and the second column is the control for the field.

This property is related to the Display Fields property. The Form Layout property defines the layout type and the containers. In order to place a certain field in a specific container, you will use the Tab/Panel/Container ID attribute of the Field element in the Display Fields property.

The Form Layout element can contain zero or more Container elements. You may not have to define any container for a certain type of layout manager. Some custom layout manager may have a fixed set of containers that do not need to be defined.

The Form Layout section contains the following:

 

Table 6. Form Layout

Form Layout type	Description
Advanced Mode	Turn on if you want to edit Form Layout in XML format: <FormLayout Type="TabLayout">     <Container Type="containerType" ID="containerID1" Label="tabText1"     ShowUserGroups="group1,group2" HideUserGroups="group3,group4">     <Container Type="containerType" ID="containerID2" Label="tabText2"     ShowUserGroups="group3,group4" HideUserGroups="group1,group2"> </FormLayout>
Tab Layout	Groups the fields in multiple tabs. You can add tabs to this layout by setting values for the following: • ID — the identifier for the tab. This ID must be unique for each container that is defined in the Form Layout. This identifier is referred to in the ContainerID attribute of the Field element in the Display Fields Property. • Label — the label for the container. Otherwise, if the container needs a label, it will use the ID. • Header — the content that would appear at the top of the form. • Footer — the content that would appear at the bottom of the form. • ShowUserGroups — the container is shown if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. • HideUserGroups — the container is hidden if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. The HideUserGroups attribute will take precedence if the current user is a member of one of the groups specified in the HideUserGroups and ShowUserGroups.
Panel Layout	Groups the fields in multiple panels. You can add panels to this layout by setting values for the following: • ID — the identifier for the panel. This ID must be unique for each container that is defined in the Form Layout. This identifier is referred to in the ContainerID attribute of the Field element in the Display Fields Property. • Label — the label for the container. Otherwise, if the container needs a label, it will use the ID. • Header — the content that would appear at the top of the form. • Footer — the content that would appear at the bottom of the form. • ShowUserGroups — the container is shown if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. • HideUserGroups — the container is hidden if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. The HideUserGroups attribute will take precedence if the current user is a member of one of the groups specified in the HideUserGroups and ShowUserGroups.
Custom Layout	Uses the custom layout manager class specified in the LayoutManagerClassName attribute to layout the fields. Using the custom layout, you can write your own custom Layout Manager where you can layout the fields in any way you want it or even create your own custom controls in the form. For more detail on how to write your own custom Layout Manager class, see Custom Layout. You can add containers to this layout by setting values for the following: • ID — the identifier for the tab. This ID must be unique for each container that is defined in the Form Layout. This identifier is referred to in the ContainerID attribute of the Field element in the Display Fields Property. • Type — the type of container. • Label — the label for the container. Otherwise, if the container needs a label, it will use the ID. • ShowUserGroups — the container is shown if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. • HideUserGroups — the container is hidden if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. The HideUserGroups attribute will take precedence if the current user is a member of one of the groups specified in the HideUserGroups and ShowUserGroups.
MultiColumn Layout	Displays the data in multiple columns. You can select the number of columns, and select if you want to render and control in a single row (displays the Label/Input control on the same row. If not selected, the Label/Input control is on separate row. Being on the separate row gives more screen real estate to render multiple columns. If this is selected, column span and row span attributes are applied to grouped field.)
Tab and MultiColumn Layout	Groups the fields in multiple tabs and in multiple columns in each tab. You can add tabs to this layout by setting values for the following: • ID — the identifier for the tab. This ID must be unique for each container that is defined in the Form Layout. This identifier is referred to in the ContainerID attribute of the Field element in the Display Fields Property. • Label — the label for the tab. Otherwise, if the container needs a label, it will use the ID. • Header — the content that would appear at the top of the form. • Footer — the content that would appear at the bottom of the form. • ShowUserGroups — the tab is shown if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. • HideUserGroups — the tab is hidden if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. The HideUserGroups attribute will take precedence if the current user is a member of one of the groups specified in the HideUserGroups and ShowUserGroups. • Render and Control in a single row — the tab displays the Label/Input control on the same row. If not selected, the Label/Input control is on separate row. Being on the separate row gives more screen real estate to render multiple columns. If this is selected, column span and row span attributes are applied to grouped field.
Panel and MultiColumn Layout	Groups the fields in multiple panels and in multiple columns in each panel. You can add panels to this layout by setting values for the following: • ID — the identifier for the panel. This ID must be unique for each container that is defined in the Form Layout. This identifier is referred to in the ContainerID attribute of the Field element in the Display Fields Property. • Label — the label for the panel. Otherwise, if the container needs a label, it will use the ID. • Header — the content that would appear at the top of the form. • Footer — the content that would appear at the bottom of the form. • ShowUserGroups — the panel is shown if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. • HideUserGroups — the panel is hidden if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. The HideUserGroups attribute will take precedence if the current user is a member of one of the groups specified in the HideUserGroups and ShowUserGroups. • Render and Control in a single row — the panel displays the Label/Input control on the same row. If not selected, the Label/Input control is on separate row. Being on the separate row gives more screen real estate to render multiple columns. If this is selected, column span and row span attributes are applied to grouped field.

Display Fields

This property defines what fields should be displayed in the List Form and how the fields are populated.

NOTE: You must configure Display Fields before configuring Form Component Behavior. NOTE: In addition to the fields in the list, the listform recognizes the following special field. • CAPTCHA — This field contains the security image used for authenticating data that is input in the form and works for the following form types: NewEntity and EditEntity. If the list contains an existing field that has the name CAPTCHA then this field will take precedence. • Add Separator — Allows you to add static text that can be used as a description or label for a corresponding field or a group of fields in the field display sequence. You can add as many separators as required.

 

Advanced Mode

Turn on if you want to edit Display Fields in XML format.

 

Data Index/Data Member

 

NOTE: This section is optional.

The Data Index allows you to define the index of the data table that contains the data to be displayed. This is useful when the operation that retrieves the data from external system returns multiple data tables. If the data table does not have any meaningful name, use the Data Index propertY.

The Data Member allows you to define the name of the data table that contains the data to be displayed. This is useful when the operation that retrieves the data from external system returns multiple data tables and those tables do not have any meaningful name. If the data table has meaningful name, you can refer to it by using the Data Member property.

If neither the Data Member or the Data Index is specified, the first data table in the data set is used.

Fields

You can add fields by selecting them from a list automatically displayed or by manually adding them.

Loading Fields

If the default operation of the external system (selected in the Catalog section) contains data, click Load Fields to display a list of fields. Select the fields you want to display in the web part.

 

NOTE: Loading Fields is supported in the qSIListForm Web Part only.

Adding Fields

If the default operation does not contain data, select Add Fields.

You can add fields and enter values for the following:

 

Table 7. Adding Fields

Values	Description
Field Name	Displays the field name.
Title	Allows you to change the displayed title for the field. The value can be a plain string or an encoded HTML string. Change the displayed title, for example, when the title is too long or to make the title more descriptive.
Description	Allows you to set the field description. It can be a plain string or an encoded HTML string. The Description is added below the field value.

Field Properties

Click Edit next to a field name to further define its properties by configuring the following:

 

Table 8. Field Properties

Properties	Description
Name	Displays the field name.
Title	Allows you to change the displayed title for the field. The value can be a plain string or an encoded HTML string. You can change the displayed title, for example, when the title is too long or to make the title more descriptive.
Title Resource ID	If supporting a multi-lingual site, you may want to display a different Title for the field depending on the current culture. This property defines the identifier in the Resource List that is used as the title of the field. The TitleResourceID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier is not found, the default Title is used.
Tooltip	Allows you to set the text that is displayed in the tooltip when you hover your mouse over the control for the field in the list form. If you do not specify this attribute, the display name of the field is used as the tooltip text.
Tooltip Resource ID	If supporting a multi-lingual site, you may want to display a different tooltip for the field depending on the current culture. This property defines the identifier in the Resource List that is used as the title of the field. The Tooltip Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier is not found, the default tooltip is used.
Description	Allows you to set the field description. It can be a plain string or an encoded HTML string. The Description is added below the field value.
Description Resource ID	If supporting a multi-lingual site, you may want to display a different description for the field depending on the current culture. This property defines the identifier in the Resource List that is used as the title of the field. The Description Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier is not found, the default description is used.
Width (in pixels)	Allows you to set the width of the control in pixels. NOTE: Some controls, such as the Rich Text Editor, have minimum width and it will not honor the specified width if it is smaller than its minimum width.
Column Span	Allows you to set the span of the column.
Row Span	Allows you to set the span of the row.
Type	Allows you to define the type of field. The following types are supported: • SingleLineofText • MultipleLinesofText • RichText - disables resizing text • Choice - allows you to define the options for the Choice field or retrieves the options for the names of the data table in a dataset. • Number - when selected, allows you enter a minimum and maximum value, and select the number of decimal places and if you want these numbers as a percentage • Currency • DateTime - allows you to enter DateOnly or DateTime • Boolean
Required	Select this check box if this field is required.
Hidden	Allows you to hide the field.If the field is hidden, the List Form will not modify that field at all. If you hide the field using the Hidden attribute, the field is processed according to the way it is defined, but it will not be shown in the List Form.
Auto Post Back	If selected, allows the control to refresh the form when its value changes. This attribute should be set to true in the following scenarios: • When a choice field is used in the conditions of the Form Component Behavior property. • When a choice field is passed as a parameter to another operation that is used to populate another choice field.
Group Name	Allows you to create dynamic behavior for a group of fields. The list form can be defined to have dynamic behavior where certain fields or group of fields can be hidden, shown, disabled, or enabled based on certain conditions. The value in the Group Name field is referred to in the Form Component Behavior property.
Mask	Allows you to define the format of the input. The mask can contain characters and input-mask-flags such as: # — digit or space, optional. If this position is blank in the mask, it is rendered as a prompt character. L — uppercase letter, optional. Restricts input to the ASCII letters A-Z. l (lower case L) — lowercase letter, optional. Restricts input to the ASCII letters a-z. a — accepts any character <n..m> — restricts the user input to the declared numeric range, for example: <0..255>. The numeric range mask part must occupy multiple characters of the mask. <option1|option2|option3> — restricts user input to one of the set options, for example: <Sun|Mon|Tue|Wed|Thu|Fri|Sat>. \ — escapes a mask character, turning it into a literal. "\\" is the escape sequence for a backslash. All other character — all non mask elements will appear as themselves. Literals always occupy a static position in the mask at run time, and cannot be moved or deleted by the user.
Prompt Character	Allows you to define a placeholder to enter a character that is displayed and saved in place of the empty characters when you specify a mask. If not specified, "_" (underscore) is used as the default prompt character. Specify only a single character in this attribute.
Field Type	Allows you to select a field type. More options are available depending on the field type selected. For more information, see Field Types.

Field Types

Select one of the following field types.

 

Table 9. Field Types

Field types	Description
Regular Field	Allows you to assign a regular field. This is the default.
Fixed Value	You can assign a fixed value to a field using the FixedValue attribute. For example, to assign Accounting to the Department field: <Field Name="Department" FixedValue="Accounting"/> Additionally, you can use special variables for the FixedValue attribute. • <CurrentUserID/> — this value is replaced by the ID of the currently logged in user. If you want to assign the current user to the People and Group field, use this variable. If you are using Advanced Mode and you would like to assign a task to the currently logged in user, you can specify the following Field element: <Field Name="Assigned To" FixedValue="&lt;CurrentUserID/&gt;" /> • <CurrentUserName/> — this value is replaced by the name of the currently logged in user. • <CurrentUserEmail/> — this value is replaced by the email of the currently logged in user. • <CurrentLoginName/> — this value is replaced by the login name of the currently logged in user. The login name is usually in the form of domain\username. • <Today/> — this value is replaced by today's date. • <Now/> — this value is replaced by the current date and time. NOTE: If you are using SharePoint Form-Based Authentication, the above variables will return the following, for example: • CurrentUserName=testuser • CurrentLoginName=i:0#.f|<site>|testuser • CurrentUserID=6 • CurrentUserEmail=testuser@company.com You can set the following: • Allow Edit - select this check box to edit the field value in the form; otherwise, it is read-only.
Consume Value for an HTTP Parameter	The HTTP Parameter Consumer field gets its value from an HTTP parameter. This is the attribute to create an HTTP Parameter Consumer field. You can set the following: • Consume HTTP Parameter Name - allows you to enter the name of the HTTP parameter whose value is to be consumed. • Allow Edit - select this check box to edit the field value in the form; otherwise, it is read-only.
Calculated Format	You can format a value of a field using values from other fields by using the CalculatedFormat attribute. The value of the another field can be referred to using the <%fieldName%> field replacement expression. NOTE: If you are using Advanced Mode, you must use the encoded form of the < and > characters, which are &lt; and &gt;, respectively unless you type in the value in the Display Fields editor in the List Form Editor, where the Editor will encode the characters automatically for you.
Consume value from a row provided by another Web Part	The row consumer field gets its value from the row that is consumed by this List Form. To create a row consumer field, you must connect the List Form with another web part that implements the IRowProvider interface (such as the qSISelector). You can set the following: • Consume Row Display Field Name - allows you to define the field name in the row from where the value comes. • Consume Row Display Format - allows you to define the string format for the values. This attribute takes precedence over the Consume Row Display Field Name attribute. The format of the Consume Row Display Format is the same as the format used in the Calculated Format attribute. If you select NewEntity type as Form type, leave this field blank unless it is in simple text format. • Allow Edit - select this check box to edit the field value in the form; otherwise, it is read-only
Consume from another session	Session consumer field gets its value from a row that is stored in the session object. If you require values from multiple providers, use the Session Consumer field type instead of Row Consumer field type because the List Form can only be connected to one row provider. You can set the following: • Session Name - enter the name of the session • Consume Session Display Field Name - allows you to defines the field name in the session from where the value comes. • Consume Session Display Format - allows you to define the string format for the values. This attribute takes precedence over the Consume Session Display Field Name attribute. The format of the Consume Session Display Format is the same as the format used in the Calculated Format attribute. • Allow Edit - select this check box to edit the field value in the form; otherwise, it is read-only