EventData - SuperOffice

Gives you access to contextual information in an event handler. For example, the name of a created company or the amount of a sale. You can also check EventData properties after the event handler has run, to for example display a message or prevent an entity from being saved.

Constructors

EventData()

EventData

Initializes a new instance of the EventData class.

Methods

getBlockExecution()

Checks whether the current event action has been blocked.

Bool getBlockExecution()

Returns: CRMScript.Global.Bool

getInputValue(String)

Returns the value of a specified input field (for example “ContactEntity.Department”).

String getInputValue(String field)

Returns: CRMScript.Global.String - The value of the field.

Use Trace to discover the name of the input value you want to fetch.

Example:

EventData ed = getEventData();
Integer projectId = ed.getInputValue("ProjectEntity.ProjectId").toInteger();
Bool isCompleted = ed.getInputValue("ProjectEntity.Completed").toBool();

getInputValues()

Returns a Map containing all input values of the EventData object.

Map getInputValues()

Returns: CRMScript.Native.Map - All input values of the object. Example:

EventData ed = getEventData();
Map m = ed.getInputValues();
m.first();
while (!m.eof()){
  printLine(m.getKey() + " = " + m.getVal());
  m.next();
}

getMessage()

Returns the message set in an EventData object.

String getMessage()

Returns: CRMScript.Global.String - The message set in the object. Example:

EventData ed = getEventData();
printLine(ed.getMessage());

getNavigateTo()

Returns the section EventData has navigated to.

String getNavigateTo()

Returns: CRMScript.Global.String

getStateValue(String)

Returns the value of a specified state field (custom field).

String getStateValue(String stateValue)

Returns: CRMScript.Global.String

getStateValues()

Returns a Map containing all state values of the EventData object (custom values).

Map getStateValues()

Returns: CRMScript.Native.Map

getType()

Returns the integer representing the event type.

Integer getType()

Returns: CRMScript.Global.Integer Example:

EventData ed = getEventData();
printLine(ed.getType().toString());

setBlockExecution(Bool)

Prevent the current event action from being executed.

Void setBlockExecution(Bool value)

Returns: CRMScript.Global.Void

setMessage(String)

Displays a dialog box containing the specified message.

Void setMessage(String message)

Returns: CRMScript.Global.Void Example:

EventData ed = getEventData();
String orgNr = ed.getInputValue("ContactEntity.OrgNr");
if(orgNr.isEmpty()) {
  ed.setMessage("Please type an Org.Nr");
}

setNavigateTo(String)

Sets which page to load next. For example, “sale.main”.

Void setNavigateTo(String url)

Returns: CRMScript.Global.Void Example:

EventData ed = getEventData();
ed.setNavigateTo("soprotocol:sale.document?document_id=0");

setOutputValue(String,String)

Sets the value of a specified output field (for example “ContactEntity.Department”).

Void setOutputValue(String name, String value)

Returns: CRMScript.Global.Void Example:

Integer newOrgNr = 987654321;
EventData ed = getEventData();
ed.setOutputValue("ContactEntity.OrgNr", newOrgNr);

setStateValue(String,String)

Sets a state value that can be accessed later, also by other EventData objects in the same script (custom value).

Void setStateValue(String stateName, String val)

Returns: CRMScript.Global.Void

setValidationMessage(String)

A shorthand for calling setBlockExecution(true) and setMessage(message). It allows you to block a save and set a response message in a single function call.

Void setValidationMessage(String message)

Returns: CRMScript.Global.Void Example:

EventData ed = getEventData();
if(ed.getInputValue("x_invoice_no.value") == "") {
  getHtmlElement("x_invoice_no").setErrorMessage("Error");
  ed.setBlockExecution(true);
}
String orgNr = ed.getInputValue("ContactEntity.OrgNr");
if(orgNr.isEmpty()) {
  ed.setValidationMessage("Please type in a Org.Nr");
}
else if(!orgNr.isDigit() || orgNr.getLength() != 9) {
  // ...
}

showDialog(EventDataDialogDefinition)

Triggers a dialog to handle user input.

Void showDialog(EventDataDialogDefinition dialog)

Returns: CRMScript.Global.Void

​Constructors

​EventData()

​Methods

​getBlockExecution()

​getInputValue(String)

​getInputValues()

​getMessage()

​getNavigateTo()

​getStateValue(String)

​getStateValues()

​getType()

​setBlockExecution(Bool)

​setMessage(String)

​setNavigateTo(String)

​setOutputValue(String,String)

​setStateValue(String,String)

​setValidationMessage(String)

​showDialog(EventDataDialogDefinition)

Constructors

EventData()

Methods

getBlockExecution()

getInputValue(String)

getInputValues()

getMessage()

getNavigateTo()

getStateValue(String)

getStateValues()

getType()

setBlockExecution(Bool)

setMessage(String)

setNavigateTo(String)

setOutputValue(String,String)

setStateValue(String,String)

setValidationMessage(String)

showDialog(EventDataDialogDefinition)