Installation Guide

Introduction

CampusPass helps academic institutions manage crises, such as the COVID-19 pandemic. This page provides instructions for installing CampusPass in an Appian environment.

To update to v14.0 of CampusPass, see the version 14.0 upgrade guide. Note that you must be registered on Appian Community to access this link.

Technical support

Please call our dedicated CampusPass solution help line at the numbers below if at any point you need assistance or have questions:

• US: +1 (703) 420-1311
• AUS: +61 285034152
• UK: +44 20 3929 3748

Current customers can also log into Appian Community and open support cases. All users of CampusPass can also email Appian Support at support@appian.com.

System requirements

• Appian 21.4 or later. Appian HIPAA Cloud is recommended to ensure potential sensitive user health data is protected.
• A supported version of a MariaDB database as a business data source.
  • Note: Instructions below are tailored for MariaDB databases. For use with other databases, the SQL scripts used in Step 3 will need to be modified.
• A supported web browser.

Step 1: Download software package

This package contains the following files:

• Application Zip:
  • CampusPassv14.0.0.zip
• SQL Files:
  • CampusPassv14.0.0.sql
• Import properties file:
  • CampusPassv14.0.0.properties

To download the software package (as an existing Customer or Partner):

1. Go to the SUPPORT tab on My Appian.
2. Click the DOWNLOADS tab.
3. Click SOLUTIONS.
4. Find and open CampusPass Solution v14.0.
5. Download the software package.

Step 2: Deploy Plug-ins

CampusPass v14.0 relies on the following plug-ins required to be deployed and configured in the target system before the application files can be imported. Please update to the latest version of each plugin:

• Personalization Utilities
• Regular Expression Functions
• Barcode and QR Code Utilities
• Execute Stored Procedure
• Appian Solutions Plug-in
• Content Tools

Appian Cloud Environments

To deploy the plug-in for an Appian Cloud environment:

1. In the target environment, log in as the deployment user.
2. Navigate to the Admin Console.
3. On the left side of the console, click Plug-ins.
4. Click ADD PLUG-INS.
5. Search for the plug-in by name. For example, Personalization Utilities.
6. Click on the plug-in name.
7. Click DEPLOY.
8. Repeat steps 4-7 for the remaining plug-ins listed above.

Self-Managed Environments

To deploy the plug-ins for a self-managed environment, follow the Deploying Plug-ins instructions. The plug-in files can be retrieved from the AppMarket links above.

Step 3: Create database objects

In order to create the structure for the database tables, views, and other objects that are a part of CampusPass, you will need to run DDL scripts in your database.

1. In your Appian-provisioned cloud database, select the Appian (or desired target) database.
2. Import the CampusPassv14.0.0.sql, which was downloaded in Step 1.

Step 4: Import the application files

Import the application files into the target environment.

1. In the target environment, log in as the deployment user.
2. Navigate to the Appian Designer.
3. Click IMPORT.
4. Click UPLOAD and choose the CampusPassv14.0.0.zip file that was downloaded in Step 1. Check the box to include a related import customization file, and choose the CampusPassv14.0.0.properties file that was also downloaded in Step 1.
5. Click IMPORT PACKAGE.
   • Note: The import may time out due to file size, but import will continue in the background.
   • Note: If the business database is not called Appian, a warning will occur when importing the data stores. To fix this, after the import is complete, open each data store object and update the Data Source dropdown list to point to the Appian business database. Then simply save and publish the Data store.

To check the status of the import:

1. In Appian Designer, go to the Deployments tab.
2. When the deployment has been completed and is successful, a green circle will display. If there is an error, a red circle will display. Click the deployment link for further information.

Step 5: If your environment uses Tempo, add necessary users to the Tempo Users group

If CampusPass is the only application in your environment, or Tempo is not used by your organization, this step can be skipped.

Tempo access is restricted across the environment. By default, users are not members of the Tempo Users group.

This prevents external visitors and those within your organization from achieving broader access to the environment than they need. Additionally, CampusPass does not require Tempo for any of its functionality.

If you require particular users or groups to have Tempo access, you can add select members or groups to the Tempo Users group:

1. In your Appian environment, log in as a designer.
2. In the top-right corner of the page, go to the navigation menu and select Appian Designer.
3. Click Objects.
4. In the search box, search for Tempo Users group.
5. Select the Tempo Users group and add members as needed.

We encourage you to only add members who need access to Tempo. Refrain from using a membership rule that adds all users in the environment.

Next steps

After you finish installing the application, follow the Setup Guide to complete the solution set up.

Feedback