Sites

Overview

Sites allow users to focus on a limited set of activities. Each site contains up to five pages, each of which is either an action, a report (Tempo or task report), or a record type, allowing users to do their work efficiently.

Sites as User Start Pages

For users who primarily or exclusively use a site to do their work, you can set the site or any page within the site as their start page when they first log in to Appian. To learn more about how to do this, see User Start Pages.

Designing Sites

Sites can be created in the Appian Designer and further configured in the site designer.

Create a New Site

  1. In Appian Designer, open the application that you want the site to be in.
  2. From the New menu, click Site. This will display the Create Site form.. image:CreateSiteModal.png
    • Name - The name is displayed to users in the browser title bar. The name is a required parameter.
    • Description - An optional description that is displayed to designers only.
    • Web Address Identifier - The section of the site's URL that identifies it. It appears in the URL and in log files for network devices and servers. The web address identifier must be unique across sites in your system.
  3. Click Create & Edit to create the site and to open the site designer to continue configuring it.

The site designer allows you to edit a site's properties, configure the contents of the site, and add custom branding for the site.

image:SiteDesignerWithBranding.png

In the above image, you can see we have a number of site pages already configured for our site. When there are multiple pages configured for a site, you can use the controls in the Pages grid to reorder the pages or to delete a page.

In the site designer, you can edit the site's name and description by clicking the site name in the header bar. This opens a dialog where you can edit these fields.

In the main body of the site designer, you can edit the web address identifier and configure up to five pages of content for the site.

Configure a Site Page

Each page within a site can be configured with an action, a report (task report or Tempo report), or a record type.

To add and configure a new site page:

  1. Click Add Page below the Pages grid.
  2. Fill in the Add Page dialog:
    image:SiteAddPageModal.png
    • Title - The page title is displayed to users in the navigation bar. The title is a required parameter. You can configure the value as a static string or as an expression.
    • Web Address Identifier - The section of the URL that identifies the page. The web address identifier appears in the URL and in log files for network devices and servers. The value must be unique across pages within the same site.
    • Icon - The icon is displayed to users in the navigation bar. The icon is a required parameter.
    • Page Type - Indicate whether the page will contain an action, report (Tempo or task report), or record type.
    • Page Content - Enter the name of the design object for the page content.
    • Visibility Determines whether the page is visible to basic users (system administrators are unaffected by this setting).
      • Select Always show to make the page visible to any user that has access to the site.
      • Select Only show when... to set the visibility with an expression. When the expression evaluates to true, the page will be visible.
  3. Click OK. The newly configured page appears in the Pages grid.
Actions must have a start form to be used in a site page. See the Process Start Form section of Process Models for more information.

Related actions based on quick tasks in process-backed records are not supported in sites.

Configure Site Branding

Under the Branding section of the site designer, you can configure the following settings:

  • Logo - The logo appears on the top right corner of the site and is automatically resized for use in the site. The logo file should be a JPG, PNG, BMP, JPEG or GIF file with a transparent background and must be less than 100KB. As an alternative to uploading an image, use an existing image within an Appian Document folder or Knowledge center. A third option is configuring the logo to point to a static image hosted on a separate web server. Use this option when your company web assets, such as logos, are hosted on a content delivery network. The default logo is the Appian logo.

  • Favicon - The favicon (short for "favorite icon") is the small icon that appears in the browser tab or URL bar. Provide an ICO file with sizes 16x16 and 32x32. Like the logo, the favicon file must be less than 100KB. The favicon can also be configured in three ways, upload a new one, use an existing one or point to an externally-hosted favicon file. Use this option when using a content delivery network. The default favicon is the Appian "A" icon.

  • Navigation Bar Background Color - The background color of the navigation bar of the site in web, app header, tab bar and status bar in iOS, and app header bar and navigation bar in Android. Provide a valid 3 or 6 character hex color value or use an expression that evaluates to a valid 3 or 6 character hex color value. The default value is #46708c.

  • Selected Tab Background Color - The background color of the selected tab in web and iOS. Provide a valid 3 or 6 character hex color value or use an expression that evaluates to a valid 3 or 6 character hex color value. The default value is #083d5c.

Click Save in the header bar to save any changes that you have made to the site configuration. To test the site, you can navigate directly to it by clicking on the URL in the Web Address field.

image:SiteEndUserBranding.png

To test your site on a mobile device, add an account to the Appian for Mobile Devices application with the full site URL as the server address.

image:iOSSiteServerAddress.png

Once you have added your account successfully, you will see the site.

image:iOSSiteRecordView.png

Security

Each site has a rolemap that specifies its viewers, auditors, editors, and administrators. Users must also have at least viewer rights to the task report configured for the site in order to use the site. By default, only the site creator and system administrators have access to the site.

To access the site's configuration and rolemap, users must also be in the designer role.

Users in each role are allowed to perform the following actions on the site:

Actions / Roles Administrator Editor Auditor Viewer
View site Yes Yes Yes Yes
View the configuration Yes Yes Yes Yes
View the security Yes Yes Yes No
Update the configuration Yes Yes No No
Update the security Yes No No No
Delete Yes No No No

Notes

The default security for a site is that users and groups that are not system administrators or explicitly in the rolemap do not have access to the site. However, you can change the default security for a site such that users have Viewer privileges by default.

Design Considerations

Actions in sites can be designed to be available to iOS users while they are offline. Learn more about designing for offline mobile.

When a user clicks a process task link to a SAIL task or a record link in a site, the respective task or record view opens within the site. However, if there is news entry link in a site, clicking it opens a new tab with the news entry in Tempo. In order to keep users within a site and not navigate them to Tempo, avoid the use of news entry links in sites.

Task Notifications

Email notifications that are sent to users when they are assigned a new task contain a link to the task in Tempo. If you don't want to navigate your site users to Tempo, you can disable these notifications for your environment. However, users can override the system setting by enabling these notifications in their personal settings.

See also: Configuring Notifications

Logging

The usage of sites is logged in <APPIAN_HOME>/logs/audit/sites_usage.csv. See Sites Usage Audit for details.

Sites metrics are logged in <APPIAN_HOME>/logs/data-metrics/sites.csv. See Sites Metrics Log for details.

FEEDBACK