Interface IUserDefinedFieldInfoAgent

Interface for the UserDefinedFieldInfo Agent 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.

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

[Agent("UserDefinedFieldInfo Agent", "Interface for the UserDefinedFieldInfo Agent. 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.")]
public interface IUserDefinedFieldInfoAgent : IAgent

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

Methods

ChangeFieldType(UserDefinedFieldInfo, UDefFieldType, Boolean)

Create a UserDefinedFieldInfo based on a owner-entity id

Declaration

UserDefinedFieldInfo ChangeFieldType(UserDefinedFieldInfo info, UDefFieldType fieldType, bool isIndexed)

Parameters

Type	Name	Description
UserDefinedFieldInfo	info	The user-defined field info carrier to want to modify
UDefFieldType	fieldType	The new field type you want
Boolean	isIndexed	The new indexed status you want

Returns

Type	Description
UserDefinedFieldInfo	Returns the user-defined field info carrier

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

ClearCaches()

Clear all relevant caches. This is normally done automatically but can be useful in certain circumstances.

Declaration

void ClearCaches()

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

CreateDefaultUserDefinedFieldInfo()

Loading default values into a new UserDefinedFieldInfo. NetServer calculates default values (e.g. Country) on the entity, which is required when creating/storing a new instance

Declaration

UserDefinedFieldInfo CreateDefaultUserDefinedFieldInfo()

Returns

Type	Description
UserDefinedFieldInfo	New UserDefinedFieldInfo with default values

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

CreateUserDefinedFieldInfo(UDefType, UDefFieldType)

Create a UserDefinedFieldInfo based on a owner-entity id

Declaration

UserDefinedFieldInfo CreateUserDefinedFieldInfo(UDefType ownerType, UDefFieldType fieldType)

Parameters

Type	Name	Description
UDefType	ownerType	The user-defined field owner-entity id.
UDefFieldType	fieldType	The field type of the new field

Returns

Type	Description
UserDefinedFieldInfo	Returns the user-defined field info carrier

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

DeleteUserDefinedFieldInfo(Int32)

Deletes the UserDefinedFieldInfo

Declaration

void DeleteUserDefinedFieldInfo(int userDefinedFieldInfoId)

Parameters

Type	Name	Description
Int32	userDefinedFieldInfoId	The identity of the UserDefinedFieldInfo

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

DetectColumnIdChanges(UDefType)

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

Declaration

bool DetectColumnIdChanges(UDefType ownerType)

Parameters

Type	Name	Description
UDefType	ownerType	The owner type

Returns

Type	Description
Boolean	Returns true if columnid changes where found. i.e. if data needs to be moved during publishing.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

DetectUnpublishedChanges(UDefType)

Detect changes to the admin version (unpublished)

Declaration

bool DetectUnpublishedChanges(UDefType ownerType)

Parameters

Type	Name	Description
UDefType	ownerType	The owner type

Returns

Type	Description
Boolean	Returns true if any changes were found. This includes cosmetic changes.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

FigureOutListIdFromListTableIdAndUDListDefinitionId(UserDefinedFieldInfo)

Kind of the reverse of SetListTableIdAndUDListDefinitionIdFromSelectedListId

Declaration

int FigureOutListIdFromListTableIdAndUDListDefinitionId(UserDefinedFieldInfo info)

Parameters

Type	Name	Description
UserDefinedFieldInfo	info

Returns

Type	Description
Int32

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetChangedPageOneFields(UDefType, Int32)

Gets which page one fields have changed from the current version

Declaration

bool[] GetChangedPageOneFields(UDefType ownerType, int userGroupId)

Parameters

Type	Name	Description
UDefType	ownerType	The user-defined field owner-entity.
Int32	userGroupId	Id of UserGroup

Returns

Type	Description
Boolean[]

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetCustomFieldInfo(String, String)

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

Declaration

FieldInfoBase GetCustomFieldInfo(string tableName, string fieldName)

Parameters

Type	Name	Description
String	tableName	The name of table that owns the custom fields. e.g. 'contact', 'person', 'project' etc.
String	fieldName	The name of the field: prog:id or field name. e.g. 'SuperOffice:21' or 'x_foobar'

Returns

Type	Description
FieldInfoBase	user-defined or extra field info. Describes default values, mandatory, visiblity, labels and choices.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetCustomFieldInfoList(String, Boolean)

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

Declaration

FieldInfoBase[] GetCustomFieldInfoList(string tableName, bool includeStandard)

Parameters

Type	Name	Description
String	tableName	The name of table that owns the custom fields. e.g. 'contact', 'person', 'project' etc.
Boolean	includeStandard	Include standard fields in result. Default false.

Returns

Type	Description
FieldInfoBase[]	Array of user-defined and extra field info in rank order. Describes default values, mandatory, visiblity, labels and choices.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetPublishedUserDefinedFieldFromFieldLabel(String, UDefType)

Return information about the given user defined field identified by the owner and the field label. Note that field labels are fuzzy. Leading and trailing spaces and punctuation are ignored.

Declaration

UserDefinedFieldInfo GetPublishedUserDefinedFieldFromFieldLabel(string fieldLabel, UDefType ownerType)

Parameters

Type	Name	Description
String	fieldLabel	The field label - the text label shown in the user interface. Trailing spaces and punctuation (":" and ".") are ignored when searching.
UDefType	ownerType	The user-defined field owner-entity id.

Returns

Type	Description
UserDefinedFieldInfo	Returns the user-defined field info carrier, or null if no matching field is found.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetPublishedUserDefinedFieldFromProgId(String, UDefType)

Return information about the given user defined field identified by the owner and the prog-id. The prog-id is used as the key in the entity carriers.

Declaration

UserDefinedFieldInfo GetPublishedUserDefinedFieldFromProgId(string progId, UDefType ownerType)

Parameters

Type	Name	Description
String	progId	The prog.id is a hidden name that uniquely identifies the field.
UDefType	ownerType	The user-defined field owner-entity id.

Returns

Type	Description
UserDefinedFieldInfo	Returns the user-defined field info carrier, or null if no matching field is found.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetPublishedUserDefinedFieldList(UDefType)

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

Declaration

UserDefinedFieldInfo[] GetPublishedUserDefinedFieldList(UDefType ownerType)

Parameters

Type	Name	Description
UDefType	ownerType	The user-defined field owner-entity id.

Returns

Type	Description
UserDefinedFieldInfo[]	Returns an array of user-defined field info carriers.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetPublishedUserDefinedPageOneFields(UDefType, Int32)

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

Declaration

UserDefinedFieldInfo[] GetPublishedUserDefinedPageOneFields(UDefType ownerType, int userGroupId)

Parameters

Type	Name	Description
UDefType	ownerType	The user-defined field owner-entity.
Int32	userGroupId	Id of UserGroup

Returns

Type	Description
UserDefinedFieldInfo[]	Returns an array of page one user-defined field info carriers.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetUserDefinedFieldFromFieldLabel(String, UDefType)

Return information about the given user defined field identified by the owner and the field label. Note that field labels are fuzzy. Leading and trailing spaces and punctuation are ignored. Note this may be different than the currently published fields.

Declaration

UserDefinedFieldInfo GetUserDefinedFieldFromFieldLabel(string fieldLabel, UDefType ownerType)

Parameters

Type	Name	Description
String	fieldLabel	The field label - the text label shown in the user interface. Trailing spaces and punctuation (":" and ".") are ignored when searching.
UDefType	ownerType	The user-defined field owner-entity id.

Returns

Type	Description
UserDefinedFieldInfo	Returns the user-defined field info carrier, or null if no matching field is found.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetUserDefinedFieldFromIds(Int32[])

Return an given array of user defined field identified by the ids.

Declaration

UserDefinedFieldInfo[] GetUserDefinedFieldFromIds(int[] ids)

Parameters

Type	Name	Description
Int32[]	ids	Array of user defined field ids

Returns

Type	Description
UserDefinedFieldInfo[]	Returns an array of user-defined field info carriers

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetUserDefinedFieldFromProgId(String, UDefType)

Return information about the given user defined field identified by the owner and the prog-id. The prog-id is used as the key in the entity carriers. Note this may be different than the currently published fields.

Declaration

UserDefinedFieldInfo GetUserDefinedFieldFromProgId(string progId, UDefType ownerType)

Parameters

Type	Name	Description
String	progId	The prog.id is a hidden name that uniquely identifies the field.
UDefType	ownerType	The user-defined field owner-entity id.

Returns

Type	Description
UserDefinedFieldInfo	Returns the user-defined field info carrier, or null if no matching field is found.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetUserDefinedFieldFromProgIds(String[], UDefType)

Return an given array user defined field identified by the owner and the prog-ids. The prog-id is used as the key in the entity carriers. Note this may be different than the currently published field layout.

Declaration

UserDefinedFieldInfo[] GetUserDefinedFieldFromProgIds(string[] progIds, UDefType ownerType)

Parameters

Type	Name	Description
String[]	progIds	The prog.id is a hidden name that uniquely identifies the field.
UDefType	ownerType	The user-defined field owner-entity id.

Returns

Type	Description
UserDefinedFieldInfo[]	Returns an array of user-defined field info carriers

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetUserDefinedFieldInfo(Int32)

Gets a UserDefinedFieldInfo object.

Declaration

UserDefinedFieldInfo GetUserDefinedFieldInfo(int userDefinedFieldInfoId)

Parameters

Type	Name	Description
Int32	userDefinedFieldInfoId	The identifier of the UserDefinedFieldInfo object

Returns

Type	Description
UserDefinedFieldInfo	UserDefinedFieldInfo

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetUserDefinedFieldList(UDefType)

Return information about all the user defined fields on a particular owner type (project, contact, person, etc). Note this may be different than the currently published fields.

Declaration

UserDefinedFieldInfo[] GetUserDefinedFieldList(UDefType ownerType)

Parameters

Type	Name	Description
UDefType	ownerType	The user-defined field owner-entity id.

Returns

Type	Description
UserDefinedFieldInfo[]	Returns an array of user-defined field info carriers.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

GetUserDefinedPageOneFields(UDefType, Int32)

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

Declaration

UserDefinedFieldInfo[] GetUserDefinedPageOneFields(UDefType ownerType, int userGroupId)

Parameters

Type	Name	Description
UDefType	ownerType	The user-defined field owner-entity.
Int32	userGroupId	Id of UserGroup

Returns

Type	Description
UserDefinedFieldInfo[]	Returns an array of page one user-defined field info carriers.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

IsAnyPublishEventActive()

Check if any publish events are active

Declaration

bool IsAnyPublishEventActive()

Returns

Type	Description
Boolean

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

IsPublishEventActive(UDefType)

Check if the publish event is active for the given type

Declaration

bool IsPublishEventActive(UDefType type)

Parameters

Type	Name	Description
UDefType	type

Returns

Type	Description
Boolean

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

Publish(UDefType)

Publish changed Udef fields for the given owner type

Declaration

int Publish(UDefType ownerType)

Parameters

Type	Name	Description
UDefType	ownerType	The owner type to publish for

Returns

Type	Description
Int32	Batch task id or 0 that handles publishing.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

Revert(UDefType)

Revert changed Udef fields for the given owner type - all unpublished changes will be lost

Declaration

void Revert(UDefType ownerType)

Parameters

Type	Name	Description
UDefType	ownerType	The owner type to revert fields for

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

SaveUserDefinedFieldInfo(UserDefinedFieldInfo)

Updates the existing UserDefinedFieldInfo or creates a new UserDefinedFieldInfo if the id parameter is empty

Declaration

UserDefinedFieldInfo SaveUserDefinedFieldInfo(UserDefinedFieldInfo userDefinedFieldInfo)

Parameters

Type	Name	Description
UserDefinedFieldInfo	userDefinedFieldInfo	The UserDefinedFieldInfo that is saved.

Returns

Type	Description
UserDefinedFieldInfo	New or updated UserDefinedFieldInfo

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

SaveUserDefinedFieldInfos(UserDefinedFieldInfo[])

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

Declaration

void SaveUserDefinedFieldInfos(UserDefinedFieldInfo[] infos)

Parameters

Type	Name	Description
UserDefinedFieldInfo[]	infos	An array of user defined fields

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

SetListTableIdAndUDListDefinitionIdFromSelectedListId(UserDefinedFieldInfo, Int32)

Make stuff similar to what happens in the win client

Declaration

UserDefinedFieldInfo SetListTableIdAndUDListDefinitionIdFromSelectedListId(UserDefinedFieldInfo info, int selectedListId)

Parameters

Type	Name	Description
UserDefinedFieldInfo	info
Int32	selectedListId

Returns

Type	Description
UserDefinedFieldInfo

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

SetPageOneFieldGrouping(UDefType, Boolean)

Sets the Page One Field grouping for a specific entity

Declaration

void SetPageOneFieldGrouping(UDefType ownerType, bool active)

Parameters

Type	Name	Description
UDefType	ownerType	The user-defined field owner-entity.
Boolean	active	If true, use grouping

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

SetPublishStartSystemEvent(UDefType)

Set the start flag for udef publishing. Must be called before PUBLISH, or PUBLISH will fail. Start flag is removed when publish process completes.

Declaration

void SetPublishStartSystemEvent(UDefType ownerType)

Parameters

Type	Name	Description
UDefType	ownerType	The user-defined field owner-entity.

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

SetRankOnFields(UDefType, Int32[])

Change rank of user defined fields

Declaration

void SetRankOnFields(UDefType ownerType, int[] rankedFieldsIds)

Parameters

Type	Name	Description
UDefType	ownerType	The user-defined field owner-entity.
Int32[]	rankedFieldsIds	All IDs of this owner-entity in desired rank order

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }

SetUserDefinedPageOneField(UDefType, Int32, Int32, Int32)

Sets a user defined fields as page one field.

Declaration

void SetUserDefinedPageOneField(UDefType ownerType, int udefFieldId, int userGroupId, int fieldLineNo)

Parameters

Type	Name	Description
UDefType	ownerType	The user-defined field owner entity
Int32	udefFieldId	The id of the udeffield to set as page one field
Int32	userGroupId	The usergroup id to associate the page one field with.
Int32	fieldLineNo	Page one line number

Examples

  using SuperOffice;
  using SuperOffice.CRM.Services;

  using (SoSession mySession = SoSession.Authenticate("user", "pass"))
  {
     using (UserDefinedFieldInfoAgent agent = new UserDefinedFieldInfoAgent())
     {
        // call methods on agent here...
     }
  }