Class NSFieldMetadata
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Syntax
Constructors
NSFieldMetadata()
Initializes a new instance of the NSFieldMetadata class.
Declaration
NSFieldMetadataMethods
GetAccess()
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Integer GetAccess()Returns
| Type | Description |
|---|---|
| Integer | Access restrictions on the field. See FieldAccess |
Examples
NSFieldMetadata thing;
Integer access = thing.GetAccess();GetDefaultValue()
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
String GetDefaultValue()Returns
| Type | Description |
|---|---|
| String | A default value for the field. |
Examples
NSFieldMetadata thing;
String defaultValue = thing.GetDefaultValue();GetDisplayDescription()
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
String GetDisplayDescription()Returns
| Type | Description |
|---|---|
| String | Tooltip for the field name. |
Examples
NSFieldMetadata thing;
String displayDescription = thing.GetDisplayDescription();GetDisplayName()
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
String GetDisplayName()Returns
| Type | Description |
|---|---|
| String | Localized field name – shown in the GUi. |
Examples
NSFieldMetadata thing;
String displayName = thing.GetDisplayName();GetFieldKey()
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
String GetFieldKey()Returns
| Type | Description |
|---|---|
| String | Internal key/name of the field. Used as the key in the ConnectionConfigField values when TestConnection is called. |
Examples
NSFieldMetadata thing;
String fieldKey = thing.GetFieldKey();GetFieldType()
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Integer GetFieldType()Returns
| Type | Description |
|---|---|
| Integer | Text, Integer, etc. See FieldMetadataType. |
Examples
NSFieldMetadata thing;
Integer fieldType = thing.GetFieldType();GetListName()
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
String GetListName()Returns
| Type | Description |
|---|---|
| String | MDO List provider name for list fields. |
Examples
NSFieldMetadata thing;
String listName = thing.GetListName();GetMaxLength()
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Integer GetMaxLength()Returns
| Type | Description |
|---|---|
| Integer | Maximum length for strings, if set. 0 means no restriction. (Though sooner or later something will no doubt overflow if you pile on the gigabytes.). |
Examples
NSFieldMetadata thing;
Integer maxLength = thing.GetMaxLength();GetRank()
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Integer GetRank()Returns
| Type | Description |
|---|---|
| Integer | A way to set the order of the fields. Lowest value will be displayed first/over the fields with other values. |
Examples
NSFieldMetadata thing;
Integer rank = thing.GetRank();GetShowInSearch()
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Bool GetShowInSearch()Returns
| Type | Description |
|---|---|
| Bool | True if this field is displayed in search result. |
Examples
NSFieldMetadata thing;
Bool showInSearch = thing.GetShowInSearch();SetAccess(Integer)
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Void SetAccess(Integer access)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | access | Access restrictions on the field. See FieldAccess. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldMetadata thing;
Integer access;
thing.SetAccess(access);SetDefaultValue(String)
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Void SetDefaultValue(String defaultValue)Parameters
| Type | Name | Description |
|---|---|---|
| String | defaultValue | A default value for the field. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldMetadata thing;
String defaultValue;
thing.SetDefaultValue(defaultValue);SetDisplayDescription(String)
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Void SetDisplayDescription(String displayDescription)Parameters
| Type | Name | Description |
|---|---|---|
| String | displayDescription | Tooltip for the field name. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldMetadata thing;
String displayDescription;
thing.SetDisplayDescription(displayDescription);SetDisplayName(String)
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Void SetDisplayName(String displayName)Parameters
| Type | Name | Description |
|---|---|---|
| String | displayName | Localized field name – shown in the GUi. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldMetadata thing;
String displayName;
thing.SetDisplayName(displayName);SetFieldKey(String)
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Void SetFieldKey(String fieldKey)Parameters
| Type | Name | Description |
|---|---|---|
| String | fieldKey | Internal key/name of the field. Used as the key in the ConnectionConfigField values when TestConnection is called. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldMetadata thing;
String fieldKey;
thing.SetFieldKey(fieldKey);SetFieldType(Integer)
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Void SetFieldType(Integer fieldType)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | fieldType | Text, Integer, etc. See FieldMetadataType. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldMetadata thing;
Integer fieldType;
thing.SetFieldType(fieldType);SetListName(String)
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Void SetListName(String listName)Parameters
| Type | Name | Description |
|---|---|---|
| String | listName | MDO List provider name for list fields. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldMetadata thing;
String listName;
thing.SetListName(listName);SetMaxLength(Integer)
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Void SetMaxLength(Integer maxLength)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | maxLength | Maximum length for strings, if set. 0 means no restriction. (Though sooner or later something will no doubt overflow if you pile on the gigabytes.). |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldMetadata thing;
Integer maxLength;
thing.SetMaxLength(maxLength);SetRank(Integer)
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Void SetRank(Integer rank)Parameters
| Type | Name | Description |
|---|---|---|
| Integer | rank | A way to set the order of the fields. Lowest value will be displayed first/over the fields with other values. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldMetadata thing;
Integer rank;
thing.SetRank(rank);SetShowInSearch(Bool)
Used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields.
Declaration
Void SetShowInSearch(Bool showInSearch)Parameters
| Type | Name | Description |
|---|---|---|
| Bool | showInSearch | True if this field is displayed in search result. |
Returns
| Type | Description |
|---|---|
| Void |
Examples
NSFieldMetadata thing;
Bool showInSearch;
thing.SetShowInSearch(showInSearch);