|This content applies solely to Appian Portals, which may require an additional license purchase.|
To make your portal public, use the Portal Publishing Manager. The application packages up all your interface precedents, portal details, configurations, and extra credentials, and publishes them as a unique URL that can be accessed by anyone, even if they don't have an Appian account.
Before you publish, you'll need to configure your basic portal details, then you can optionally add a service account, reCAPTCHA credentials, and branding configurations.
This page walks you through the steps to publish your portal.
We strongly recommend that you use your production environment to publish portals that are ready for production use.
If your portal allows end users to upload, download, or view documents or write or query data, you'll need to give them access to the relevant document folders and databases through Appian. To do this, you'll grant the service accounts permissions to the relevant objects in Appian.
To give end users the appropriate access to your portal:
In order to publish, update, or delete a portal, you'll need access to the Portal Publishing Manager site in your Appian environment. Access is granted to this site through the Portals Publishers group. This is a pre-made group that comes with the Portal Publishing Manager application. By default, everyone in the designer role is included in this group.
This group is used to control permissions for all portals in your environment and can't be used to grant access to individual portals. If you have multiple portals in your environment, all users in the Portals Publishers group have access to publish, update, and delete any portal in your environment.
If you're using a data source connected system to connect directly to an external database or if you're using an integration with a connected system, set up an import customization file containing the necessary properties.
In the import customization file, remember to uncomment the lines that you need by removing the
# and fill out the value in the uncommented lines. Lines starting with a
# are ignored.
To publish a new portal, first set up the basic information about your portal under Portal Details:
reCAPTCHA is a feature that allows you to monitor your portals for potentially malicious or fraudulent activity from bots. Appian works with Google’s reCAPTCHA services to provide this feature. Since reCAPTCHA requires you to use both Appian and Google, you need to set up reCAPTCHA in both Appian and Google.
For guidance on using reCAPTCHA in your portal, see Configuring reCAPTCHA.
When you set up reCAPTCHA in the Google Admin Console, you first need to create a project. Note your project ID, which you will use to set up reCAPTCHA in the Portal Publishing Manager.
If you're having trouble creating a project for the first time, try starting at the reCAPTCHA Enterprise page in your Google Admin Console. When you create a new project, you may need to configure the name, ID, organization, and location for your project.
After you've set up a reCAPTCHA project in the Google Admin console, you need to set up your API and site keys. Follow the steps in Google's documentation for creating the API keys and site keys.
The API key (or secret key) allows your Portal to communicate with the reCAPTCHA server. The site key allows you to use reCAPTCHA on your Portal. Since Appian only supports v3 reCAPTCHA, make sure your site key is a score-based site key. Follow Google’s instructions for adding your domain name or any other necessary information for your reCAPTCHA keys registration.
To add reCAPTCHA to your portal:
For more reCAPTCHA guidance or further information on setting up and using reCAPTCHA, check out Configuring reCAPTCHA.
In addition to allowing your users to complete their workflows and tasks with ease, your portal should also fit seamlessly with the look and feel for the rest of your organizations.
To ensure that your Portal matches your branding and style requirements, configure any or all of the following branding fields:
Service accounts allow you to manage security for your portal by giving your end users access the data and documents in your portal. For more information, check out Service Accounts in Portals.
Only add service accounts to the Portal Publishing Manager if they are used for documents or connecting directly external databases using a data source connected system. Any service account that is used to connect to a database using an integration and web API (as described in Working with Data in Portals) doesn't need to be added in the Portal Publishing Manager.
To add a service account for your documents or direct connection to an external database:
Note that after you publish your portal, an API key will automatically be created for your service account. This key is added to the Web API Authentication page in the Admin Console. You don't need to do anything with this key.
If the service account doesn't have the correct permissions, you'll see an error when you publish or update your portal.
After you publish your portal, be sure to fully test it to make sure everything is working correctly.
To publish and test your portal:
Click PUBLISH. The publication process can take up to 5 minutes. During this time, your portal won't be accessible.
Do not try to update or publish your portal until it is fully published, or it could cause an error.
On This Page