Setup Checklist

This is a basic blueprint for how to configure an Apparatus portal in conjunction with your website.


Step 0: Install Prerequisites

  • Use the Install Extension Wizard to install '40 Fingers' module (http://www.40fingers.net/Products/DNN-Stylehelper)
  • Install the INNO Apparatus modules

Extensions

Step 1: Create Admin User Account

  1. Create a new user account, specifying the email address in the User Name, First Name, Last Name, and Email Address fields. This email address will be publicly displayed as the contact for support, and this account will receive administrative emails from the site.
  2. Fill the Telephone and Website fields in the account profile. The website is the address for your existing website (not the Apparatus portal). If there is no phone number, leave this field blank.
  3. In the Account Settings for this user, assign the Administrators role.

DNN User Roles

Step 2: Add and Configure Pages

  1. Open the Pages menu.
  2. Set the site's Home page. If the Apparatus module will be used on a page other than the Home page, add that page as a public page.
  3. Add a public page named Apparatus Profile.
  4. Add public pages named Login and Thank You, and ensure the "Display in Menu" property for these pages is unchecked in the page settings.
  5. On the Login page: Add a new module called "Account Login" > Configure the settings > "Login Only" and check "Enable Remember Me"
  6. Add an admin page named Apparatus Manager: To add a page under the Admin menu, open the page properties and select "Admin" as the Parent Page value.
  7. (Optional) Add the following additional public pages: FAQs, Class Policies, Instructors, and Privacy Policy.

Page Settings

Step 3: Configure Security and Site Settings

  1. Open the website Security settings
  2. Set the Site Administrator to the administrative user account created above
  3. Open Site Settings for the website
  4. Add your organization's logo and favicon icon file. (For more information on how to create a favicon, please visit www.favicon-generator.org)
  5. Set the Site Time Zone setting to the local time.
  6. Set the default login page to the Login page created above. Important! Before completing this step, ensure the 'Account Login' module has already been added to the 'Login' page!

Site Settings

Step 4: Add INNO Apparatus Modules

  1. On the Home page, add a new INNO Apparatus module
  2. On the Apparatus Manager page, add a new INNO Apparatus Manager module. Only Administrators should be able to view this page.
  3. On the Apparatus Profile page, add a new INNO Apparatus Profile module. Set the permissions so registered users must be logged in to view this page.

Add INNO Modules

Step 5: Add Directories

  1. Go to the File Management (Site Assets) area of the website
  2. In the root directory, add a folder to the root called "Images"
  3. In the root directory, add the following folders to the root: /INNO/resources/Events. (Under the root folder, add a folder called "INNO"; under the INNO folder, add a folder called "resources"; under the resources folder, add a folder called "Events". The Events folder is where required forms are stored and accessed by Apparatus.)

File Management

Step 6: Update Email Content

Important! Caution should be taken when modifying resource files! Back up the file content before making changes.

  1. Edit the email template RESX file to customize the content for your organization. This file is used to send out confirmation emails to registrants and administrators.
    Click here to jump to instructions on how to load and modify resource file values.
  2. Some other texts on the Apparatus modules may also be updated, by modifying values in the InnoRegistration resource file. InnoRegistration.resx is located in the same directory as Email_Templates.resx

Email Template RESX file

Frequently Asked Questions

Administrative How-To Guide


Open the Apparatus Manager

  1. Go to your Apparatus domain. Example: https://registration.yourdomain.com/
  2. Click "Login" and log in using your administrator account
  3. If the Apparatus Manager module was added to a page under the Admin directory, hover over "Admin" in the control panel and then find and click on "Apparatus Manager".

    The Apparatus Manager is a dashboard that allows administrators to edit and organize programs, upload and manage files, and view reports.

File Management

Add or Edit a Program

  1. Go to the page with the INNO Apparatus Manager module. The list of programs is loaded on the Home tab.
  2. Click the pencil icon to the right of a program to edit it, or click the "Add New Program" tab to create a new program.
  3. Enter or update the program details and click Save to complete the program creation process.

File Management

Delete a Program

  1. Go to the page with the INNO Apparatus Manager module. The list of programs is loaded on the Home tab.
  2. Click the red X icon to the right of a program to delete it.

    Important Note: When a program is deleted, all of the program's reports are also deleted! When in doubt, edit a program and set the status to "Archived" - this will remove it from the program list that regular users see in the INNO Apparatus module, but the program and reports are still available for review by administrators in the INNO Apparatus Manager module.

File Management

Hide a Program

  1. Go to the page with the INNO Apparatus Manager module. The list of programs is loaded on the Home tab.
  2. Click the pencil icon to the right of a program to edit it.
  3. Click the Status drop-down list and choose "Archived", and save the changes to the program. This will remove the program from appearing in the list shown in the INNO Apparatus module.

File Management

File Management

Hide the Program List

It's possible to set overall registration to be limited to a certain time period by controlling the visibility of the INNO Apparatus module.

  1. Go to the page with the INNO Apparatus module, and put the page into Edit Mode.
  2. Click the gear icon to the upper right of the INNO Apparatus module, and select "Settings".
  3. On the Module Settings tab, expand the Advanced Settings section
  4. Enter datetime values for the Start Time and End Time fields, and save the changes. These values are dependent on the server's timezone.

    The INNO Apparatus module will only be displayed to regular users (whether they are logged in or not) if the current datetime is between the Start Date and End Date values. Note: The INNO Apparatus module will always be available to administrators when they are logged in.

File Management

File Management

Add Links to Program Description

 

  1. Go to the page with the INNO Apparatus Manager module.
  2. Click the pencil icon to the right of the program you wish to edit.
  3. Scroll down to the Description field, and add HTML code to create the link.

    Note: The URL must start with the proper protocol! Example: http://www.google.com

File Management

File Management

Add Required Forms to Programs

These are forms for participants and their guardians to complete and submit or bring when attending, such as waivers and questionnaires.

  1. Go to the page with the INNO Apparatus Manager module, and click the "Manage Forms" tab.
  2. In the Manage Files section, click "Choose File" to select a local file. then click Upload to transfer it to the server.
  3. In the Manage Forms section, select the file uploaded in the previous step and enter a user-friendly name in the Form Name field. This friendly name can be seen by all users - by administrators when editing programs, and by participants when viewing and enrolling in programs.

File Management

File Management

File Management

Delete Required Forms

  1. Go to the page with the INNO Apparatus Manager module, and click the "Manage Forms" tab.
  2. the Manage Forms section, scroll down to the list added forms.
  3. Click the red X next to the form to be deleted. The form is removed from the list.

    Important Note: This action deletes the form listing from Apparatus - that is, administrators cannot add the form to programs, and users cannot see the form attached to programs. However, the file is not deleted from the server.

Permanent File Removal

Exercise caution when removing files - this action cannot be undone!

  1. If the form association has not been removed from the list per the above instructions, remove it now. (Both the form association removal and the permanent file removal must be completed to ensure the file is truly gone.)
  2. Go to the File Management page. By default this page is under the Admin section.
  3. Navigate to the INNO/resources/Events directory.
  4. Select and delete the forms you wish to permanently remove from the server.

File Management

File Management

View Program Reports

To view reports, go to the page with the INNO Apparatus Manager module, and click the Reports tab.

    Note:
  • Filtering reports for a time period filters the data within those reports to that time period. This means that registrations occurring outside that period will not be in the report data.
  • Reports are only generated for programs with one or more registered participants. Programs with no registrants do not generate reports.

File Management

Find a User's Membership Number

There are a few different ways the membership number can be retrieved.

  1. In the Apparatus Profile.
    Regular users can go to the page with the INNO Apparatus Profile module. The membership number is automatically populated for the logged-in user.
  2. In the Users area of the Apparatus Manager.
    Administrative users can go to the page with the INNO Apparatus Manager module, and click the Users tab. Find the desired user, and click the pencil icon to the right of the user to edit that user's profile and observe the membership number.
  3. In the Participant reports.
    Go to the page with the INNO Apparatus Manager module, and click the Reports tab. Click on the Participant Report link to the right of a program to retrieve the membership number for the users registered in that program.

Membership

Add Program Categories

Categories can be used for single-tier or dual-tier program sorting.

  1. Go to the Apparatus Manager and select the Manage Categories tab.
  2. To create a single-tier category, enter the name in the Category field, then click Add Category. (Sub-Category is not mandatory.)
  3. To create a dual-tier category, enter both the Category and Sub-Category name, then click Add Category. It is not mandatory to create a single-tier or parent category before creating sub-categories.
  4. Go to create or edit a program, and select all categories the program is associated to. Note: Parent categories must be selected manually, along with the sub-category values.... selection of sub-categories does not select the parent caegory!

 

File Management

categories

Configure Support Email and Phone Number

It's possible to set support information that is visible to all site visitors, logged in or not. This information is maintained on the profile of the user account set as the Site Administrator / Primary Administrator.

  1. To confirm which user account has been set as the Site Administrator user, find this information in the Security settings for the website.
  2. Log in to the site using the Site Administrator account credentials.
  3. Load the profile editor for the website user. By default this page is located in the Activity Feed section of the website pages. Example: registration.yourcommunitycenter.com/Activity-Feed/My-Profile
    Note: This user profile management is not the same as the Apparatus Profile. Check to make sure the URL is not the same as the page with the INNO Profile module.
  4. The Support Email is the email address used for this account. To change the Support Email, click Manage Account. Under the Account Settings section, update the Email Address field and click Update to save the changes. This field is a required field and cannot be removed.
  5. The Support Phone is the number in the Contact Info for this account. To change the Support Phone, click Edit Profile and expand the Contact Info section. Update or remove the Telephone field value and click Update to save the changes.

File Management

File Management

File Management

Configure Membership and Cheque Fees

  1. Go to the page with the INNO Apparatus module.
  2. Edit the page by clicking the pencil icon. When the page is in Edit Mode, a small gear icon appears at the upper right corner of each module on the page.
  3. Click the gear and select "Settings," and then go to the "INNO Apparatus Settings" tab.
  4. Expand the Membership Options section to set membership fees and renewal dates for all users.

File Management

File Management

Reprint / Resend a User's Transaction Receipt

At this time, only administrators can reprint or resend a receipt.

  1. Go to the page with the INNO Apparatus Manager page, and click the Transactions tab.
  2. Filter the transactions by user, if desired. Scroll down to see the transactions.
  3. Click on the transaction, and it expands to display the transaction details.
  4. Click the "Resend Receipts" button to reissue the receipts.

File Management

Review Additional Feedback From Registration

Users can submit feedback on Step 4 of the registration and checkout process. This information is available for review in the Transactions tab.

  1. Go to the page with the INNO Apparatus Manager page, and click the Transactions tab.
  2. Filter the transactions by user, if desired. Scroll down to see the transactions.
  3. The text from the Additional Feedback field in Step 4 of the checkout process is displayed in the Notes column in the list of transactions. Data for this column is also displayed in the Transactions reports.

transactions

transactions

Create a Free Program

 

  1. Go to the page with the INNO Apparatus Manager page, and click the Add New Program tab.
  2. Enter the program details.
  3. Enter $0 for the cost. A free program does not require payment information to be entered. Please note, however, that membership fees are charged as usual even when programs themselves have no charge.

Free Zero Cost Program

Update Module Texts

It's possible to edit various texts on the Apparatus modules by editing the resource files. The editing process is very similar to that of the email content update process - click here for instructions.

  1. On the Translate Resource Files page, set the Mode value to the Apparatus portal. Important: Do not select Global or Host unless you wish to make changes to ALL sites!
  2. In the Resource File drop-down, navigate to the Local Resources > DesktopModules > INNO > App_GlobalResources directory and select the "InnoRegistration" resource file. Note: When the specific Apparatus site has been selected for the Mode field value in the previous step, the selected RESX file name will contain the text "Portal-n", where n is the portal number. Make sure to select the "InnoRegistration" with no additional text in the file name.
  3. Update the desired texts in the "Localized Value" column, then click "Save Translations to File" button.

    Note: The text above the Login fields is located in the InnoRegistration.LoginView.HEADER field, and the text above Registration fields is in the InnoRegistration.RegistrationView.HEADER field.

Edit InnoRegistration Resource File

Updating Apparatus System Email Content

How and Where to Modify Emails

Important! Caution should be taken when modifying resource files! Back up the file content before making changes.


Solution #1: Edit the Resource File Directly

 

This solution is geared for those who are familiar with using resource (*.resx) files.

  1. Download and open your preferred resource file editor. If you're familiar with Visual Studio, the suite can be used to edit .resx files. An open-source standalone .resx file editor is available on SourceForge.
  2. Download the RESX file from the server via FTP. The resource filename starts with "Email_Templates" and is located in the DesktopModules/INNO/App_GlobalResources directory - each portal's resource file has the portal number in the file name. Save a backup copy of this file in a safe place in case you need to restore it!
  3. The RESX file content is separated into "Internal Name" and "To be translated" columns. The editable email content is in the "To be translated" column, in HTML format.
    Important: Do not edit the "Internal Name" column values!
  4. Replace the RESX file on the server via FTP.
  5. To ensure the server has the updated email content, clear the cache and recycle the application domain.

Email Template RESX File

Solution #2: Edit the Resource File through the Language Editor

 

Step 1: Loading the Resource Files

  1. Log in as Administrator and click the gear icon in the DNN to load the Settings menu.
  2. Go to Site Settings and select the Languages tab.
  3. Under the Languages section, click the glyph icon at right of the Culture to load the Translate Resource Files page.

Load Language Translation management

Step 2: Translate Resource Files page

  1. On the Translate Resource Files page, set the Mode value to the Apparatus portal. Important: Do not select Global or Host unless you wish to make changes to ALL sites!
  2. In the Resource File drop-down, navigate to the Local Resources > DesktopModules > INNO > App_GlobalResources directory and select the "Email_Templates" resource file. Note: When the specific Apparatus site has been selected for the Mode field value in the previous step, the selected RESX file name will contain the text "Portal-n", where n is the portal number. Make sure to select the "Email_Templates" with no additional text in the file name.
  3. When the RESX file is selected, the resource key name and value pairs appear below.

Load Email Template RESX File

Step 3: Updating the Content

Each email body and subject line are a different resource name.

  1. In the resource file, find the desired content values to update.
  2. Put the updated content in the "Localized Value" column. The content is accepted in HTML format. Ensure the HTML code is well-formed before saving!
  3. Click "Save Translations to File" button to save the changes.

Edit Email Template RESX Values

Payment Setup and Configuration

How to Set Up Stripe and Receive Stripe or Paypal Payments


Sign Up for a Stripe Account

 

  1. Go to www.stripe.com. If you don't have an existing account, create a new one.
  2. Under the Developer settings, select API Keys to view your unique Stripe keys.These keys allow applications to process transactions with your Stripe account.
  3. Make note of the Publishable Key and Secret Key. These values will be used in the Apparatus settings.

File Management

Configure Apparatus to use Stripe

  1. Go to the Home page, or the page where the INNO Apparatus module is added, and enter Edit mode.
  2. Click the gear at the upper right of the Apparatus module, and select Settings.
  3. Select the INNO Apparatus Settings tab, and expand the Payment Options section.
  4. On the Payment Provider radio button, select the Stripe value.
  5. Enter the values for the Stripe Secret Key and Stripe Publishable Key. Both settings are required to process payments.
  6. (Optional) Specify the Thank You page. This page is where users are redirected after completing purchase, and is specified by relative path. If no Thank You page URL is specified, the user is redirected to the Home page after completing purchase.

Stripe Settings

Configure Apparatus to use Paypal

  1. Go to the Home page, or the page where the INNO Apparatus module is added, and enter Edit mode.
  2. Click the gear at the upper right of the Apparatus module, and select Settings.
  3. Select the INNO Apparatus Settings tab, and expand the Payment Options section.
  4. On the Payment Provider radio button, select the Paypal value.
  5. Set the Environment radio button value, and specify values for the applicable Application ID, Username, Password and Signature fields.
  6. (Optional) Specify the Thank You page. This page is where users are redirected after completing purchase, and is specified by relative path. If no Thank You page URL is specified, the user is redirected to the Home page after completing purchase.

Paypal Settings

Using Filters

How to Configure Filters for Program Packages (Multiple Selection)


Create a Filter

Filters can be used to create packages of programs. For example, to require the enrollment in two or more programs from a collection to create a package deal. Simple (non-package) filters can also be created.

  1. Open the Apparatus Manager and select the Manage Filters tab.
  2. Provide values for the filter fields. If the filter is being used to enforce multiple program selection, select the Package checkbox, and specify the number of programs with this filter in which the user must enroll.
  3. Click "Add Filter" to add the filter to the list.

Adding a Filter

Adding the Filter to Programs

  1. Add or edit a program.
  2. In the Event Filters section of the event, select the desired filter.
  3. Save the program.

Setting a Filter

Filter Validation on Checkout

When a program has a filter applied, the item count will be validated before the user can proceed with checkout. If the shopping cart doesn't contain the correct quantity of a program with a package filter applied, the checkout process will not proceed until this is corrected.

Program Checkout with Filters Applied

Configuring the Instructors

How to Set Up Instructors and Link to Instructors in Programs


Create Instructor Profiles

  1. If you have not already added a page for instructor profiles, do so now.
  2. Add each instructor's profile and photo, if applicable.
  3. Make note of the page URL for each instructor. If the instructor profiles do not have unique links, it's OK to use the same link for multiple instructors.

Instructor Page

Adding Instructors to Apparatus

  1. Go to the Apparatus Manager and click the Instructors tab
  2. Enter values for the first and last name of the instructor, and their profile URL.
  3. Click "Add Instructor", and the instructor entry is added to the list of available instructors below.

Existing instructor entries can be edited by clicking the pencil icon next to the name in the list.

Adding Instructor Entries

Adding Instructors to Programs

  1. Go to the Apparatus Manager and add or edit a program.
  2. In the Instructor field, select an instructor from the drop-down list. This will cause the instructor's name to be displayed in the program details.
  3. Ensure the "Link to instructor" box is checked to display a link to the instructor's profile beside their name.
  4. Save the program.

Note: Only one instructor can be selected per program.

Add Instructor to Program class=

Program Description Detail