399
edits
Changes
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..."
== 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]]
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]]