Portal Capabilities

Overview

Portals and sites both give your users rich experiences that display valuable data and manage important processes. However, since portals are run in a service that is separate from your Appian environment, there are some capabilities that work a little differently in portals.

Appian capabilities can be either compatible, partially compatible, or incompatible with portals:

• Compatible: Works with portals without a custom integration.
• Partially compatible: Works with portals using a custom integration to connect the portal to the Appian environment.
• Incompatible: Doesn't work in portals. However, there may be a workaround available that allows you to achieve a similar outcome.

Portal capabilities

The following table lists some common capabilities and whether they are compatible, partially compatible, or incompatible with portals. The compatibility of functions and components is also listed in the Appian Functions table. Keep this compatibility in mind when designing your portal to make sure you are using them in a way that works with portals.

Platform capability	Portals compatibility	How to use
Using a record type to write or query data	Compatible	To query data, in the portal interface, use a!queryRecordType() or a!queryRecordByIdentifier(). a!queryRecordByIdentifier() cannot query an unsynced service-backed record type from a portal. To write data, in the portal interface, use a!startProcess(). In the process, use the Write Record or Delete Record smart services.
Records-powered grids, charts, and selection components.	Compatible	Use the record type as the source for read-only grids, charts, and selection components (card choices, checkbox, dropdown, multiple dropdown, and radio button). For considerations when using read-only grids in a portal, see Using records-powered grids in a portal and this example.
Record actions, lists, and views.	Incompatible	Build a custom interface instead of using a record action, list, or view.
Starting a process.	Compatible	In a portal interface, use a!startProcess() in the saveInto parameter of a submit link or button.
Writing and querying data from a publicly accessible external database.	Compatible	-
Using a CDT to write or query data, including connecting to a database behind a VPN.	Partially compatible	Connect to a web API object using an integration object. From the web API, use an Appian function to write or query data in your database.
Uploading and downloading files.	Compatible	-
HTTP and OpenAPI connected systems using basic and API key authentication.	Compatible	-
HTTP and OpenAPI connected systems using AWS Signature Version 4, Google Service Account, and OAuth 2.0 authentication types.	Partially compatible	Connect to a web API object using an integration object. From the web API, call an integration object using the desired authentication type.
Pre-built connected systems.	Partially compatible	Connect to a web API object using an integration object. From the web API, call an integration object using the desired connected system.
Constants of type Application, Group, Group Type, Report, or Task Report	Incompatible	-
Appian functions.	See each function in the Appian Functions table for its compatibility with portals.	You can still leverage functions that are listed as partially compatible by connecting to a web API object using an integration object. From the web API, call the function. Don't use incompatible functions in a portal.
Function plug-ins.	Partially compatible	Connect to a web API object using an integration object. From the web API, call the function plug-in.
Interface components.	See each component in the the Appian Functions table for its compatibility with portals.	Don't use incompatible components in a portal.
Component plug-ins.	Incompatible	-
Appian-supported locales, time zones, and calendars.	Compatible	-
Rule inputs.	Compatible	Use rule inputs in any expression or interface used by a portal. Certain rule inputs can be used to set initial values for an interface using URL parameters or default values. See Use URL Parameters to Link to a Site or Portal for more information.
Decision objects.	Partially compatible	Connect to a web API object using an integration object. From the web API, call the decision object.
Tasks.	Incompatible - Your users should be authenticated if you need to send them a task.	-
Accessing the portal in the Appian Mobile application.	Incompatible	Access the portal from a mobile browser.
Offline mobile.	Incompatible	-
Using a portal as an embedded interface.	Incompatible	Link to the Portal from your website.
Restricting access to a portal using a VPN	Incompatible	-

Feedback