Library: VoltMXObjects

Classes for integrating with Volt MX Foundry from Pre/Postprocessors and Integration Services

Library Summary

Script Creator Paul Withers
Uses Library ../libs/VoltScriptCollections
Uses VSE JsonVSE

Script Creator	Paul Withers
Uses Library	../libs/VoltScriptCollections
Uses VSE	JsonVSE

Name	Type	Comment
`Public PROJECT_DIR`	`As String`	Main directory of the project, required because CurDir returns the VoltScript program directory. Use this to retrieve resource files within the project directory, and set manually for unit tests.
`Public VoltMxLogger`	`As VoltMxLoggerObject`	Instance of VoltMxLogger object created by extractObjects. This is used to pass debug messages for Java logging.
`Public VoltMxRequest`	`As VoltMxRequestObject`	Instance of VoltMxRequestObject parsed from Foundry input by extractObjects.
`Public VoltMxResponse`	`As VoltMxResponseObject`	Instance of VoltMxResponseObject parsed from Foundry input by extractObjects.
`Public VoltMxResult`	`As VoltMxResultObject`	Instance of VoltMxResultObject parsed from Foundry input by extractObjects.
`Public VoltMxSession`	`As VoltMxSessionObject`	Instance of VoltMxSessionObject parsed from Foundry input by extractObjects.

HttpCookie	Class to hold properties of a HTTP Cookie for easy handling. Not implemented yet.
jsonComparator	This class is used by the jsonSort class to compare two JSON objects based on the labels and sort orders provided.
jsonSortLabels	This class is used to store the labels, sort order, and delimiter for the jsonSort class. The class is used by the jsonSort class to sort the JSON objects.
VoltMxLoggerObject	Class for passing debug messages back to Foundry's Java logger.
VoltMxRequestObject	Class for interacting with Foundry request.
VoltMxResponseObject	Class for interacting with Volt MX response.
VoltMxResultObject	Class for passing content back to Foundry and manipulating results from an integration service in its postprocessor.
VoltMxSessionObject	Class for interacting with Foundry session content.

`getErrorMsg(prefix As String) As String`
`jsonSort(dataObj As JsonObject, lbl1 As String, lbl1Desc As Boolean, lbl2 As String, lbl2Desc As Boolean, lbl3 As String, lbl3Desc As Boolean, delim As String) As JsonObject`
`extractObjects(data As String, isPreprocessor As Boolean)`

Public Function getErrorMsg(prefix As String) As String
Converts an Error object to error code, message, line and stack trace
idx	Argument	Data Type	Attributes	Comments
1	prefix	String		Prefix to prepend to the outputted error message

Code Sample
'The following code is the Foundry boilerplate: Dim ctx as New Context() Dim data as String Try data = ctx.Context Call extractObjects(data, false) '************** 'START OF FOUNDRY HANDLER '************ '************ 'END OF FOUNDRY HANDLER '************** Catch Call VoltMxResult.setErrorMessage(getErrorMsg("VOLTSCRIPT_CONNECTOR: ")) Finally Print VoltMxResult.toJson().toString(false) End Try

Public Function jsonSort(dataObj As JsonObject, lbl1 As String, lbl1Desc As Boolean, lbl2 As String, lbl2Desc As Boolean, lbl3 As String, lbl3Desc As Boolean, delim As String) As JsonObject
Given an array of JSON objects, returns a sorted array of JSON objects. Uses VoltScript Collections internally as a dependency.
idx	Argument	Data Type	Attributes	Comments
1	dataObj	JsonObject		JSON Object to be sorted
2	lbl1	String		First label on which to sort
3	lbl1Desc	Boolean		True if the first sort should be Descending, False if Ascending
4	lbl2	String		Second label on which to sort. Optional.
5	lbl2Desc	Boolean		True if the second sort should be Descending, False if Ascending
6	lbl3	String		Third label on which to sort. Optional.
7	lbl3Desc	Boolean		True if the third sort should be Descending, False if Ascending
8	delim	String		The delimiter used by label paths. If not provided, delim will default to "/"

Code Sample
Dim parser as New JsonParser() Dim dataobj as New JsonObject(true), sortedobj as JsonObject() Dim fpath as String fpath = CurDir() & "/myJSONData.json" Try Call parser.loadFromFile(fpath) Set dataObj = parser.getRootObject() If dataobj Is Nothing Then Print "Error: Unable to parse file " & fpath Exit Function End If Set sortedobj = jsonSort(dataObj, "company", False, "address/state", False, "address/city", False, "/") Catch Print "Error " & Error() & " on line " & Erl() End Try

Public Sub extractObjects(data As String, isPreprocessor As Boolean)
idx	Argument	Data Type	Attributes	Comments
1	data	String		JSON string input from Foundry
2	isPreprocessor	Boolean		Whether Foundry object is from a preprocessor

Code Sample
'The following is the Foundry boilerplate code: Dim ctx as New Context() Dim data as String Try data = ctx.Context Call extractObjects(data, false) '************** 'START OF FOUNDRY HANDLER '************ '************ 'END OF FOUNDRY HANDLER '************** Catch Call VoltMxResult.setErrorMessage(getErrorMsg("VOLTSCRIPT_CONNECTOR: ")) Finally Print VoltMxResult.toJson().toString(false) End Try

Library VoltMXObjects