This article provides detailed design information about the site design object, its configuration options, and how to design one. To learn more about what a site object is and how it is used, refer to the Sites article.
The Properties section allows designers to modify the primary site configurations that determine how users experience the site.
|Name||The name is displayed to users in the browser title bar.|
|Description||An optional description that is displayed to designers only.|
|Web Address Identifier||
The section of the site's URL that identifies it.
|Show site name on navigation bar||Option to show the site name on the navigation bar.|
|Show Tempo link in navigation menu||
Option to show or hide the Tempo link in the navigation menu.
|Show Record News||
Option to show or hide the news view on records.
|Show Task List (Mobile Only)||
Option to show a default task list in the Appian for Mobile Devices application.
The pages section allows designers to add, remove, modify, or re-order the pages that are displayed in a site. Designers can configure up to 5 pages per site.
The page title is displayed to users in the navigation bar.
|Web Address Identifier||
The section of the URL that identifies the page.
|Width||Determines the width of the content area for the page. Default is standard.|
|Icon||The icon displayed to users in the navigation bar.|
|Page Type||Indicates whether the page will contain an action, report (Tempo or task report), or record type.|
The name of the design object for the page content.
The branding section allows designers to customize the look and feel of a site. These configurations can be set as static values or dynamic values using expressions for greater flexibility.
You can preview your configurations for the site logo, colors, page icons, navigation bar style, and button shape in the Branding Preview.
The logo appears on the top right corner of the site and is automatically resized for use in the site.
|Logo Alternative Text||
The alternative text provided in this configuration is used for the logo's alt attribute and announced by screen readers. The value should describe the logo to visually impaired users, including any text that is part the logo.
The favicon (short for "favorite icon") is the small icon that appears in the browser tab or URL bar.
|Button Shape|| The shape applied to all buttons on all pages in a site. This includes all buttons for:
|Navigation Bar Style||
The style of the navigation bar of the site. The style determines if there are icons displayed with page titles in the tabs, which side the logo is on, and the selected highlight color. There are two styles;
|Navigation Bar Background Color||
The background color of the navigation bar of the site in web. The color of the app header, tab bar and status bar in iOS. The app header bar and navigation bar in Android.
|Selected Highlight Color||
The color of the selected tab or selected tab's underline in web and iOS.
Affects the color of many elements in all interfaces, including buttons, links, active field border colors, milestone bars, section titles, etc.
|Loading Bar Color||
The color of the bar at the top of the page that indicates when the system is processing.
You can configure a custom typeface for sites from the Aministration Console. Typefaces are universally applied to all sites on the environment.
You can create a new site object in Appian Designer. After creating it, simply open the site object to configure it.
Open the site object to edit the site's properties, configure the site contents, and add custom branding to the site.
The properties defined during the creation of the site can be updated when configuring the site. In addition, there are some additional properties that should be reviewed and updated as necessary. For further details on what each setting is, refer to the Properties section of this document.
Pages allow the developer to add content to the site. Each site can contain up to 5 pages that can be configured to show an action, a report (task report or Tempo report), or a record type. For further details on configuring a page, see Pages.
Use the branding section of the site to modify the site logo, favicon, button shape, navigation bar style, and colors. Check out the Branding Preview at the bottom of the page to get a better idea of what your site configurations and branding will look like.
For further details on configuring site branding, see Branding.
To save and test your site:
While creating a site is easy, there are some design considerations to keep in mind:
Designers should identify some guiding principals to how they will build sites. Will they be based on functional areas of the business? Will they be based on employee roles? Will they use a custom navigation experience?
Reports can be used to create pages that combine various content types (e.g. actions and reports) as well as create custom navigation experiences. This can be very effective for giving the users a good experience, but two considerations need to be take into account when using this approach. First, adding these reports will add to the list of reports in Tempo which may confuse Tempo users. Second, building the custom navigation experience does require additional planning and effort to be effective.
When configuring a site page for web users, consider updating the page width to match the content. For example, actions may have only a few fields and benefit from a narrow page width to avoid having the form look stretched. Another example is a dense report that can benefit from a wide page width or, if users have extra wide monitors, a full page width.
Configuring sites to show record news can help improve the collaboration around records. Users can collaborate on existing record news entries in sites, but not create new entries. However, records can be designed to include related actions that can generate new record entries via process.
Actions in sites can be designed to be available to iOS users while they are offline. Learn more about designing for offline mobile.
Safe links and news entry links will take the user out of the site, so consider this when designing sites that include them.
A user must have at least Viewer permissions to a site to access it. In addition, a user must have visibility to site pages and at least Viewer permissions to each report, record type, or process model configured as a site page's content.
The security role map of a site controls which users can see or modify it and its properties. By default, only the site creator and system administrators have access to the site. See Editing Object Security to modify a site's security.
The following table outlines the actions that can be completed for each permission level in a site's security role map:
|View the site||Yes||Yes||Yes|
|View the definition||Yes||Yes||Yes|
|View the security||Yes||Yes||Yes|
|Update the definition||Yes||Yes||No|
|Update the security||Yes||No||No|
|Delete the site||Yes||No||No|
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.
On This Page