Customer - SuperOffice

Represents a customer.

Constructors

Customer()

Customer

Initializes a new instance of the Customer class.

Methods

addEmail(String,Integer,Integer)

Adds an email to a customer.

Void addEmail(String email, Integer extTable, Integer dbiAgentId)

Returns: CRMScript.Global.Void

Commonly used in database integrations.Use addEmail(String,Integer,Integer,Integer) to provide the external sorting rank.

addEmail(String,Integer,Integer,Integer)

Adds an email to a customer with the external sorting rank.

Void addEmail(String email, Integer externalRank, Integer extTable, Integer dbiAgentId)

Returns: CRMScript.Global.Void

Commonly used in database integrations.

checkFieldRights(String,String)

Checks if the current user has access to the field.

Bool checkFieldRights(String field, String fieldRight)

Returns: CRMScript.Global.Bool - True if the current user has access to the field; otherwise, false. Example:

Customer c;
c.load(3);
Bool b = c.checkFieldRights("person","read");
print(b.toString());

checkTableRights(String)

Use this function to see if the current user has access to this customer.

Bool checkTableRights(String tableRight)

Returns: CRMScript.Global.Bool - True if the current user has access to the customer; otherwise, false. Example:

Customer c;
c.load(3);
Bool b = c.checkTableRights("select");
print(b.toString());

findExternallyFromEmail(String)

Finds an entry in the external database based on an email address.

Bool findExternallyFromEmail(String email)

Returns: CRMScript.Global.Bool - True if an entry is found; otherwise, false.

It will search all external data sources for a Customer matching the given email address. If an entry is found, a proxy entry is created and saved.Use findExternallyFromEmail(String,Integer) to provide an extTable ID to limit the search to 1 data source.

findExternallyFromEmail(String,Integer)

Finds an entry in the external database based on an email address and an extTable ID to limit the search to one data source.

Bool findExternallyFromEmail(String email, Integer extTable)

Returns: CRMScript.Global.Bool - True if an entry is found; otherwise, false.

It will search all external data sources for a Customer matching the given email address. If an entry is found, a proxy entry is created and saved.

findExternallyFromKey(Integer,String)

Finds an external entry based on its primary key and table ID.

Integer findExternallyFromKey(Integer table, String key)

Returns: CRMScript.Global.Integer - True if found; otherwise, false.

Searches for and possibly creates a proxy entry for an external entry based on the external table (implicitly defines data source), and the primary key.If an proxy entry already exists, it is loaded. If not, the given external data source is searched, and if an entry is found, a local proxy entry is created and saved.

findFromAgentAndKey(Integer,String)

Finds a customer entry in the database based on the given agent ID and external key.

Integer findFromAgentAndKey(Integer agent, String key)

Returns: CRMScript.Global.Integer - The ID for the customer entry in the database; or -1 if not found.

findFromCellphone(String)

Finds an entry based on the cellphone.

Bool findFromCellphone(String cellphone)

Returns: CRMScript.Global.Bool - True if found; otherwise, false.

findFromEmail(String)

Find a Customer instance based on the email address.

findFromEmail(String email)

Returns: CRMScript.Global.Bool - True if found; otherwise, false.

getValue(String)

Returns the value of the given field of the customer.

String getValue(String colName)

Returns: CRMScript.Global.String - The value of colName.

Available fields:

id
name The name of the customer.
firstname
lastname
phone
cellphone
note
username: This is the username used for the external web.
password: This field is deprecated from v10.2.5. Empty string will be returned. Use authenticateCustomer() instead.
email: A list of all email addresses.
mainEmail: The main email address.
language: The name, languagecode or ID of the customers language.
deleted
company: The ID of the related company
display_company: The value showing the name of the related company.
dbi_agent_id
dbi_key
dbi_last_modified
dbi_last_syncronized These values are for database integration
priority: The id or name of the customers priority.
our_contact: The username, loginname or ID of the related contact (user).
x_*: The extrafield with the given database field name.[extra field] The extrafield with the given name (for example, “Country”).

Example:

Customer c;
c.load(3);
Bool b = c.checkTableRights("select");
print(b.toString());
c.setValue("name", "Test");
print(c.getValue("name"));

load(Integer)

Loads the customer with the given ID.

Bool load(Integer id)

Returns: CRMScript.Global.Bool - True if the customer exists; otherwise, false. Example:

Customer c;
print(c.load(3));

loadFromAgentAndKey(Integer,String)

Loads a customer based on agent id and external key.

Bool loadFromAgentAndKey(Integer agent, String key)

Returns: CRMScript.Global.Bool - True if operation was successful; false if the customer does not exist.

Loading might overwriting existing values.

Creates a valid login session for the current customer.

Void login()

Returns: CRMScript.Global.Void

Use getValue(“loginSessionKey”) to get the actual session key created.Use logout() to kill the session.

logout()

Logs out a customer.

Void logout()

Returns: CRMScript.Global.Void

makeSalutation()

Creates a salutation greeting the customer.

String makeSalutation()

Returns: CRMScript.Global.String - A salutation string.

Can be used in the beginning of a document or email.

Example:

Customer c;
c.load(3);
Bool b = c.checkTableRights("select");
print(b.toString());
c.setValue("name", "Test");
c.setValue("salutation", "Welcome to SuperOffice");
c.makeSalutation();

removeEmail(String)

Removes the email address from the customer.

Void removeEmail(String email)

Returns: CRMScript.Global.Void

For the action to take place, you must save().

removeExternalEmails(Integer,Integer)

Removes all external emails from a given source (extTable).

Void removeExternalEmails(Integer p_0, Integer p_1)

Returns: CRMScript.Global.Void

Used with set() to make sure emails deleted from the external source is deleted.

save()

Saves a customer. If ID is set, the customer will be updated. Otherwise, a new customer entry will be created.

Integer save()

Returns: CRMScript.Global.Integer - The ID of the saved customer.

Use save(String) to provide the source key of the StoreAndProcess consent.

save(String)

Saves a customer with the source key of the StoreAndProcess consent. If ID is set, the customer will be updated. Otherwise, a new customer entry will be created.

Integer save(String gdprSourceKey)

Returns: CRMScript.Global.Integer - The ID of the saved customer.

setValue(String,String)

Sets the given field with the given value.

Void setValue(String field, String value)

Returns: CRMScript.Global.Void

Available fields:

name or display_name: The name of the customer.
firstname
lastname
title (From 7.x)
mrmrs (From 7.x)
year_of_birth (From 7.x)
month_of_birth (From 7.x)
day_of_birth (From 7.x)
birth_date (From 7.x)
person_number (From 7.x)
post1 (From 7.x)
post2 (From 7.x)
post3 (From 7.x)
salutation (From 7.x)
middleName (From 7.x)
phone
direct/formattedNumber: Same as phone(From 7.x)
phone/formattedNumber: Same as phone (From 7.x)
cellphone
mobile/formattedNumber: Same as cellphone (From 7.x)
note
infoText: Same as note. (From 7.x)
username: This is the usedname used for the external web.
password: This is the password used for the external web.
email or display_email: Adds an email to the customer (does not erase existing ones).
company: The ID of the related company
display_company: The value showing the name of the related company.
deleted
dbi_agent_id
dbi_key
dbi_last_modified
dbi_last_syncronized: These values are for database integration
priority or priority_id: The id or name of the customers priority.
language: The name, languagecode or ID of the customers language.
ourContact: The username, loginname or ID of the related contact (user).
x_* The extrafield with the given database field name.
[extra field] The extrafield with the given name (for example, “Country”).

Example:

Customer c;
c.load(3);
Bool b = c.checkTableRights("select");
print(b.toString());
c.setValue("name", "Test");
print(c.getValue("name"));

toParser(Parser)

Fills a Parser object with a Customer’s values, including extra fields. The fields are prefixed with “customer.”.

Void toParser(Parser parser)

Returns: CRMScript.Global.Void

Consecutive calls will overwrite (rather than append) the values in the Parser instance.

​Constructors

​Customer()

​Methods

​addEmail(String,Integer,Integer)

​addEmail(String,Integer,Integer,Integer)

​checkFieldRights(String,String)

​checkTableRights(String)

​findExternallyFromEmail(String)

​findExternallyFromEmail(String,Integer)

​findExternallyFromKey(Integer,String)

​findFromAgentAndKey(Integer,String)

​findFromCellphone(String)

​findFromEmail(String)

​getValue(String)

​load(Integer)

​loadFromAgentAndKey(Integer,String)

​login()

​logout()

​makeSalutation()

​removeEmail(String)

​removeExternalEmails(Integer,Integer)

​save()

​save(String)

​setValue(String,String)

​toParser(Parser)

Constructors

Customer()

Methods

addEmail(String,Integer,Integer)

addEmail(String,Integer,Integer,Integer)

checkFieldRights(String,String)

checkTableRights(String)

findExternallyFromEmail(String)

findExternallyFromEmail(String,Integer)

findExternallyFromKey(Integer,String)

findFromAgentAndKey(Integer,String)

findFromCellphone(String)

findFromEmail(String)

getValue(String)

load(Integer)

loadFromAgentAndKey(Integer,String)

login()

logout()

makeSalutation()

removeEmail(String)

removeExternalEmails(Integer,Integer)

save()

save(String)

setValue(String,String)

toParser(Parser)