Portal Connector Widgets

This is the main landing page. Please select a category to begin.

Page Widgets

Explore widgets that enhance and structure portal pages. Includes grids, lists views, page exports, and visual components used throughout your site.

Form Widgets

Build dynamic, data-driven forms easily. Includes text inputs, lookups, dropdowns, repeaters, and advanced form-related controls.

Client API

Learn how to interact programmatically with the Portal Connector using JavaScript-based client-side APIs for advanced customization.

Support and Resources

This is the main landing page. Please select a category to begin.

Knowledge Base

This section contains a number of detailed “How to” guides related to The Portal Connector.

Release Notes

The Portal Connector Release Notes.

Welcome to the Form Widgets library! Here you’ll find all the tools you need to create powerful forms—from simple text fields to advanced lookups, workflows, and signature capture. Choose a widget below to see how it can be used in your portal forms.

Welcome to the Page Widgets library! These widgets help you shape the look and functionality of your portal pages—from displaying lists and grids to organizing content and adding navigational elements. Choose a widget below to explore what it can do.

This section contains documentation related to The Portal Connector MVC client-side API which can be used to leverage existing widget functionality. This version of the API makes use of the Kendo UI API (More information on that can be found here).

Working with the API

In order to begin working with the API in the first place, you will have to retrieve widgets to work with! There are a number of ways to retrieve widgets, including using the indexed form, the name of the form, and the find/findAll methods. Below you will find information on all the methods available within the TPC API.

tpc.forms

Params None Returns Array of TPC Form Objects

Returns an array of all TPC Form Objects on the page. The TPC Form Object provides access to all TPC Form Widgets within the TPC Form

                            
                                //Returns all TPC Form Objects
                                tpc.forms;

                                //Returns the first TPC Form Object in the Array
                                tpc.forms[0];

                                //Returns the TPC Form Object that belongs to the form named "formtest"
                                tpc.forms.formtest;

                                //Returns the TPCTextField Object within the first TPC Form Object
                                tpc.forms[0].firstname;

tpc.findAll()

Params None Returns Array of TPC Form Widget Objects

Returns an array of all TPC Form Widgets on the page.

                            
                                //Returns all TPC Form Widgets
                                tpc.findAll();

tpc.find()

Params String: The name of the widget object Returns TPC Form Widget Object

Returns a TPC Form Widget Object specified by name. (Which is typically the attribute that the widget has been configured to use)

                            
                                //Returns the TpcBoolean Object for the Widget named "donotphone"
                                tpc.find("donotphone");

tpc.isFormValid()

Params String: The name of the TPC Form Object
Boolean: Indicates whether or not to re-trigger the forms Kendo Validation (Optional) Returns Boolean: Indicating whether or not the form is valid (true) or invalid (false)

Returns a Boolean that indicates whether the specified TPC Form is valid or invalid.

                            
                                    /*Returns a Boolean indicating whether or not the "formtest" TPC Form
                                    is valid or invalid based on the current data. */
                                    tpc.isFormValid("formtest");

                                    /*Returns a Boolean indicating whether or not the "formtest" TPC Form is valid
                                    or invalid based on the current data, after an additional Kendo Validation has been triggered.*/
                                    tpc.isFormValid("formtest", true);

tpc.isFieldDirty()

Params String: The name of the TPC Form Field
String: The name of the TPC Form Object that contains the field (Optional) Returns Boolean: Indicating whether or not the field is dirty (true) or clean (false)

Returns a Boolean that indicates whether the specified field within a TPC Form has been changed or is the original value that was first loaded.

                            
                                    //Returns a Boolean indicating whether or not the "firstname" field within the "formtest" TPC Form is dirty.
                                    tpc.isFieldDirty("firstname", "formtest");

                                    //Returns a Boolean indicating whether or not the first "firstname" field found on any TPC Form is dirty.
                                    tpc.isFieldDirty("firstname");

tpc.getDirtyFields()

Params String: The name of the TPC Form Object (Optional) Returns Array of Dirty Field Information

Returns an Array of information containing all dirty fields within the specified TPC Form(s).

                            
                                    //Return an Array of all the dirty fields on the page
                                    var allDirtyFields = tpc.getDirtyFields();

                                    //Dirty Field Information
                                    var fieldName = allDirtyFields[0].field;
                                    var formName = allDirtyFields[0].form;
                                    var newValue = allDirtyFields[0].new;
                                    var oldValue = allDirtyFields[0].old;
                                    var tpcFormWidget = allDirtyFields[0].obj;

                                    //Returns an Array of all dirty fields within the TPC Form named formtest
                                    tpc.getDirtyFields("formtest");

(Event) tpc:ready

Params Function: The function to be executed once the tpc:ready event is triggered Returns Event: tpc:ready Event
Object: tpc Window Object

This event is triggered once all of the TPC Page and Form Widgets on a page have been initialized.


                                // Listen for tpc:ready Event
                                $(document).on("tpc:ready", function (event, tpcObject) {
                                  console.log("All TPC Widgets have been Initialized");

                                  console.log(event);     // tpc:ready Event
                                  console.log(tpcObject); // TPC Window Object
                                });

This section contains a number of detailed “How to” guides related to The Portal Connector. For instance, there are guides for particularly extensive parts of The Portal Connector such as the FetchXML builder, the filters tab, or the column editor. There are also a number of guides for system-related tasks not directly related to working with The Portal Connector, for example, accessing the TPC error log, setting up open authentication, or making use of the saved queries feature.

Release Notes Page This section contains documentation related to Portal Connector widgets...

Patch Notes Page This section contains documentation related to Portal Connector widgets...