Creating Applications

Overview

Create an Application

This lesson from the Introduction to Applications course walks you through the basic steps of creating a new application.

This page explains what Appian applications are and the two ways that you can create them:

Defining Applications

Applications are a collection of objects that make up a business solution. Appian recommends creating a dedicated application for every business solution. For example, Customer Relationship Management (CRM), Employee Onboarding, and Sales Opportunities would be three different applications.

To update an existing application, Appian recommends creating a package and deploying it to your environments.

For more information about working with applications, see the applications view page.

Creating Applications From Scratch

Create Your Application and Set Security

For a more in-depth walkthrough about creating applications, see the Application Building Tutorial.

To create an application from scratch:

  1. Click the New Application button in the toolbar.

  2. Configure the following properties:

    Property Description
    Name Enter a name that follows the recommended naming standard. The maximum length of the name is 255 characters.
    Description (Optional) Enter a brief description of the application's business purpose. The maximum length of the description is 2,000 characters.
    Application Prefix (Optional) Following the recommended naming standard, specify the short, unique prefix to use in all object names related to the application. For example: CRM for a customer relationship management application. The prefix must start with a letter and can only use letters, numbers, and underscores. The maximum length of the prefix is 10 characters.

    Appian constructs a default prefix using the initial characters of the first 10 words you entered in the Name property. You can retain, modify, or delete this default prefix.

    If you configure the Application Prefix property, Appian pre-populates this prefix in the Name fields for any new constants, interfaces, and rules you create.

    If your prefix duplicates an existing prefix, Appian displays a warning message. This message does not block the duplicate prefix, however, because there may be business cases where applications appropriately use the same prefix.

    You can update the Application Prefix in the application properties. If you change the Application Prefix after creating objects in an application, you cannot bulk update the names of existing objects with the new prefix. You must manually edit the name of each existing object.
  3. Configure security for the application:
    • Select a Permission Level for the Default (All Other Users) group.
    • For each existing group you want to add:
      • Click Add Users or Groups.
      • Browse to and select an existing group.
      • Select a Permission Level for that group.
    • For each new group you want to add:
      • Click Create New Group next to the empty User or Group box.
      • Configure properties for the new group, then click Create.

    Setting application security is important as it determines who has permission to view and edit the application's contents. Appian recommends adding at least one Administrator group and one Viewer group to your application's security role map. See the Object Security page to learn more about object security in Appian, security best practices, and how to configure, edit, and review security at any time.

  4. Click Save.

Once you've set security on your application, Appian will display the application view.

Note that new applications created from scratch are always unpublished by default and contain no objects. See the Create or Add Objects page to start building your business solution.

Create Application Actions

After creating your new application and adding objects to it, you may decide that you want to add application actions. Application actions are visible under the Actions tab of Tempo and allow users to start process models related to your application. For example, in a Vehicle Management application, you may have an application action called Loan Vehicle which kicks off a process model with a start form that allows users to start the loaning process.

Application actions can be created three ways: from the application view properties menu (image below), saved as an application action in an interface, and through the application builder. This section will focus on the first method, creating application actions via the application view properties menu.

To create an application action, you must first create a process model that allows a user to interact with the process and that contains either a start form, user input task, or some other attended node. Make sure to set appropriate security on your process model so that users will be able to start it. Appian recommends adding an Administrator group and at least one Initiator, Viewer, Manager or Editor group to the process model's security dialog.

Once you have created your process model, click on Application Actions in the application view properties dropdown. You can name and describe your action as it should appear in Tempo, and link your process model. Note that application actions will always appear in alphabetical order in Tempo.

Publish Your Application

Applications can be either published or unpublished. When created, applications are unpublished by default. This feature allows developers to show or hide application features, including application actions, in Tempo.

An application must be published in order for its application actions to appear in Tempo. Publishing an application has no effect on actions used in Sites or Embedded Interfaces.

To publish or unpublish your application, click the Settings menu in the application view and select Publish/Unpublish Application.

In Appian Designer, an application's icon will appear red when it is published, and grey when it is unpublished.

A published application will appear as a filter under Applications on the Actions tab of Tempo.

Creating Applications Using the Application Builder

The Application Builder is a feature of Appian Designer that creates an application with pre-defined set of objects. There are two different types: basic and full. Both sets of templates use the same paradigm to create applications, just with a different level of functionality.

Creating a Basic Application

A basic template from the application builder creates only the objects necessary to create, view, update, and delete the records in your app.

This template is especially useful if you want to jump start a brand new application. Instead of creating the base objects from scratch, this template will give you a basic application in a few minutes.

Creating a Full Application

A full template has all of the record functionality of a basic application, and also includes functionality for: audit history, collaboration, document management, task assignment, and reporting.

This template is useful if you had planned to implement this functionality in your application anyway. Otherwise, a basic application will likely be simpler to enhance and build out.

The Application Builder Wizard

After you select the template type and datasource from the Create New Application dialog, the Application Builder will launch. The Application Builder is a four-step wizard that will guide designers through the application creation process. Depending on whether a basic or full application was selected, the defaults within the Application Builder will change.

Name

On the first page, users name and describe their application.

Each app stores data in the form of Records in Tempo. We collect the singular and plural name not just because the record type requires them, but also so that we can name and describe other parts of the application in sensible ways. For example, an empty grid in Tempo would say that there are "No (plural entry name) available."

We use the first letter of each word in the application name to generate a prefix for the design objects in the application. For example, a rule in the Support Ticket Management application might be called "STM_GetSupportTicketById". This prefix is guaranteed to be unique among all Quick Apps and generated apps on the system.

Interface

On this page, users specify the fields of information they want to capture for each record. This serves as both data and interface design for the app, and provides the core of its unique design.

Users can create fields of the following types:

  • Text
  • Number (Decimal)
  • Paragraph
  • Date
  • Date and Time
  • Single selection from list (Dropdown, with user-specified text options)
  • Multiple selection from list (Checkbox, with user-specified text options)
  • Record (Record Picker, configured to a single record type)
  • User

Users can add the following configurations to fields.

  • Field requiredness
  • Instructional text to display below the field
  • Help tooltip to display next to the field label
  • Placeholder text to display within the field (not available for all field types)

Configurations display on forms, but not on the record dashboard.

When using the full template, three fields are pre-populated: Title, Status, and Priority. Of these, only Title is required (however, the name can be changed). When using the basic template, only the Title field is pre-populated.

A Preview Form option is available on this page. It shows how the currently configured values will manifest in the Action and Records of the completed application. Specifically, it offers a preview of the start form of the Action, and the Summary view of the record type. Users can use this to help design their application to look exactly as they want it to, without having to create it first and then update it to make changes.

Each field added on this page results in a new field on the main CDT of the application, with the following details:

  • For both Text and Paragraph fields, the interfaces generated enforce the database limit on character count, to prevent errors.
  • Paragraph fields are stored as additional lookup CDTs with a foreign key relationship made between it and the main CDT.
  • Number, Date, and Date and Time fields are each made into a CDT field of the same type, with no other special configurations.
  • Single and Multiple selection fields generate additional CDTs that are nested from the main CDT. These nested CDTs always have fields for the ID, value, and order of the selection options, as well as whether they are active or not.
  • Record fields store the identifier of the selected record, which means that they are either a Text or Integer field on the CDT, depending on the type of the identifier of the selected record type.
  • User fields are a Text field on the CDT.

Collaborators

On this page, users specify the people who should use the application. Additionally, for full template applications, designers can choose whether to make this a site-based application (default) or exposed through Tempo.

Collaborators have access to all application functionality.

The people selected at this step are added as members of a group, which is created to secure application activity to.

The application builder, will default for the full template to a sites-based application.

When you click Create Application on this page, your application will be created! Please allow up to a minute for generation of the application.

Finished

Once your application has been generated, the final page of the form will load. Links to your new functionality will appear.

Features of an Application Builder App

Each application is published immediately, and provides record-centric functionality to its users. Creating, viewing, modifying, and collaborating around the data in your records makes up the bulk of work enabled by the application's design. Details on each section of functionality are below.

Actions

Each application adds a single Action to the Actions tab, which allows users in the Collaborators group to create new records. This start form will match the preview available while creating the application.

Records

Each application has a record type that is the central hub for work done in the app.

Records for basic and full template applications will include:

  • A Summary view with all relevant record data.
  • View, update, and delete capabilities for any record in your app.
    • Creation occurs from the Actions tab.

For full templates only, each record will also contain:

  • An Activity History view. This view describes every action ever taken on or from this record. This includes creation, updates, file uploads and deletions, sending, completing, skipping tasks, and sending messages. You can search the grid for specific updates as well as filter by user.
  • Related Actions for task assignment and sending a message to someone about this record.
  • The Summary view also contains a grid of any currently-open tasks for the record.
    • Once completed, those tasks are recorded in the Activity History.

Tasks (Full Template Only)

For targeted alerts and requests, tasks can be sent from the record to any user on the system through a related action on the Summary view.

  • If the assignee is not already in the Collaborators group, the user sending the task will be informed of that and asked to confirm that they intend to send the task to that user. If and when they do, that user is added to the Collaborators group.
  • Deadlines can be set by the user who enters the task. The task remains available after the deadline, but displays as overdue in the task list.
  • Task forms display information about the record they were sent from and link to them. The only field to fill out on a task form is comments responding to the user who sent the task.
  • When a task is completed or skipped, an email is sent to the user who sent the task to notify them.

Reports (Full Template Only)

A report is generated for each application, containing four charts and a records grid.

  • The four charts are:
    • Top Record Creators: A bar chart showing the number of records created by the five users who have created the most records.
    • Record Creation Trends: A line chart showing how many records were created in each of the last six months.
    • Records by Status: A pie chart showing the number of records in each Status.
    • Records by Priority: A pie chart showing the number of records in each Priority.
  • The records grid shows a list of records on the system. It has up to eight columns showing the first eight fields in the application. The Title field is linked to the record, and other fields display as they do on the record dashboard.
    • A text field above the grid allows users to search records by any Text, Number, Paragraph, or Single Selection from list fields that appear in the records grid.
  • Each chart is clickable and filters the records grid below. That filter displays in a rich text field above the grid.
    • For example, clicking on a Status option will filter the records grid to display only records that are in that Status. The rich text field above the grid displays that filter and allows clearing it and the search field.
    • Filters can stack, so that all four charts can filter the grid at the same time, if desired.

News (Full Template/Non-Site Only)

The News tab is used to post messages to users of an application.

  • Users can send a message from any record through a related action on the Summary view, and may add an attachment.
  • The message is posted to News as a locked message to the Collaborators group.
  • It is tagged with the record, and so is also available in the News view of that record.

Sites (Full Template Only)

A site can be created using a full template.

images:application_builder_site

For pages will be added to the site:

  • Record—The first page is the application's record and will be named after the plural record name field in the application builder wizard.
  • New—Lets users create a new record.
  • Trends—Reporting metrics on record data.
  • My Tasks—Tasks assigned to you from the Send Task related action in the record.

Security

  • All application activity is secured to the Collaborators group.
  • Specifically, the Collaborators group is set as Viewers of most of the application objects, and as Editors in the document hierarchy so that they can successfully upload documents.
  • An Administrators group is generated for the application and set as Administrators of all objects. The initial membership of the group is the user who generates the application.

For more information about application security, see this page.

Internationalization

  • Each application is created in the locale of the user who created it. This means that any strings the system generates or configures in creating the application will be set to that locale, but user-provided strings will be displayed exactly as provided.
    • For example, in an application for Support Ticket Management, the Action will be called New Support Ticket. The word "New" is provided by the system and will be provided in the current user's locale, while "Support Ticket" is the entry name as provided by the user, and so the system uses it exactly as entered.
    • For this reason, we highly recommend that users build applications using the language their profile is currently set to. Otherwise, the application will be created with a mix of languages.
  • These applications are internationalized on creation, not at runtime, and will display the same values to every user.
Open in Github Built: Wed, Aug 16, 2023 (04:37:39 PM)

On This Page

FEEDBACK