Licensing

Clients must ensure they are appropriately licenses in order to use this package. Organisations who wish to use this package are required to establish a commercial relationship with the 3rd party directly.

Compatibility

This package has the following compatibility requirements:

Installation Instructions

To install this package please walk through the following proceedure:

1. Unzip the package to a directory on your computer
2. Import each zip archive found in the services folder to Transact Manager under the Services >> All Services menu item.
3. Open the ClickSWITCH - Enroll Customer service and configure the Institution ID as provided by ClickSWITCH.
4. Review the Help Doc tab for each of the imported services and make any required adjustments to service parameters.
5. Configure any required Service Connections. These requirements can be found at the bottom of this document or in the Help Doc for each of the imported services.

   Service Connections can be configured in Transact Manager under the Services >> Service Connections menu item.

6. Import each archive found in the libraries folder to Maestro.

   Importing these into the Organisation level libraries folder is recommended as this will make the components available to all projects, however they can be imported at the Project level if required.

Usage Instructions

Ideally the ClickSWITCH process should be presented on the Submission Confirmation modal page that is presented following a successful product application. The ClickSWITCH integration is a 2 step process:

1. Opt In: The option to use the ClickSWITCH service is presented to the customer. The ClickSWITCH Enroll Customer button provided can be used as the opt in button. When the button is fired, the customer data is sent to ClickSWITCH and their account details are configured. A unique reference code is provided for use in the next step.
2. Launch ClickSWITCH: Upon a successful enrolment, the customer may be presented with instructions on how to login to the ClickSWITCH Portal. The ClickSWITCH Reference Code and Portal URL (both returned from the customer enrolment service) will be required to achieve this. E.g.:

   Your ClickSWITCH account is ready! Just click the login link, enter your reference code and follow the instructions.
   
   ClickSWITCH Login
   Your reference code is UIBVEX6S

To configure the ClickSWITCH Enroll Customer component, please walk through the following procedure:

1. Open your form in Maestro and drag and drop the field called ClickSWITCH Enroll Customer from the Palette.
2. On the Properties tab of the field under Configuration section, click on Input Field Mapping to map your form's fields to the matching request keys.

   Please note - You must map all the mandatory fields as defined in the Inputs for the customer enrolment service.

   The service also supports multiple accounts by providing comma separated values in the Account input fields. For example, to pass multiple account numbers from a repeat you could use a data field with a script similar to this:

       var arrAccountNumber = Form.getRepeatData("Form.data.accountRepeat.accountNumber", data);
       if (arrAccountNumber !== undefined ) {
         return arrAccountNumber.join();
       }

3. On the Properties tab of the field under Configuration section, click on Response Field Mapping to map the response fields switchTrackCode, portalUrl, executionStatus and errorMessage to data fields on your form. Use these values in the instructions you provide to the customer for launching the ClickSWITCH Portal.

This is provided to support use of ClickSWITCH test environments in non-production usage scenarios. The URLs can be configured in the service parameters.

Links

• ClickSWITCH Website
• ClickSWITCH API Reference

Release Notes

Version 1.0 May 31, 2017

• Baseline release.