WasIs Engine - Revision history

Philip Lacey at 13:46, 4 May 2015

2015-05-04T13:46:43Z

Philip Lacey at 15:27, 12 February 2015

2015-02-12T15:27:05Z

Philip Lacey at 15:26, 12 February 2015

2015-02-12T15:26:05Z

Patrick Jenkins: Created page with "== Overview == BeX has the ability to allow a form to keep a field by field change log for a record, this change log will capture any modifications a user makes to the field..."

2015-02-12T14:56:53Z

Created page with "== Overview == BeX has the ability to allow a form to keep a field by field change log for a record, this change log will capture any modifications a user makes to the field..."

New page

== Overview ==

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

== Enabling the WasIs Engine ==

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

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

Once you have navigated the system path above open the section '''JavaScript OnLoad''', once this section has been opened 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

[[File:WasIsEngineSettings.png]]

To enable the WasIS engine simply change the field ''WasIs Engine Enabled'' to '''True''', once the field is set any time a user modifies a record the WasIs engine will record the change and
add log all of the change to the records contact history.

== Adding Custom Output ==

If you want to set the WasIs engine output to be a customised one, you simply need to 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 to the user
* --ValueEnd-- : This when used will be replaced with the value that was stored in the filed when the agent 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--

[[File: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 agent had --ValueStart-- in the filed --FieldName-- and at the end the agent had --ValueEnd--

== Example Outputs ==

'''WasIs Structured Output (XML like)'''

[[File:WasIsEngineOutputStructured.png]]

'''WasIs Custom Output'''

[[File:WasIsEngineOutputCustom.png]]

← Older revision		Revision as of 13:46, 4 May 2015
Line 66:		Line 66:

	[[File:WasIsEngineOutputCustom.png]]		[[File:WasIsEngineOutputCustom.png]]
		+
		+
		+	[[Category:Module Specific:Form Management]]

@@ Line 53: / Line 53: @@
 * --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 agent had --ValueEnd--
+* At the Start, the user had --ValueStart-- in the filed --FieldName-- and at the end the user had --ValueEnd--

@@ Line 2: / Line 2: @@
-bxp has the ability to allow a form to keep a field by field change log for a record, this change log will capture any modifications a user makes to the fields in a record and append those changes to the end of the comments for a record,
+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.
 == Enabling the WasIs Engine ==
-In order to enable the WasIs Engine, you must first navigate the following system path
+In order to enable the WasIs Engine, navigate the following system path
 Main Menu > Form Management > Form - Primary management > Form - Advanced settings
-Once you have navigated the system path above open the section '''JavaScript OnLoad''', once this section has been opened you will be presented with the JavaScript options of the form.
+Open the section '''JavaScript OnLoad'''.  You will be presented with the JavaScript options of the form.
 The WasIs engine has two settings
@@ Line 26: / Line 25: @@
-To enable the WasIS engine simply change the field ''WasIs Engine Enabled'' to '''True''', once the field is set any time a user modifies a record the WasIs engine will record the change and
+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.
@@ Line 33: / Line 31: @@
 == Adding Custom Output ==
-If you want to set the WasIs engine output to be a customised one, you simply need to type in the custom output format to the following field ''WasIs Engine Output Format''.
+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
+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
+* --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 to the user
+* --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 filed when the agent selects an outcome and clicks the Save Details button
+* --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
@@ Line 55: / Line 53: @@
 * --FieldName-- onLoad contained '--ValueStart--' and on submit contained '--ValueEnd--'
 * --FieldId--  onLoad contained '--ValueStart--' and on submit contained '--ValueEnd--'
-* At the Start the agent had --ValueStart-- in the filed --FieldName-- and at the end the agent had --ValueEnd--
+* At the Start, the user had --ValueStart-- in the filed --FieldName-- and at the end the agent had --ValueEnd--