webCRM Field Metadata XML

Field metadata is used to describe the fields that have been configured in webCRM, including any values provided for picklists etc. You can use this task to help with identifying the names of custom fields, and the values that can be provided for fields.

Tasks

• Export Field Metadata from webCRM

Fields

DbFieldName

Read Only
The internal database name of the field.

Type	Example	XML
string	o_type	<DbFieldName>o_type</DbFieldName

FriendlyFieldName

Read Only
The friendly name for the field to use in queries.

Type	Example	XML
string	OrganisationType	<FriendlyFieldName>OrganisationType</FriendlyFieldName>

Id

Read Only
The internal id for the field.

Type	Example	XML
int	12	<Id>12</Id>

Label

Read Only
The label of the field used in webCRM UI.

Type	Example	XML
string	Org_Type	<Label>Org_Type</Label>

SortOrder

Read Only
The sort order of the field used in webCRM UI.

Type	Example	XML
int	11090	<SortOrder>11090</SortOrder>

DisplayType

Read Only
The display type of the field used in webCRM UI.

Type	Example	XML
string	D	<DisplayType>D</DisplayType>

TextFieldMaxLength

Read Only
The maximum length of text allowed for the field.

Type	Example	XML
int	50	<TextFieldMaxLength>50</TextFieldMaxLength>

DropdownListData

Read Only
For certain field types values can be specified within webCRM, e.g. to build up drop down lists.

Text

Read Only
The display text for the option.

Type	Example	XML
string	Customer	<Text>Customer</Text>

Value

Read Only
The internal value for the option.

Type	Example	XML
string	Customer	<Value>Customer</Value>

Example XML

<?xml version="1.0" encoding="utf-8"?>
<FieldMetadata
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <FieldMetadata>
    <DbFieldName>o_type</DbFieldName>
    <FriendlyFieldName>OrganisationType</FriendlyFieldName>
    <Id>12</Id>
    <Label>Org_Type</Label>
    <SortOrder>11090</SortOrder>
    <DisplayType>D</DisplayType>
    <TextFieldMaxLength>50</TextFieldMaxLength>
    <DropdownListData>
      <FieldMetadataDropdownList>
        <Text>Customer</Text>
        <Value>Customer</Value>
      </FieldMetadataDropdownList>
      <FieldMetadataDropdownList>
        <Text>Partner</Text>
        <Value>Partner</Value>
      </FieldMetadataDropdownList>
      <FieldMetadataDropdownList>
        <Text>Supplier</Text>
        <Value>Supplier</Value>
      </FieldMetadataDropdownList>
      <FieldMetadataDropdownList>
        <Text>Agent</Text>
        <Value>Agent</Value>
      </FieldMetadataDropdownList>
      <FieldMetadataDropdownList>
        <Text>General</Text>
        <Value>General</Value>
      </FieldMetadataDropdownList>
    </DropdownListData>
  </FieldMetadata>
</FieldMetadata>