WasIs Engine

From All n One's bxp software Wixi

Jump to: navigation, search

1 Overview

bxp has the ability to store a field by field change for a record. This change will capture any modifications a user makes to fields in a record and append those changes to the end of the comments for that record, ensuring that it is stored accurately in the contact history. The WasIs engine by default outputs the changes in a set XML like structure, but can be completely customisable to the users requirements.


2 Enabling the WasIs Engine

In order to enable the WasIs Engine, navigate the following system path

Main Menu > Form Management > Form - Primary management > Form - Advanced settings

Open the section JavaScript OnLoad. You will be presented with the JavaScript options of the form. The WasIs engine has two settings


1) WasIs Engine Enabled

2) WasIs Engine Output Format


WasIsEngineSettings.png


To enable the WasIS engine, change the field WasIs Engine Enabled to True. Once the field is set, anytime a user modifies a record the WasIs engine will record the change and add a log of all changes to the records contact history.


3 Adding Custom Output

If you want to set the WasIs engine output to be a customised one, type in the custom output format to the following field WasIs Engine Output Format. When you are deciding on the custom output you have the option of using the following replacements:-


  • --FieldId--  : This when used will be replaced with the strCDA_X_field_X_X id of the field
  • --FieldName-- : This when used will be replaced with the custom field mapping of the field
  • --ValueStart-- : This when used will be replaced with the value that was stored in the field when the record was presented on screen
  • --ValueEnd-- : This when used will be replaced with the value that was stored in the field when the user selects an outcome and clicks the Save Details button


When adding the custom replacements you must have at minimum --ValueStart--, --ValueEnd-- and one of the following --FieldId--/--FieldName--


WasIsEngineCustomReplacements.png


Example Custom Replacements


  • The field '--FieldId--' which translates to '--FieldName--' onLoad contained '--ValueStart--' and on submit contained '--ValueEnd--'
  • --FieldName-- onLoad contained '--ValueStart--' and on submit contained '--ValueEnd--'
  • --FieldId-- onLoad contained '--ValueStart--' and on submit contained '--ValueEnd--'
  • At the Start, the user had --ValueStart-- in the filed --FieldName-- and at the end the user had --ValueEnd--


4 Example Outputs

WasIs Structured Output (XML like)

WasIsEngineOutputStructured.png


WasIs Custom Output

WasIsEngineOutputCustom.png