Working with Data in a Portal

The capabilities described on this page are included in Appian's standard capability tier. Usage limits may apply.

Overview

For your portal users to complete their workflows and tasks with ease, they'll likely need to enter or view data within your portal. Writing and querying data in a portal allows you and your users to easily get and share information.

For example, users may need to view data, like:

Checking the status of their in-flight processes.
Viewing information about your products or services.
Searching public records.

Or they may need to add or update data through actions, such as:

Filling out a questionnaire.
Responding to an anonymous survey.
Requesting rebates or services.
Applying for grants.
Kicking-off their own onboarding process.

While you're reaching a broader audience with more information, you still need your data to stay safe. The isolated architecture of Appian Portals gives you peace of mind while allowing portal users to query and write data from Appian.

The best way to work with data in portals is using record types. However, you can also write and query data using CDTs, as long as you create a custom integration using a web API and integration object. And, if you have a publicly-available external database, you can directly write to or query from the database. See Working with Data in Appian to help you understand when to use a record type and when to use a CDT.

This page walks through how to work with data using all of the methods available from a portal.

Working with data using record types

Record types make it easy to work with your data in portals. Use them to:

Query record data: Use a!queryRecordType() or a!queryRecordByIdentifier() directly in your portal interface, or use a record type as the source for read-only grids, charts, and card choices. See Recipes querying records for examples.
Write record data: Use a!startProcess() in your portal interface, along with the Write Records or Delete Records smart services in your process model.

Tip: You can also use a!startProcess() in a portal interface to perform anything else possible with a process model, like creating a user or sending an email. You can use these same steps to create a portal that starts any other Appian process.

Let's look at some ways to use records in a portal.

Query record data

When querying record data in a portal, be sure to:

Grant permissions to the record data.
For read-only grids, remove incompatible record components.

Grant permissions to the record data

Ensure the portal can access the record data by giving the portal service account Viewer permission to the record type. This ensures portal users can view the queried data.

For more granular control over which records can be viewed in the portal, consider configuring record-level security.

For read-only grids, remove incompatible record components

When you create a records-powered grid, it may automatically add certain record components that are incompatible with portals, such as record links and record actions. If these components are automatically added to the read-only grid, remove them.

For example, the following expression won't work in a portal because the record link component is incompatible with portals.

a!gridColumn(
  label: "Project Name",
  sortField: recordType!DOT Project.fields.projectName,
  `value: a!linkField(`
    `links: {`
      `a!recordLink(`
        `label: fv!row[`recordType!DOT Project.fields.projectName`],`
        `recordType: `recordType!DOT Project`,`
        `identifier: fv!identifier`
      )
    }
  )
)

To update it to work in a portal, simply remove the record link.

a!gridColumn(
  label: "Project Name",
  sortField: recordType!DOT Project.fields.projectName,
  `value: fv!row[`recordType!DOT Project.fields.projectName`]`
)

Write record data

The best way to create, update, and delete data from a portal is using the Write Records and Delete Records smart services. You can kick off a process containing these nodes by using the a!startProcess() function in the saveInto parameter of a portal interface.

Tip: This works beyond writing records—you can use any smart service in a portal by using a!startProcess() in a portal interface.

To create, update, or delete record data via a portal:

Create a process model that uses the Write Records or Delete Records smart services to modify a record.

Tip: See the Process Modeling Tutorial for a walk through of setting up a process model.
Create an interface for your portal. Ensure you follow Portal Best Practices.
In the saveInto parameter of a component in the portal interface, use the a!startProcess() function to start the process you created.

Tip: See the interface example for an example of how to configure a form interface for your portal using the portal best practices.
Create a portal.
Grant the portal service account:
- At least Viewer permissions to the record types that are being updated or referenced. For more granular control over which records can be viewed in the portal, consider configuring record-level security.
- At least Initiator permissions to the process model that is updating the record.
Publish the portal and test that the portal starts the process and writes the data correctly.

Interface example: Writing record data in a portal

Here is an example of an interface that adds and updates data in a Project record type. It is similar to the default create or update record action interface, but is different in the following ways:

Since record pickers aren't compatible with portals, we are using a dropdown field to select the project status.
Since the form won't automatically clear and display a confirmation message after the user submits it, we manually added a confirmation message.

Record type references are specific to each record type and environment. If you copy and paste this expression, update the record type reference to reference a record type from your own environment.

/* You must create 3 rule inputs to use this example: */
/* 1. Name: record, Type: The record you are using */
/* 2. Name: cancel, Type: Boolean */
/* 3. Name: isUpdate, Type: Boolean */
a!localVariables(
  local!submitted: false,
  /* This queries a Project Status record type to populate the dropdown component with the status options */
  local!status: a!queryRecordType(
    recordType: recordType!Project Status,
    fields: {
      recordType!Project Status.fields.value,
      recordType!Project Status.fields.id
    },
    pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 50)
  ).data,
  if(
    local!submitted = false,
    a!formLayout(
      label: if(
        ri!isUpdate,
        "Update Project",
        "Add Project"
      ),
      contents: {
        a!columnsLayout(
          columns: {
            a!columnLayout(
              contents: {
                a!textField(
                  label: "Name",
                  labelPosition: "ABOVE",
                  value: ri!record[recordType!Project.fields.name],
                  saveInto: ri!record[recordType!Project.fields.name],
                  characterLimit: 255,
                  required: true
                )
              }
            ),
            a!columnLayout(
              contents: {
                a!dropdownField(
                  /* Because the record picker component is incompatible with portals, 
                  we manually set up a dropdown component using the local!status query */
                  choiceLabels: local!status[recordType!Project Status.fields.value],
                  choiceValues: local!status[recordType!Project Status.fields.id],
                  label: "Status",
                  placeholder: "--- Select a value ---",
                  value: ri!record[recordType!Project.fields.statusId],
                  saveInto: ri!record[recordType!Project.fields.statusId]
                )
              }
            )
          }
        )
      },
      buttons: a!buttonLayout(
        primaryButtons: {
          a!buttonWidget(
            label: if(ri!isUpdate, "Update", "Add"),
            saveInto: a!startProcess(
              /* Replace this with a constant that points to your process model */
              processModel: cons!ADD_PROJECT,
              processParameters: {
                /* This parameter name must match the name of the process variable 
                from the process model */
                record: ri!record
              },
              onSuccess: {
                /* Sets local!submitted to true so that a confirmation message can display, 
                instead of the form */
                a!save(local!submitted, true),
              }
            ),
            style: "SOLID",
            validate: true,
            loadingIndicator: true
          )
        },
        secondaryButtons: {
          a!buttonWidget(
            label: "Cancel",
            value: true,
            saveInto: ri!cancel,
            style: "OUTLINE",
            validate: false
          )
        }
      )
    ),
    /* Success message that displays when local!submitted=true */
    {
      a!richTextDisplayField(
        labelPosition: "COLLAPSED",
        value: a!richTextItem(
          text: "Project added.",
          size: "MEDIUM_PLUS",
          style: "STRONG"
        ),
        align: "CENTER"
      ),
      a!richTextDisplayField(
        labelPosition: "COLLAPSED",
        value: a!richTextItem(
          text: "Thank you for submitting a new project."
        ),
        align: "CENTER"
      ),
      /* This link reopens the form */
      a!linkField(
        labelPosition: "COLLAPSED",
        align: "CENTER",
        links: {
          a!safeLink(
            label: "Add another project.",
            uri: a!urlForPortal(
              /* Replace this with a reference to your portal */
              portalPage: portal!Portal.pages.add-project
            ),
            openLinkIn: "SAME_TAB"
          )
        }
      )
    }
  )
)

Working with data using CDTs

If there are scenarios where you cannot use record types, you can query and write data using custom data types (CDTs) and data stores.

To work with CDTs in a portal, you can call an integration object in the portal interface to request to write to or query data from Appian. The integration talks directly to a web API in Appian, which completes the request and sends a response back to the integration in the portal.

The integration and web API form a bridge that connects your portal to Appian and allows data to pass through. The integration is on one side—in your portal—and the web API is on the other side—in Appian.

The diagram below shows how the portal and Appian work together to allow for the flow of data, without the use of records.

diagram of the Portals architecture, depicting the connection between the portal and the Appian applications described above

Querying data using CDTs

You can query data in your portal using a CDT by creating a custom integration using a web API, integration object, and connected system.

This section outlines how to query data in a portal using a CDT and data store.

Step 1: Create a web API

You'll first need to create a web API that queries your data store. This is pretty simple since you can use an API template that automatically populates some common fields and selections to start you out.

To create a web API:

Create a constant that points to your data store.
Create a web API using the Query Data Store template.
- Note: This template gives query results formatted in JSON, which you'll convert to an Appian value in your integration object.

For general help creating a web API, check out Creating web APIs. For help creating a web API that queries data, go through the web API Tutorial, which walks you through creating a web API that queries a record type.

Step 2: Create an API key and service account

In order to connect to the web API, you'll need an API key that is associated with a service account.

To create a new API Key:

In the Admin Console, go to the Web API Authentication page.
On the API Keys tab, click Create.
Enter a unique Description.
Select a Service Account to associate with the key. To create a new service account:
- Click Create Service Account .
- Enter a username and click CREATE.
  - Tip: "Service Account" will automatically be added to the end of the service account name. See Service accounts.
Click CREATE.
Copy the API Key and store it externally. Appian will never show the value of the API key a second time.
Repeat these steps in each environment, making sure the following are the same in each environment:
- API key Description.
- Service account Username.
- Service account permissions and group membership.

In order to query data, the service account needs to have Viewer permissions to the web API and data store.

To give your service account the appropriate access:

Add the service account to a user group in your application.
Give the group Viewer permissions to the web API and data store.

You can use the same service account that you set up with your API key as the portal service account that you add in the portal object. Just be sure to use the same service account to grant the required permissions to other design objects used in your portal.

Step 3: Create a connected system

Now you need to add your API key and credentials to a connected system to use with the integration.

To create a connected system for authentication:

Create a new HTTP connected system.
For Authentication, select API Key.
For Header, enter appian-api-key.
For Value, provide the API key from when you created the API key.

Step 4: Create an integration object

Once you've created your API and authentication objects, create an integration object that is set up to query data using the connected system that you just created.

To configure your integration:

In the Connection section, configure the following fields:
- Select Use a connected system and choose the connected system you created in Step 3.
- For URL, enter the web API URL as the endpoint for the integration.
- For Method, select GET.
In the Response section, for Response Body Parsing, select Convert JSON to Appian value.
Click TEST REQUEST and verify the result that is returned.

Note: If there are unexpected question marks (?) in the response body, it may be because you need to modify the header parameter in the a!httpResponse() function of the web API expression to handle special characters. See this Knowledge Base article for more information.

For more help, see Create an Integration.

Step 5: Call the integration from your portal interface

In your portal interface, call your integration. Cast the dictionary results returned by your integration into the CDT that you're using for your data. This will let you easily reference your queried data throughout your portal without extra formatting.

Tip: Instead of casting your integration results from a dictionary to a CDT directly within your interface, you have the option to create individual or reusable expression rules to cast your integration results. You would then call the integration from your interface and wrap it in the expression rule.

Example: Cast integration results to CDT in a portal

Using local variables within an interface, you can cast your integration results from a dictionary to whichever CDT you're using to work with your data.

a!localVariables(
  local!data: cast(
    type!myCDT,
    rule!myQueryIntegration().result.body
  ),
  a!gridField(
    data: local!data
  )
)

For further examples, check out calling an integration to query data.

Step 6: Test your portal

After creating a portal object, adding the interface, and publishing the portal, be sure to fully test the published portal.

Step 7: Deploy your portal

When you deploy a published portal to another environment, Appian will attempt to publish the portal in the target environment.

See Publish a portal through deployment for instructions on how to make sure your portal will automatically publish when you deploy it.

Writing data using CDTs

You can write data from your portal using a CDT by creating a custom integration using a web API, integration object, and connected system.

This section outlines how to write data from a portal using a CDT and data store.

Step 1: Create a web API

You'll first need to create a web API that writes data directly to your data store. This is pretty simple since you can use an API template that automatically populates some common fields and selections to start you out.

To create a web API:

Create a constant that points to your data store.
Create a web API using the Write to Data Store template.
- Note: This template casts the body of your integration first to a dictionary and then to the CDT you're using for your data. This casting becomes relevant later on when setting up your integration.

If you need help creating a web API that writes data, go through the Web API Tutorial Level II, which walks you through creating a web API that writes data to a record type.

Step 2: Create an API key and service account

In order to connect to the web API, you'll need an API key that is associated with a service account.

To create a new API Key:

In the Admin Console, go to the Web API Authentication page.
On the API Keys tab, click Create.
Enter a unique Description.
Select a Service Account to associate with the key. To create a new service account:
- Click Create Service Account .
- Enter a username and click CREATE.
  - Tip: "Service Account" will automatically be added to the end of the service account name. See Service accounts.
Click CREATE.
Copy the API Key and store it externally. Appian will never show the value of the API key a second time.
Repeat these steps in each environment, making sure the following are the same in each environment:
- API key Description.
- Service account Username.
- Service account permissions and group membership.

In order to write data, the service account needs to have Viewer permissions to the web API and data store.

To give your service account the appropriate access:

Add the service account to a user group in your application.
Give the group Viewer permissions to the web API and data store.

Step 3: Create a connected system

Now you need to add your API key to a connected system for the integration.

To create a connected system for authentication:

Create a new HTTP connected system.
For Authentication, select API Key.
For Header, enter appian-api-key.
For Value, provide the API key from when you created the API key.

Step 4: Create an integration

Once you've created your API and authentication objects, create an integration that is set up to modify data using the connected system that you just created.

To configure your integration:

On the right side under RULE INPUTS, add the CDT that you're using for your data as a rule input.
In the Connection section, configure the following fields:
- Select Use a connected system and choose the connected system you created in Step 3.
- For URL, enter the web API URL as the endpoint for the integration.
- For Method, select POST.
In the Request Body section, do the following:
- For Content Type, select JSON.
- Call your rule input into the request body of your integration.
In the Automatic Output Parsing section, make sure Automatically convert CDT, dictionary, or list to JSON is selected. This converts your integration results from the CDT in your rule input into JSON, which will then be converted to a dictionary and back into your CDT when it's called into your web API.

For more help, see Create an Integration.

Step 5: Call the integration from your portal interface

Next, call your integration from your portal interface. For examples on how and where to call your integration in the portal, check out Calling an Integration to Modify Data.

Step 6: Test your portal

After creating a portal object, adding the interface, and publishing the portal, be sure to fully test the published portal.

Step 7: Deploy your portal

When you deploy a published portal to another environment, Appian will attempt to publish the portal in the target environment.

See Publish a portal through deployment for instructions on how to make sure your portal will automatically publish when you deploy it.

Working with data in a publicly-accessible external database

The best way to work with data in portals is using record types. However, you also have the option of directly connecting to a publicly-available external database.

There are a couple of reasons why you might want to take this approach:

Scalability: When you connect directly to an external database, calls to the database don't pass through Appian. This means that your portal isn't bound to scalability of Appian. Instead, it is bound by the scalability of the database.
Isolation: When you connect directly to an external database, your portal is not connected to your Appian applications via web APIs and integrations. During heavy usage, this isolation means that you don't have to worry about a lot of web API calls from your portal impacting the performance of your Appian applications.

In order to connect a portal in this way, the database you're connecting to must meet the following criteria:

It must be a supported external database.
It must not be behind a VPN.
It must be accessible at a public IP address.

This section explains how to directly connect to an external database to query or write data in your portal.

Step 1: Set up your external data source

To set up your external data source to query or write data:

Provide a supported database that can be accessed at a public IP address.
Create a data source connected system to connect to the database.
Create a corresponding data store object.

Step 2: Set up your service account

To write and query data in the external database, you need to give the portal the appropriate permissions to the data store. This is done using a service account, which acts on behalf of your portal users.

In order to write and query data, the service account needs have Viewer permissions to the data store.

To give your service account the appropriate access:

In the portal object, add a service account.
Add the service account to a user group in your application.
Give the group Viewer permissions to the data store for the external database.

You can only link one service account in the portal object. If you're using a service account to give access to records, processes, or documents, use the same service account for the data store.

Step 3: Set up your portal interface

In your portal interface, use a!writeToDataStoreEntity(), a!writeToMultipleDataStoreEntities(), a!deleteDataStoreEntity(), and/or a!queryEntity() just as you normally would in Appian.

If you are querying data, we recommend that you cast the dictionary returned from your query to a CDT.

Be aware that any calls to your external database go directly to the database and don't pass through Appian.

Step 4: Provide connection information in the import customization file

When you deploy your portal object to a different environment, include an import customization file (ICF) in the app or deployment package. In the ICF, provide your data source connected system credentials.

For more information on publishing and deploying portals, see Manage a Portal.

For more information on deploying data source connected systems, see Deploying data source connected systems.

Feedback

Was this page helpful?