The following outlines how to build a custom event registration form to be used with EXi Events. If you have an EXi Events license, Jenzabar-provided event registration form templates and datasources are automatically imported with the installer if you wish to use them.
Click here for more information on the provided event registration form templates.
The following needs to be set up to ensure your event registration form is working correctly:
Step 1: Make sure JICS is connected to EXi using the EXiApiRoot
Adding the EXiApiRoot to your campus portal's ERP Settings allows for features or modules in the campus portal and EXi to communicate and correctly map data from one application to the other.
Log into the campus portal as an administrator.
From the profile drop-down options, select Site Manager. Example. The Site Manager page appears and displays the Site Settings tab.
Next to Framework settings, click Edit.
From the Select a Category drop-down, select ERP. The Category: ERP settings page appears.
In the EXiApiRoot field, enter the correct EXiApiRoot. Example
|
To get your school's EXiApiRoot, take your school's EXi URL and add /api to the end of the URL. For example, if your school's EXi URL is http://AnywhereUniversity.net/EXi, the EXiApiRoot will be http://AnywhereUniversity.net/EXi/api |
Click Save.
Step 2: Set up your Database Connections
Any database connections you set up are available to all forms within any FormFlow or Workflow instance in your campus portal. |
Database connections let you exchange information between your form and the EX database, a custom ICS NET table, or your own custom table. Database connections use ODBC connection strings. When EX and the campus portal are installed, an EX database connection is created for you based on your campus portal Site Manager settings. Jenzabar recommends verifying the connection string before using the form, and deleting, updating, or creating different connections as needed. If you import a form and no database exists, the portlet will create a database but will not provide a connection string. An administrative user will have to manually update the connection string.
Using
a standard ODBC connection string to SQL Server requires that
TLS 1.0 be enabled on the server. Some security standards require
that TLS 1.0 and TLS 1.1 be disabled on the server and force the
use of TLS 1.2.
Connection strings with the driver set to “SQL Server” will not work when connecting to a server with TLS 1.0 disabled. To fix the issue and ensure compatibility moving forward, the connection string driver should be updated to reflect the current version of SQL Server Native Client that is installed on the JICS web server. An example connection string is below:
DRIVER={SQL Server Native Client 12.0};SERVER=myserver;UID=te_pgmr;PWD=password;DATABASE=TmsePrd;Application Name=EX FormFlow - Forms;
NOTE: This currently only impacts customers that have the requirement to disable TLS 1.0. However, it is recommend that all clients follow this practice to avoid compatibility issues moving forward. |
Ensure the user specified in the database connection string has permission to access the objects defined in your data sources, mapped statements, or stored procedures. |
|
Jenzabar creates the default EX connection string for your school based on your school's campus portal Site Manager, Site Settings, Framework Settings, and ERP. You can then verify the connection string using the Databases page. |
The database connection is specific to EX FormFlow and not a specific form. Additionally, the database connections you access through the Workflow feature are the same as those accessed through FormFlow - Forms. This means you do not need to set up a database connection for every feature or form; the connection will be available for any forms and feature instances you create. |
Recommended Practice: Instead of using your school's SA credentials, create a generic FormFlow - Forms user account or use a dedicated service account such as ICSNetUser to access the data. This user account will need to be granted the appropriate permissions to the database tables and other database objects used regularly. TE_PGMR can be used, but if the TE_PGMR password changes, your team may forget to make the update in FormFlow - Forms and the database connection will no longer work.
1. Log in to the campus portal as an administrator and access EX FormFlow - Forms.
2. Click Manage Forms. The Manage Forms page appears.
3. Access the Database page:
o Click Site Administrators. When the Site Administrators page appears, click Databases.
OR
o Click on the name of the form you are working with. When the form appears, select Databases from the Tools menu.
4. From the Database drop-down, select your EX database.
5. Verify the connection string is valid and follows your school's internal best practices.
6. Click Save database.
7. Click Done.
1. Log in to the campus portal as an administrator and access EX FormFlow - Forms.
2. Click Manage Forms. The Manage Forms page appears.
3. Access the Database page:
o Click Site Administrators. When the Site Administrators page appears, click Databases.
OR
o Click on the name of the form you are working with. When the form appears, select Databases from the Tools menu.
4. Click Databases. The Database page appears.
5. Click the Add icon.
6. In the Name field, enter the name of the database you are adding.
7. In the Connection String field, enter the ODBC connection string needed to connect to your database.
Connection string formatting is detailed on the connection strings website. The site includes details for SQL database strings as well as other databases. |
8. Click Save database.
9. Click Done.
Log into the campus portal as an administrator.
Navigate to the FormFlow - Forms feature.
Click the Manage Forms link. The Manage Forms page appears.
Click Add form. The Add new form pop-up appears.
From the Choose a template drop-down, select < Blank Form >.
Click the Create button. A new blank form is created and the form settings screen appears.
Enter a Form name into the provided field.
From the Tab orientation drop-down, select Horizontal or Vertical.
Enter in a description of the form in the Description field.
For more information on the basics of creating a form, see Build a Form.
Click Save settings. The new form displays.
Connecting the form to the EXi Event allows the FormFlow - Forms portlet to associate the submission data with the appropriate event. This can also be used to pull information about the EXi Event into the form, such as the registration fee associated with the event.
In the Manage Forms view of the event registration form, click the Add Question button from the Form Admin toolbar. The Edit Item pop-up appears.
In the Unique ID field, enter in a Unique ID for the question.
From the Type drop-down, select "Hidden".
On the Settings tab, enter the EXi event's
abbreviated name into the Default
Value field. Example.
The EXi event's abbreviated name can be found in EXi
on the main event's details page. Example.
From the Map to EXi Event Field drop-down, select "Event Abbreviation".
If your event does not require a fee:
Make sure the Execute On Load checkbox is checked.
If you event requires a fee and you wish for the fee value to be retrieved from the database:
On the Look Up tab, select a Look Up DataSource to retrieve the event's fee using the specified event abbreviation.
Set the argument for the DataSource to be the field on the form that will contain the fee value.
The Event Fee field must be created prior to this step. |
Make sure the Execute On Load checkbox is checked.
Click the Save changes button.
Step 5: Add questions/fields to the form
You will need to capture the following information from the user registering for the event:
Name information (First and Last Name or ID Number, etc.)
The Name Information fields should be editable if you want users who are not already in your database to be able to register for the event. If your registration form is intended only for users already in your database, it is recommended that you set up the form to pre-populate the name and contact fields using a datasource and a personal identification value (e.g. ID Number, Party App ID number, or email address) and make the name and contact fields read only. |
At least one form of contact information: Address (Address Line 1, Address Line 2, City, State, Zip Code), Telephone Number, and/or Email Address
Number of Attendees
Create a Submit button with the following rule on the Rules tab of the Edit Item popup:
Select "If answer value is" from the rule drop-down
In the field to the right of the drop-down, enter *
In the drop-down below, select "Form: Submit"
Additional questions you may need to add:
Event Fee (if there is an associated fee)
This field should be read only to prevent form users from trying to change the fee amount. |
If you are setting up a form for a multi-part event that has registration at the sub-event level, you will need to set up a collection grid to capture registration at the sub-event level.
The collection grid should have the following fields:
From the Manage Form view of your form, click the Add Question button on the Form Admin toolbar. The following are the values/properties a sub-event collection grid must have:
Definition tab
Unique ID
This
collection grid's Unique
ID will be the value you select from the
Grid drop-down
when setting up the rest of the collection grid's
questions. Example
|
Type: CollectionGrid
Settings tab
Show Details Button: (checked)
Show Update Button: (checked)
Instructions on how to use the grid
From the Manage Form view of your form, click the Add Question button on the Form Admin toolbar. The following are the values/properties an event list drop-down must have:
Definition tab Example
Unique ID
Type: Drop-down
Grid: select collection grid's Unique ID
Grid Function: Key
Settings tab
Map to EXi Event Field: Event ID
Look Up tab Example
Look up datasource: JZB - Sub-event Fee Lookup
Execute on Load: checked
From the Manage Form view of your form, click the Add Question button on the Form Admin toolbar. The following are the values/properties a fee per person field must have:
Definition tab Example
Unique ID
Type: Textbox
Grid: select collection grid's Unique ID
Grid function: Summary
Settings tab Example
Read only: (checked)
Default value: 0.00
Validation: Money
Map to EXi Event Field: Event Fee
Lookup tab Example
Execute on load: (checked)
A field to enter the number of participants
From the Manage Form view of your form, click the Add Question button on the Form Admin toolbar. The following are the values/properties a number of participants field must have:
Definition tab
Type: Textbox
Grid: select collection grid's Unique ID
Grid function: summary
Settings tab
Required: (checked)
Validation: Integer
Map to EXi Event Field: # of people attending
Lookup tab
Execute on load: (checked)
A button to submit the data to the collection grid
From the Manage Form view of your form, click the Add Question button on the Form Admin toolbar. The following are the values/properties an add events to grid button must have:
Definition tab
Unique ID
Type: Button
Grid: select collection grid's Unique ID
Grid Function: Add Button
Rules tab
From the first drop-down, select
"If answer value is". In the field to
the right, enter *.
In the drop-down below these fields, select "Grid:
Add". Example
1. From the Tools menu, select Balance Calculator. The Balance Calculator page appears.
2. In the Final Balance field, enter in a formula to calculate the desired balance. If you have collection grids set up, a formula field appears for each grid on the form. To use the total value of the collection grid in the final balance, create a formula specific to that grid to tell the form how to determine its balance. Example
Formula: {CollectionGridField1} + {CollectionGridField2}
The grid adds each row using the formula above and them sums the row totals to come up with a balance for the collection grid. For example:
Given Row 1
CollectionGridField1 = 3
CollectionGridField2 = 4
Given Row 2
CollectionGridField1 = 2
CollectionGridField2 = 7
The total for {CollectionGrid} would be 16 and when {CollectionGrid} is used in the final balance formula, 16 will be used as its calculated value.
3. Click Save.
Step 7: Use datasources to populate fields with the user's contact information (optional)
To look up/populate contact fields, use one the Jenzabar provided JZB - Events Name Contact Lookup data sources or create your own so you can populate your forms with frequently used database information. Data sources are not limited to one form. You can reuse them as needed.
Jenzabar-provided data sources
Each of the event registration templates provided by Jenzabar includes a different way to retrieve existing contact information from the database. If you wish to utilize one of the pre-defined options and it does not already exist on your server, you will need to import in the corresponding template noted below which will import the data source with it. The data source will remain even if the form is deleted.
JZB - Events Name Contact By Email Lookup (multi-part event template)
This data source looks up contact information from the EX name_master and external person tables if the entered email address is listed there. It requires:
That an email address question be included on the form
The Look Up for the question be associated with this data source
Each of the arguments returned by the data source be associated with other questions on the form.
If an existing record is not found, the questions can be filled in by the user, in which case their information will be stored as an external person upon submit.
JZB - Events Name Contact by ID_NUM Lookup (single fee event template)
This data source looks up entries in the EX name_master table so it can only be used to look up internal users. It requires:
That a hidden data question be created on the form to contain an ID Number that is passed in as an argument for the form's URL
The Look Up for the hidden question be associated with this data source
Each of the arguments returned by the data source be associated with other questions on the form.
Since this data source is expected to find an existing user in the database, it is recommended that the name and contact fields be marked as read only.
JZB - Events Name Contact by PartyAppID Lookup (single no fee event template)
This data source lookup works with the partyappID in the URL, thereby allowing a lookup on both Name_Master ID Numbers and external people. It requires:
That a hidden data question be created on the form to contain a Party App ID that is passed in as an argument for the form's URL
The Look Up for the hidden question be associated with this data source
Each of the arguments returned by the data source be associated with other questions on the form.
Since this data source is expected to find an existing user in the database, it is recommended that the name and contact fields be marked as read only.
How to connect a question to a data source lookup
Right click on the field that you wish to use to look up the user's contact information. For example, if you are using their email address to look up their contact information in the database, right click on the email address question you created.
Access the Look Up tab.
From the Look Up DataSource drop-down, select the datasource you would like to use to look up the user's information.
Several drop-downs appear. The drop-downs correspond to the columns in the database table that have included in the Select portion of the datasource query.
For each column listed, click on the drop-down and select the corresponding question on the form that relates to the information. For example, for the first_name column, select the FirstName form question. Example
Once you are done selecting values for each column drop-down, click the Save changes button.
Step 8: Map a question to an EXi Event field
For each question you set up to collect the information listed above, you must map it to an EXi Event field in order for the data to be recorded for the event upon submit.
You can map to an EXi Event field when you are creating the question or after the question has already been made. Events mapping fields include ID Number, Party App ID, contact information, and event registration information. If the question has already been defined:
Right click on the question you wish to map and select "Properties". The Edit item popup appears.
Access the Settings tab.
Click on the Map to EXi Event Field drop-down and select the EXi Event field you would like to map the question to. For example, if you are mapping a First Name question, select "First Name" from the Map to EXi Event Field drop-down.
The Name Master ID Number, Party App ID, and email address will be used to identify existing people in the database to ensure that person is appropriately tied to the event. If only an email address is entered and it cannot be matched to an existing person, the name and contact information will be used to create a new external person and then connect that person to the event. |
Click the Save Changes button.
Step 9: Map question to a payment field if you are collecting payments for the event
If you are collecting fees for the event via the registration form, you may also map questions to a payment field so that their data is sent to their corresponding fields in the Payments feature after the user clicks the submit button.
You can map to a payment field when you are creating the question or after the question has already been made. Payment mapping fields include name and contact information. If the question has already been made:
Right click on the question you wish to map and select "Properties". The Edit item popup appears.
Access the Settings tab.
Click on the Map to Payment Field drop-down and select the payment field you would like to map the question to.
If you are mapping a First Name field, select "FirstName" from the Map to EXi Event Field drop-down. |
Click the Save Changes button.
Step 10: Use Mapped Statements or EX Mapping Tool to store data collected in the form to a database (optional)
Step 11: Set up the form to collect fee payments (optional)
If your event has fees that you need to collect payments for, complete the following steps:
If you need to set up a form for a multi-part event with fees, see Multi-Part Event - Sub-Event Registration. |
Log in to the campus portal as an administrator and access EX FormFlow - Forms.
Click Manage Forms. The Manage Forms page appears.
Click on the form you want to update.
From the Tools menu, select Balance Calculator. The Balance Calculator page appears.
In the Final Balance field, enter in the following formula to calculate the balance of a single event with a fee:
{Fee}*{Participants}
Click Save.
Log in to the campus portal as an administrator and access EX FormFlow - Forms.
Click Manage Forms. The Manage Forms page appears.
Click on form you want to update.
From the Tools menu, select Payment Profiles.
Click the Add Profile button to create a new payment profile. The Payment Profile page appears.
If your school will allow applicants to use an electronic check to make their payment, select the Allow E-check checkbox.
In the Show fee description field, review or update how the charge will be passed to your school's payment provider.
In the Transaction Code, enter your EX Receipt Entry Code used for online payments.
In the Default Fee amount, review or update the default amount being charged. Example. The default fee amount must be greater than $0 but will be overridden by any amount generated by the Balance Calculator.
In the Email address to notify on failed payment field, enter an email address at your school that can be used to notify the appropriate person or department the payment failed. For example, this might be your school's Accounts Receivable office or IT department.
Click Save Profile.
If your form requires a payment, make sure the Submit button at the end of the form has the following rule:
To create a rule that will direct the user to the payment portlet, select "If answer value is" from the rule drop-down. In the field to the right of the drop-down, enter *. In the drop-down below, select "Payment: Use Profile". The payment profile drop-down appears. Select the payment profile you have created for this event. Example.
Form name, description, and tab orientation