ExtraFieldsInfo - SuperOffice

With this class, you can retrieve meta-information about an extra field. The class will only retrieve information, thus it is not possible to change an extra field from this class.

Constructors

ExtraFieldsInfo()

ExtraFieldsInfo

Initializes a new instance of the ExtraFieldsInfo class.

Methods

eof()

Checks if there are no more fields in the result.

Bool eof()

Returns: CRMScript.Global.Bool Example:

ExtraFieldsInfo efi;
for (efi.getTicketChildrenFields(); !efi.eof(); efi.next())
{
  // do something with information from efi
}

getChildrenFields(Integer,Integer)

Loads extra fields of the type given in the first parameter. If the type is an extra table relation, the second pointer is the ID of the extra table it points to.

Void getChildrenFields(Integer type, Integer extraTableTarget)

Returns: CRMScript.Global.Void

Unless type is 20 (extratable), the second parameter won’t do anything.Types can be:Integer = 1, Text (long) = 2, Date = 3, DateTime = 4, Time = 5, Bool = 6, TimeSpan = 7, Text (short) = 10, Customer relation = 16, Company relation = 17, Ticket relation = 18, User relation = 19, Extra table relation = 20, Attachment relation = 22, Link = 23, Category relation = 24, Priority relation = 25, FAQ relation = 26

getCompanyChildrenFields()

This is a helper function for getting company relation fields. It is equivalent to calling getChildrenFields(17, 0).

getCompanyChildrenFields()

Returns: CRMScript.Global.Void

getCustomerChildrenFields()

This is a helper function for getting customer relation fields. It is equivalent to calling getChildrenFields(16, 0).

Void getCustomerChildrenFields()

Returns: CRMScript.Global.Void

getDisplayField()

Returns the display field of the current field.

String getDisplayField()

Returns: CRMScript.Global.String

The display field is a format of the field that can be used to address the field in functions such as SearchEngine.

Example:

ExtraFieldsInfo e;
e.getExtraFields("person");
print(e.getDisplayField());

getExtraFields(String)

Gets extra fields related to the given table. Using this method will make it possible to access the information in the extra fields by using the other functions in the class.

Void getExtraFields(String table)

Returns: CRMScript.Global.Void Example:

ExtraFieldsInfo e;
e.getExtraFields("person");

getFieldName()

Returns the field name of the current field.

String getFieldName()

Returns: CRMScript.Global.String - The field name of the current field. Example:

ExtraFieldsInfo e;
e.getExtraFields("person");
while(!e.eof()){
  print(e.getFieldName());
  e.next();
}

getFlags()

Returns the flags for the current extra field. The flags can be accessed by wrapping the returned Integer in a FHBitSet.

Integer getFlags()

Returns: CRMScript.Global.Integer

Flag	Description
0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20	The field is viewed in relational searches
21	The field listed with the other main properties for the entity (i.e. for ‘Edit ticket’ it is shown on the first pane)
22	The field is a FK, and in Archives this relation should be followed and columns in the target table should be available in the archive

Example:

FHBitSet flags;
flags.set(extraField.getFlags());
flags.getBitNo(17);  // returns true if the extra field cannot be empty

getName()

Returns the descriptive name (not the database name) of the current field.

String getName()

Returns: CRMScript.Global.String Example:

ExtraFieldsInfo e;
e.getExtraFields("person");
while(!e.eof()) {
  print(e.getName());
  e.next();
}

getParam(String,String)

This function returns the value of the given parameter.

String getParam(String parameter)

Returns: CRMScript.Global.String

Available values:

Variable	Available to	Description
defaultNow	all types	use current time and date as default value
defaultActiveUser	all types	use active user as default value
fields	TimeSpan	number of fields
height	Text long
linkName	Dynamic link
linkValue	Dynamic link	url
onlyLeafNode	Extra table relation
precision	Float	number of decimals
option	Text long, Text short
useDays	TimeSpan
useHours	TimeSpan
useMinutes	TimeSpan
useTextArea	Text long
targetLabel	Contact relation, Company relation, Request relation, Extra table relation	header

getTableName()

Returns the name of the table the current field belongs to.

String getTableName()

Returns: CRMScript.Global.String - The table the current field belongs to. Example:

ExtraFieldsInfo e;
e.getExtraFields("person");
print(e.TableName());
Will print "person".

getTicketChildrenFields()

This is a helper function for getting ticket relation fields. It is equivalent to calling getChildrenFields(18, 0).

Void getTicketChildrenFields()

Returns: CRMScript.Global.Void

next()

This function moves to the next field in the result.

Void next()

Returns: CRMScript.Global.Void

A common usage is in the increment section in a for loop.

Example:

ExtraFieldsInfo efi;
for (efi.getTicketChildrenFields(); !efi.eof(); efi.next())
{
  // do something with information from efi
}

​Constructors

​ExtraFieldsInfo()

​Methods

​eof()

​getChildrenFields(Integer,Integer)

​getCompanyChildrenFields()

​getCustomerChildrenFields()

​getDisplayField()

​getExtraFields(String)

​getFieldName()

​getFlags()

​getName()

​getParam(String,String)

​getTableName()

​getTicketChildrenFields()

​next()

Constructors

ExtraFieldsInfo()

Methods

eof()

getChildrenFields(Integer,Integer)

getCompanyChildrenFields()

getCustomerChildrenFields()

getDisplayField()

getExtraFields(String)

getFieldName()

getFlags()

getName()

getParam(String,String)

getTableName()

getTicketChildrenFields()

next()