NSUserDefinedFieldInfoAgent

Returns information about user-defined fields, like field type, field size, field label text, default value. Does not return the actual values in the user-defined fields. The values are returned on the entity objects.

Constructors

NSUserDefinedFieldInfoAgent()

NSUserDefinedFieldInfoAgent

Methods

ChangeFieldType(NSUserDefinedFieldInfo,Integer,Bool)

Creates a UserDefinedFieldInfo based on a owner-entity ID

NSUserDefinedFieldInfo ChangeFieldType(NSUserDefinedFieldInfo info, Integer fieldType, Bool isIndexed)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo Example:

NSUserDefinedFieldInfoAgent agent;
NSUserDefinedFieldInfo info;
Integer fieldType;
Bool isIndexed;
NSUserDefinedFieldInfo res = agent.ChangeFieldType(info, fieldType, isIndexed);

CreateDefaultUserDefinedFieldInfo()

Sets default values into a new NSUserDefinedFieldInfo.

NSUserDefinedFieldInfo CreateDefaultUserDefinedFieldInfo()

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSUserDefinedFieldInfoAgent agent;
NSUserDefinedFieldInfo thing = agent.CreateDefaultUserDefinedFieldInfo();
thing = agent.SaveUserDefinedFieldInfo(thing);

CreateUserDefinedFieldInfo(Integer,Integer)

Creates a UserDefinedFieldInfo based on a owner-entity ID

NSUserDefinedFieldInfo CreateUserDefinedFieldInfo(Integer ownerType, Integer fieldType)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo Example:

NSUserDefinedFieldInfoAgent agent;
Integer ownerType;
Integer fieldType;
NSUserDefinedFieldInfo res = agent.CreateUserDefinedFieldInfo(ownerType, fieldType);

DeleteUserDefinedFieldInfo(Integer)

Deletes the NSUserDefinedFieldInfo

DeleteUserDefinedFieldInfo(Integer userDefinedFieldInfo)

Returns: CRMScript.Global.Void Example:

NSUserDefinedFieldInfoAgent agent;
agent.DeleteUserDefinedFieldInfo(123);

DetectColumnIdChanges(Integer)

Detects columnid changes to the admin version (for determining publish warning)

Bool DetectColumnIdChanges(Integer ownerType)

Returns: CRMScript.Global.Bool Example:

NSUserDefinedFieldInfoAgent agent;
Integer ownerType;
Bool res = agent.DetectColumnIdChanges(ownerType);

DetectUnpublishedChanges(Integer)

Detects changes to the admin version (unpublished)

Bool DetectUnpublishedChanges(Integer ownerType)

Returns: CRMScript.Global.Bool Example:

NSUserDefinedFieldInfoAgent agent;
Integer ownerType;
Bool res = agent.DetectUnpublishedChanges(ownerType);

FigureOutListIdFromListTableIdAndUDListDefinitionId(NSUserDefinedFieldInfo)

Kind of the reverse of SetListTableIdAndUDListDefinitionIdFromSelectedListId

Integer FigureOutListIdFromListTableIdAndUDListDefinitionId(NSUserDefinedFieldInfo info)

Returns: CRMScript.Global.Integer

GetChangedPageOneFields(Integer,Integer)

Gets which page-one fields have changed from the current version

Bool[] GetChangedPageOneFields(Integer ownerType, Integer userGroupId)

Returns: CRMScript.Global.Bool[]

GetCustomFieldInfo(String,String)

Returns information about a particular custom field (user-defined + extra) on a particular table

NSFieldInfoBase GetCustomFieldInfo(String tableName, String fieldName)

Returns: CRMScript.NetServer.NSFieldInfoBase Example:

NSUserDefinedFieldInfoAgent agent;
String tableName;
String fieldName;
NSFieldInfoBase res = agent.GetCustomFieldInfo(tableName, fieldName);

GetCustomFieldInfoList(String,Bool)

Returns information about all the custom fields (user-defined + extra) on a particular table

NSFieldInfoBase[] GetCustomFieldInfoList(String tableName, Bool includeStandard)

Returns: CRMScript.NetServer.NSFieldInfoBase[] Example:

NSUserDefinedFieldInfoAgent agent;
String tableName;
Bool includeStandard;
NSFieldInfoBase[] res = agent.GetCustomFieldInfoList(tableName, includeStandard);

GetPublishedUserDefinedFieldFromFieldLabel(String,Integer)

Returns information about the given user defined field identified by the owner and the field label.

NSUserDefinedFieldInfo GetPublishedUserDefinedFieldFromFieldLabel(String fieldLabel, Integer ownerType)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo

Field labels are fuzzy. Leading and trailing spaces and punctuation are ignored.

Example:

NSUserDefinedFieldInfoAgent agent;
String fieldLabel;
Integer ownerType;
NSUserDefinedFieldInfo res = agent.GetPublishedUserDefinedFieldFromFieldLabel(fieldLabel, ownerType);

GetPublishedUserDefinedFieldFromProgId(String,Integer)

Return information about the given user defined field identified by the owner and the prog-id.

NSUserDefinedFieldInfo GetPublishedUserDefinedFieldFromProgId(String progId, Integer ownerType)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo

The prog-id is used as the key in the entity carriers.

Example:

NSUserDefinedFieldInfoAgent agent;
String progId;
Integer ownerType;
NSUserDefinedFieldInfo res = agent.GetPublishedUserDefinedFieldFromProgId(progId, ownerType);

GetPublishedUserDefinedFieldList(Integer)

Return information about all the user defined fields on a particular owner type (project, contact, person, etc).

NSUserDefinedFieldInfo[] GetPublishedUserDefinedFieldList(Integer ownerType)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo[] Example:

NSUserDefinedFieldInfoAgent agent;
Integer ownerType;
NSUserDefinedFieldInfo[] res = agent.GetPublishedUserDefinedFieldList(ownerType);

GetPublishedUserDefinedPageOneFields(Integer,Integer)

Gets a list of page one fields for given Udef type and current user group

NSUserDefinedFieldInfo[] GetPublishedUserDefinedPageOneFields(Integer ownerType, Integer userGroupId)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo[] Example:

NSUserDefinedFieldInfoAgent agent;
Integer ownerType;
Integer userGroupId;
NSUserDefinedFieldInfo[] res = agent.GetPublishedUserDefinedPageOneFields(ownerType, userGroupId);

GetUserDefinedFieldFromFieldLabel(String,Integer)

Return information about the given user defined field identified by the owner and the field label.

NSUserDefinedFieldInfo GetUserDefinedFieldFromFieldLabel(String fieldLabel, Integer ownerType)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo

Field labels are fuzzy. Leading and trailing spaces and punctuation are ignored.This may be different than the currently published fields.

Example:

NSUserDefinedFieldInfoAgent agent;
String fieldLabel;
Integer ownerType;
NSUserDefinedFieldInfo res = agent.GetUserDefinedFieldFromFieldLabel(fieldLabel, ownerType);

GetUserDefinedFieldFromIds(Integer[])

Returns an given array of user defined field identified by the IDs.

NSUserDefinedFieldInfo[] GetUserDefinedFieldFromIds(Integer[] ids)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo[] Example:

NSUserDefinedFieldInfoAgent agent;
Integer[] ids;
NSUserDefinedFieldInfo[] res = agent.GetUserDefinedFieldFromIds(ids);

GetUserDefinedFieldFromProgId(String,Integer)

Returns information about the given user defined field identified by the owner and the prog-id.

NSUserDefinedFieldInfo GetUserDefinedFieldFromProgId(String progId, Integer ownerType)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo

The prog-id is used as the key in the entity carriers. Note this may be different than the currently published fields.

Example:

NSUserDefinedFieldInfoAgent agent;
String progId;
Integer ownerType;
NSUserDefinedFieldInfo res = agent.GetUserDefinedFieldFromProgId(progId, ownerType);

GetUserDefinedFieldFromProgIds(String[],Integer)

Return an given array user defined field identified by the owner and the prog-ids.

NSUserDefinedFieldInfo[] GetUserDefinedFieldFromProgIds(String[] progIds, Integer ownerType)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo[]

The prog-id is used as the key in the entity carriers. Note this may be different than the currently published field layout.

Example:

NSUserDefinedFieldInfoAgent agent;
String[] progIds;
Integer ownerType;
NSUserDefinedFieldInfo[] res = agent.GetUserDefinedFieldFromProgIds(progIds, ownerType);

GetUserDefinedFieldInfo(Integer)

Gets an NSUserDefinedFieldInfo object.

NSUserDefinedFieldInfo GetUserDefinedFieldInfo(Integer userDefinedFieldInfoId)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo Example:

NSUserDefinedFieldInfoAgent agent;
NSUserDefinedFieldInfo thing = agent.GetUserDefinedFieldInfo(123);

GetUserDefinedFieldList(Integer)

Return information about all the user defined fields on a particular owner type (project, contact, person, etc).

NSUserDefinedFieldInfo[] GetUserDefinedFieldList(Integer ownerType)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo[]

Note this may be different than the currently published fields.

Example:

NSUserDefinedFieldInfoAgent agent;
Integer ownerType;
NSUserDefinedFieldInfo[] res = agent.GetUserDefinedFieldList(ownerType);

GetUserDefinedPageOneFields(Integer,Integer)

Gets a list of page one fields for given Udef type and current user group

NSUserDefinedFieldInfo[] GetUserDefinedPageOneFields(Integer ownerType, Integer userGroupId)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo[] Example:

NSUserDefinedFieldInfoAgent agent;
Integer ownerType;
Integer userGroupId;
NSUserDefinedFieldInfo[] res = agent.GetUserDefinedPageOneFields(ownerType, userGroupId);

IsAnyPublishEventActive()

Checks if any publish events are active

Bool IsAnyPublishEventActive()

Returns: CRMScript.Global.Bool

IsPublishEventActive(Integer)

Checks if the publish event is active for the given type.

Bool IsPublishEventActive(Integer type)

Returns: CRMScript.Global.Bool

Publish(Integer)

Publish changed Udef fields for the given owner type

Integer Publish(Integer ownerType)

Returns: CRMScript.Global.Integer Example:

NSUserDefinedFieldInfoAgent agent;
Integer ownerType;
Integer res = agent.Publish(ownerType);

Revert(Integer)

Revert changed Udef fields for the given owner type. All unpublished changes will be lost

Void Revert(Integer ownerType)

Returns: CRMScript.Global.Void

SaveUserDefinedFieldInfo(NSUserDefinedFieldInfo)

Updates the existing NSUserDefinedFieldInfo or creates a new NSUserDefinedFieldInfo if the id parameter is 0

NSUserDefinedFieldInfo SaveUserDefinedFieldInfo(NSUserDefinedFieldInfo userDefinedFieldInfo)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo Example:

NSUserDefinedFieldInfo  agent;
NSUserDefinedFieldInfo thing = agent.CreateDefaultUserDefinedFieldInfo();
thing = agent.SaveUserDefinedFieldInfo(thing);

SaveUserDefinedFieldInfos(NSUserDefinedFieldInfo[])

Saves an array of user defined fields. This will update the unpublished layout.

Void SaveUserDefinedFieldInfos(NSUserDefinedFieldInfo[] infos)

Returns: CRMScript.Global.Void

SetListTableIdAndUDListDefinitionIdFromSelectedListId(NSUserDefinedFieldInfo,Integer)

Makes stuff similar to what happens in the win client

NSUserDefinedFieldInfo SetListTableIdAndUDListDefinitionIdFromSelectedListId(NSUserDefinedFieldInfo info, Integer selectedListId)

Returns: CRMScript.NetServer.NSUserDefinedFieldInfo

SetPageOneFieldGrouping(Integer,Bool)

Sets the Page One Field grouping for a specific entity

Void SetPageOneFieldGrouping(Integer ownerType, Bool active)

Returns: CRMScript.Global.Void

SetPublishStartSystemEvent(Integer)

Sets the start flag for udef publishing. Must be called before PUBLISH, or PUBLISH will fail.

Void SetPublishStartSystemEvent(Integer ownerType)

Returns: CRMScript.Global.Void

Start flag is removed when publish process completes.

SetRankOnFields(Integer,Integer[])

Changes rank of user defined fields

Void SetRankOnFields(Integer ownerType, Integer[] rankedFieldsIds)

Returns: CRMScript.Global.Void

SetUserDefinedPageOneField(Integer,Integer,Integer,Integer)

Sets a user defined field as page one field.

Void SetUserDefinedPageOneField(Integer ownerType, Integer udefFieldId, Integer userGroupId, Integer fieldLineNo)

Returns: CRMScript.Global.Void

​Constructors

​NSUserDefinedFieldInfoAgent()

​Methods

​ChangeFieldType(NSUserDefinedFieldInfo,Integer,Bool)

​CreateDefaultUserDefinedFieldInfo()

​CreateUserDefinedFieldInfo(Integer,Integer)

​DeleteUserDefinedFieldInfo(Integer)

​DetectColumnIdChanges(Integer)

​DetectUnpublishedChanges(Integer)

​FigureOutListIdFromListTableIdAndUDListDefinitionId(NSUserDefinedFieldInfo)

​GetChangedPageOneFields(Integer,Integer)

​GetCustomFieldInfo(String,String)

​GetCustomFieldInfoList(String,Bool)

​GetPublishedUserDefinedFieldFromFieldLabel(String,Integer)

​GetPublishedUserDefinedFieldFromProgId(String,Integer)

​GetPublishedUserDefinedFieldList(Integer)

​GetPublishedUserDefinedPageOneFields(Integer,Integer)

​GetUserDefinedFieldFromFieldLabel(String,Integer)

​GetUserDefinedFieldFromIds(Integer[])

​GetUserDefinedFieldFromProgId(String,Integer)

​GetUserDefinedFieldFromProgIds(String[],Integer)

​GetUserDefinedFieldInfo(Integer)

​GetUserDefinedFieldList(Integer)

​GetUserDefinedPageOneFields(Integer,Integer)

​IsAnyPublishEventActive()

​IsPublishEventActive(Integer)

​Publish(Integer)

​Revert(Integer)

​SaveUserDefinedFieldInfo(NSUserDefinedFieldInfo)

​SaveUserDefinedFieldInfos(NSUserDefinedFieldInfo[])

​SetListTableIdAndUDListDefinitionIdFromSelectedListId(NSUserDefinedFieldInfo,Integer)

​SetPageOneFieldGrouping(Integer,Bool)

​SetPublishStartSystemEvent(Integer)

​SetRankOnFields(Integer,Integer[])

​SetUserDefinedPageOneField(Integer,Integer,Integer,Integer)

Constructors

NSUserDefinedFieldInfoAgent()

Methods

ChangeFieldType(NSUserDefinedFieldInfo,Integer,Bool)

CreateDefaultUserDefinedFieldInfo()

CreateUserDefinedFieldInfo(Integer,Integer)

DeleteUserDefinedFieldInfo(Integer)

DetectColumnIdChanges(Integer)

DetectUnpublishedChanges(Integer)

FigureOutListIdFromListTableIdAndUDListDefinitionId(NSUserDefinedFieldInfo)

GetChangedPageOneFields(Integer,Integer)

GetCustomFieldInfo(String,String)

GetCustomFieldInfoList(String,Bool)

GetPublishedUserDefinedFieldFromFieldLabel(String,Integer)

GetPublishedUserDefinedFieldFromProgId(String,Integer)

GetPublishedUserDefinedFieldList(Integer)

GetPublishedUserDefinedPageOneFields(Integer,Integer)

GetUserDefinedFieldFromFieldLabel(String,Integer)

GetUserDefinedFieldFromIds(Integer[])

GetUserDefinedFieldFromProgId(String,Integer)

GetUserDefinedFieldFromProgIds(String[],Integer)

GetUserDefinedFieldInfo(Integer)

GetUserDefinedFieldList(Integer)

GetUserDefinedPageOneFields(Integer,Integer)

IsAnyPublishEventActive()

IsPublishEventActive(Integer)

Publish(Integer)

Revert(Integer)

SaveUserDefinedFieldInfo(NSUserDefinedFieldInfo)

SaveUserDefinedFieldInfos(NSUserDefinedFieldInfo[])

SetListTableIdAndUDListDefinitionIdFromSelectedListId(NSUserDefinedFieldInfo,Integer)

SetPageOneFieldGrouping(Integer,Bool)

SetPublishStartSystemEvent(Integer)

SetRankOnFields(Integer,Integer[])

SetUserDefinedPageOneField(Integer,Integer,Integer,Integer)