Custom EzTPV System

At a high level, this system allows clients to define custom scripts in eztpv for sales agents to fill in that don't require energy products like loans and such. The system provides a similar interface for building the scripts via the existing Script Builder and is integrated into EzTPV and can be configured with many of the same options as energy products.

Defining Custom EzTPV Scripts

To create the script simple choose the Custom EzTPV script type when creating a new script as normal. The script question interface is similar to normal scripts just with some options that aren't relevant removed like allowing good sales, exit reasons and loops. The resolution is used to both describe the input requirement and determine if a question will be displayed. Only one of the supported input directives can be used per question, if more than one is defined only the last one processed will actually be displayed. If it is determined the question should not be displayed then the variable RETURN should be set to false. If you don't assign a value to RETURN (or you set it to true) then the question will be displayed.

// Setting the RETURN variable to false so the question won't be displayed
{
    "VAR": "RETURN", "IS": false
}

All of vscript is available for use in resolutions except where noted in the documentation (only some Input Directives aren't supported.) The LOOKUP directive also accepts and processes custom variable a little differently here. To access a custom variable you simply leave the custom. part off:

// looking at a custom variable
{
    "LOOKUP": "favorite_color"
}

When defining your input requirements only custom variables as shown above are supported by the input directives. Here's an example using the CHOOSE directive:

{
    "CHOOSE": {
        "options": [
            {
                "text": "Blue",
                "value": "blue"
            },
            {
                "text": "Green",
                "value": "green"
            },
            {
                "text": "Red",
                "value": "red"
            }
        ],
        "variable": "favorite_color",
    }
}

When a choice is selected the custom variable "favorite_color" will be set to whatever option was chosen.

Caveats

Some normal LOOKUP variables are supported but because of the nature of this process not all are relevant and won't be supported at all. Variables that aren't specific to Energy enrollments and aren't normally defined at the product level should work but are untested. It is recommended to stick with using custom field variables as much as is possible.

Configuring EzTPV

This is configured just as regular EzTPV is through Vendor Offices. To enable simply change the "Type of Enrollments" setting to "Custom" and choose a "Custom Enrollment Script".