(Example) Create and Run a Form-Based Application with AgilePoint NX Data Entities

This example shows how to create and run a form-based app that uses an entity in AgilePoint NX Data Entities as its data source.

Video: Form-Based App Overview

Note: The example shown in the video is not the same as the example shown in the example procedure. The video and the procedure provide 2 different examples to help you get started with AgilePoint NX applications.

Video: Know Your App Builder IDE

Prerequisites

Good to Know

Step 1: Create a Form-Based Application

The first step is to create a form-based app that uses an entity in AgilePoint NX Data Entities as its data source.

How to Start

  1. Click Build Apps Build Apps icon.

    Build Apps screen

Procedure

  1. On the Application Explorer screen, click Add App.

    Add App button
  2. On the Application Type screen, click Form-Based Application.

    Application Type screen
  3. Click Next.
  4. On the New Application screen, in the Application Name field, enter Customer Request Application.

    New Application screen
  5. Click Next.
  6. On the Select Primary Data Source screen, select Data Entity Data Entity icon.

    Select Primary Data Source screen
  7. Click Next.
  8. On the AgilePoint Data Entity Configuration screen, in the Data Source Name field, enter CustomerRequestEntity.

    AgilePoint Data Entity Configuration screen
  9. In the Primary Entity Name field, select Customer Request.

    AgilePoint Data Entity Configuration Primary Entity Name screen
  10. Click the Fields tab.

    AgilePoint Data Entity Configuration Fields tab
  11. On the Fields tab, select these fields:
    • Display Name
    • Customer Id
    • Date Of Birth
    • EmailId
    • First Name
    • Gender
    • Last Name

    AgilePoint Data Entity Configuration Fields List screen
  12. Click Finish.
  13. On the Information screen, Click OK.

    Information screen

    The eForm Builder opens the Form Settings screen for the Create form, New Customer Request.


    Form Settings screen

Step 2: Create an eForm

Create an eForm in the eForm Builder.

Good to Know

Procedure

  1. On the Form Settings screen, click General tab.

    Form Settings screen
  2. On the General tab, in the Form Title field, enter Customer Details.

    Form Settings General tab
  3. To save the changes, click Close Screen Close Screen icon.

    The eForm Builder opens the eForm.


    Customer Details Form screen

Step 3: Add Form Controls to the eForm

Add form controls to the eForm.

Good to Know

  • In a form-based application, form controls are mapped to fields from the data model in the associated data source. In this example, the form controls are mapped to fields in the associated entity.

Procedure

  1. On the Data Model screen, in the dataSource list, drag the FirstName variable onto your eForm.

    Customer Details screen
  2. Drag the LastName variable onto your eForm.

    Customer Details Last Name screen
  3. Drag the Date Of Birth variable onto your eForm.

    Customer Details Date of Birth screen
  4. Drag the Gender variable onto your eForm.

    Customer Details Gender screen
  5. Drag the EmailId variable onto your eForm.

    Customer Details Email ID screen

Step 4: Publish the App

Publish the application so users can run it.

Procedure

  1. On the Save quick menu, click Save and Check In Save and Check In icon.

    Save and Check In screen

    The eForm Builder closes, and the Application Explorer opens.


    Application Explorer screen
  2. On the Application Explorer screen, click the Update Customer Request form.

    Configuration for the Update form is required before you can publish the application. This example uses an Update form that is the same as the Create form. However, you can change it if necessary.


    Application Explorer Update Customer Request screen
  3. On the Warning screen, click Yes.

    Warning screen
  4. On the Save quick menu, click Save and Check In Save and Check In icon.

    Save and Check In screen

    The eForm Builder closes, and the Application Explorer opens.


    Application Explorer screen
  5. On the Application Explorer screen, click Publish Publish icon.

    Application Explorer Publish screen
  6. On the Information screen, click Check In.

    Information screen
  7. On the Check In Pending Changes screen, click Check In.

    Check In Pending Changes screen
  8. On the Publish Application screen, click Publish.

    Publish Application screen
  9. On the Information screen, click Close.

    For information about application permissions, refer to Change Application Permissions (App Builder).


    Information screen

    The eForm Builder opens the Application Explorer screen.


    Application Explorer Opens screen

Step 5: Start the App

After your application is published, you can run it.

Procedure

  1. On the AgilePoint NX Portal, click Work Center Work Center icon.

    Work Center screen
  2. On the Work Center screen, click My Applications My Applications icon.

    My Application screen
  3. On the My Application screen, click Customer Request Application.

    Customer Request App
  4. The View form shows. This is the screen where users can add or change records in the application.

    Customer Request Form

Step 6: Complete the eForm

Complete the eForm.

Procedure

  1. On the My First Form-Based Application screen, click Add Add icon.

    My First Form Based Application screen
  2. On the Customer Details Form screen, in the First Name field, enter Jane.

    Customer Details Form screen
  3. In the Last Name field, enter Jackson.

    Customer Details Form Last name screen
  4. In the Date Of Birth field, select 09/04/1990 from the calendar.

    Customer Details Form Date of Birth screen
  5. In the Gender field, enter Male.

    Customer Details Form Gender screen
  6. In the EmailId field, enter jane.jackson@gmail.com.

    Customer Details Form Email ID screen
  7. Click Submit.

    The View form shows. the name you entered in the records list.


    View Form screen

Step 7 (Optional): Change the eForm Data

Optionally, you can change the data you entered in the Create form.

Good to Know

  • This step uses the Update form that was configured in the Publish step. In this example, the Update form looks the same as the Create form, but behind the scenes, they are different eForms. You can change the Update form if necessary.

Procedure

  1. Select the record with the value Jane.

    Update Form screen
  2. Click Edit Edit icon.

    Update Form Edit screen
  3. In the First Name field, change the value to John.

    Customer Details screen
  4. Click Submit.

    The View form shows the data in the records list with the new value, John.


    View Form screen