Overview

Every portal needs at least a portal object and an interface, but a portal can contain that and so much more. This page walks you through creating a portal, from the very beginning of development through deployment.

For more information on creating, publishing, and deploying portals see the Portal Object and Manage a Portal pages.

Step 1: Create a portal object

The portal object contains the settings that are used to publish a portal. When a portal is published, Appian bundles up the portal object and all the precedents of the portal object to create the portal.

To create a portal object:

1. In your application, go to the Build view.
2. Click NEW > Portal.
3. Enter the portal properties:
   • Enter a Name for your portal object.
   • Enter a Display Name to identify your portal in the browser tab. This name can also be displayed in the header bar.
   • The Web Address Identifier automatically populates based on the display name. You can update it if necessary.
   • Optionally, add a Description.
4. Click CREATE.

Step 2: Add a Page to your portal

Pages are the interfaces that display to your portal users. Similar to sites, you can have up to five pages in a portal and can choose one interface object to display on each page. If you have more than one page, they display in a header bar.

The interface you add as a page cannot contain rule inputs. However, it can reference other objects that use rule inputs. Also make sure that you aren't using any incompatible functions or components in your interface. For more information about the functional design considerations to keep in mind when creating a portal, see Portal Best Practices.

To add a page:

1. In the portal object, go to the Pages section.
2. Click ADD PAGE.
3. Enter the page properties:
   • Enter a page Title. When a portal has more than one page, this displays in the header bar.
   • The Web Address Identifier automatically populates based on the title. You can update it if necessary.
   • Select an interface, or click to create a new interface.
4. Click ADD.
5. Repeat these steps to add up to five pages. Use the and arrows to reorder the pages.

Step 3: Configure a header bar and branding

If you add more than one page to your portal, the header bar is automatically enabled. If your portal has only one page, the header bar is optional. Showing a header bar in your portal allows you to choose a color and logo to display in the header bar to help your users recognize that the portal belongs to your brand.

Additionally, you can make changes to any of the default branding configurations, such as input and button shape, to fit your organization's branding guidelines.

To configure the header bar and branding:

1. In the portal object, go to the Header section.
2. Show header bar is automatically selected. You can choose to deselect it, but if you only have more than one page, the additional pages will be removed from the portal.
3. Configure the rest of the header settings.
4. Show portal display name in header bar is automatically selected. You can deselect it if you don't want the display name from the configurations section to display.
5. Go to the Branding section and configure the branding settings. The changes you make display in the Branding Preview.

Step 4: Add a service account and (optionally) a Google reCAPTCHA connected system

The Service Access section allows you to configure access to services using service accounts and/or Google reCAPTCHA.

Add a service account

A service account acts on behalf of your portal users. The records, processes, and documents stored in Appian won't be available in your portal until you give your service account access to them.

System administrators can create a service account directly from the portal object.

To add a service account:

1. In the portal object, go to the Service Access section.
2. Next to the Service Account picker, click to create a new service account. Optionally, you can select an existing service account.
   • If you don't see , contact a system administrator to create a service account for you.
3. Enter a unique username for your service account, then click CREATE.
4. Click View record type permissions for the service account to see which record types the service account can access. Make sure the service account doesn't have access to record types that aren't used in your portal.
   • To remove permissions for a record type, click Security next to the record type name. See Required permissions for portal service accounts for more information on the appropriate permissions for service accounts.

   

Add a Google reCAPTCHA connected system (optional)

Optionally, you can add reCAPTCHA to your portal to help you monitor your portal for spam or potentially malicious activity. Not every portal needs Google reCAPTCHA, but we recommend using it if your portal is high profile, highly publicized, or if you have had issues with spam messages in your portal.

To add a reCAPTCHA connected system:

1. In the portal object, go to the Service Access section.
2. Next to the Google reCAPTCHA picker, click to create a new Google reCAPTCHA connected system. Optionally, you can select an existing Google reCAPTCHA connected system.
3. Enter a Name and optional Description.

4. Enter the Google reCAPTCHA credentials.

   Connected System Field	Google Cloud Name (and Location)*	Description
   reCAPTCHA Project ID	Project ID (Project Dashboard)	Project ID for the Google Cloud project. To create a project, see the Google documentation.
   reCAPTCHA Site Key	Key ID (Security > reCAPTCHA Enterprise)	The key ID configured for your portal, also known as the site key. To create a key ID, see the Google documentation. When creating the key: - For platform type, choose Website. - Add your portal's domain to the Domain list. After you create the key, simply copy it and add it to the connected system. No additional set up is required.
   reCAPTCHA API Key	API Key (APIs & Services > Credentials)	Sensitive. An API key with reCAPTCHA Enterprise API enabled. To create a reCAPTCHA Enterprise-enabled API key, see the Google documentation.

   *Information from Google is subject to change.

5. Click Test Connection to test that your credentials are valid for getting a reCAPTCHA score.
6. Click CREATE.

See step 6 for more information on how to use reCAPTCHA in your portal interface.

Step 5: (Optional) Configure your portal as a progressive web app

You can configure your portal to be a Progressive Web App (PWA). A PWA looks and behaves like a native application and allows your users to install the portal on their device for easy and frequent access.

See the portal object page for more information about PWAs.

To configure your portal as a PWA:

1. In the portal object, go to the Progressive Web App section.
2. Select Configure portal as a progressive web app.
3. Configure the Progressive Web App settings.

Step 6: Create the rest of your portal

This step will depend on your portal use case. This table lists common capabilities of portals along with the high-level steps to accomplish them.

If you want your portal to…	Then…
Query data.	1. Create a record type. 2. Query the record type in a portal interface using a!queryRecordType(). Note: You cannot use a record type as a source for grids, charts, or card choices. You must use an Expression as the source and use a!queryRecordType to query the data. See Working with data using record types for more information.
Allow portal users to upload files.	1. Create a constant of type Folder for the folder that the files will be uploaded to. 2. In your portal interface, add a File Upload or Signature component. For the target parameter, use the folder constant. 3. In the saveInto parameter of a submit link or button, use the a!submitUploadedFiles()* function. Note: Uploaded files can be no larger than 10 MB.
Allow portal users to download or view files.	1. In your portal interface, use the a!documentDownloadLink, a!documentImage, and/or a!documentViewerField components. 2. In the document parameter of the components, use a constant of type document or a document ID.
Add, update, or delete record data.	1. In a saveInto parameter on your portal interface, use a!startProcess(). 2. In your process model, use the Write Records and Delete Records smart services.
Create a user, update data using a CDT, send an email, or start another Appian process	1. In a saveInto parameter on your portal interface, use a!startProcess(). 2. In your process model, use the appropriate smart service.
Use reCAPTCHA to determine what to do if a bot is likely trying to use your portal.	1. Create and add a Google reCAPTCHA connected system to your portal. 2. In a submission button on your portal interface, use the a!verifyRecaptcha()* function in the recaptchaSaveInto parameter. Whenever the submission button is used, Google reCAPTCHA returns a score that determines how likely it is that a bot is trying to use your portal. Configure the a!verifyRecaptcha() function to determine what to do based on the score using fv!score. For more information and examples, see Configuring reCAPTCHA.

*The a!submitUploadedFiles() and a!verifyRecaptcha() functions will not work outside of a published portal. In order to test these functions, you must publish your portal first and test it in the published portal.

Step 7: Give the portal service account appropriate permissions

Service accounts act on the behalf of your portal users. Unless the service account is given explicit permissions to certain objects in Appian, your portal won't have access to the records, processes, and documents stored in Appian. This helps keep your Appian environment secure and ensures your portal users can still connect to the information and processes that are important to them.

To give the portal service account the appropriate permissions:

1. Add the portal service account to a user group in your application.
2. Give the group the required permissions to the objects used in your portal.

Step 8: Publish your portal object

With your supporting objects and portal object all created and configured, your portal object is now ready for publishing!

To publish your portal object:

1. In the portal object, go to the Configurations section and turn on Published.
2. Click SAVE CHANGES. The portal won't be published until you save.
3. After the portal status updates to Published, click the URL under Web Address to see your published portal.

For more information on publishing, see Manage a Portal.

Step 9: Test your published portal

Now that your portal is published, it's time to test it. It's important to test both your individual objects and the published portal as a whole with production-level usage. Some connections can't be tested until after publishing.

Navigate to the published portal using the URL under Web Address and test your portal as a user would interact with it.

To make sure that everything is functioning correctly, fully test all of the objects and connections that are precedents of your portal, including the following:

• Interface components, including:
  • Input and selection components.
  • File upload and signature components using the a!submitUploadedFiles() Function.
  • Document download link components.
  • Document viewer and document image components.
  • Web content field components.
• Google reCAPTCHA connection on your interface.
• Expression rules.
• Constants.
• All other objects and connections.
• Web API, connected system, and integration objects, as well as any connections to them in interfaces.
• Data source connected systems for external databases and connections to them in interfaces.

Be sure to fill out all of the fields, whether they are required or not, and go through all of the steps in your portal. If you run into any issues while testing, check out the Visitor Activity Logs in your portal object.

For more information about testing and to learn about who can see your portal during testing, see Manage a Portal.

Making changes to your published portal

If you found any problems with your portal during testing, go ahead and make the necessary changes to your objects. When you save changes to your portal object or portal object precedents, the portal automatically republishes to stay up-to-date with the latest changes.

For more information on automatic republishing, see Manage a Portal.

Step 10: Deploy your portal

Once you've created, published, and tested your portal object, it's time to deploy your portal to the next environment.

When you deploy a published portal, it automatically publishes in the target environment. To make sure your portal publishes automatically when you deploy it, see Deploying a portal for important information.

To deploy your portal:

1. Set up the service account in the target environment with the same username and group membership as in the source environment.
2. Include the portal object and all of its precedent objects in your existing deployment pipeline with an application or in a package.

You're ready to go!

Step 11: Share your portal and celebrate!

Congratulations! You created a nice and shiny new portal!

After a successful deployment to your production environment, you can now share your portal with your users at the web address specified in the portal object and celebrate.