AgileApps Support Wiki Pre Release

Difference between revisions of "Application Construction Wizard"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 3: Line 3:
# Enter the '''Application Name'''  
# Enter the '''Application Name'''  
#:
#:
# Choose the type of application:
# '''Application Type'''
#* '''Dynamic Case Management Application'''
#* '''Dynamic Case Management Application'''
#*: Create a {{^DCM}} application when your main object records (be they cases, investigations, or incidents) could be in one of several states. For example: Open, Pending, or Closed. (The need for state-dependent behavior is a prime indicator that a DCM application may be appropriate.
#*: Create a {{^DCM}} application when your main [[Object]] records (be they cases, investigations, or incidents) could be in one of several states. For example: Open, Pending, or Closed. (The need for state-dependent behavior is a prime indicator that a DCM application may be appropriate.)
#*:* '''Case Object Title'''
#*:* '''Case Object Title'''
#*:*: The default value is ''Cases''. Throughout the documentation, and when writing code, the object always goes by that name. But in the interface, it can display a label that is appropriate for the application. For example, ''Incidents'' or ''Investigations''.
#*:*: The default value is ''Cases''. Throughout the documentation, and when writing code, the object always goes by that name. But the interface can display a label that is appropriate for the application. For example, ''Incidents'' or ''Investigations''.
#*: ''Learn more:'' [{{DOCHOST}}/articles/BuildCaseMgtApp_AgileApps_Live.pdf Building a Case Management Application (pdf)]
#*: ''Learn more:'' [{{DOCHOST}}/articles/BuildCaseMgtApp_AgileApps_Live.pdf Building a Case Management Application (pdf)]
#*:
#*:
#* '''Database Application'''
#* '''Database Application'''
#*: A ''database application'' can have multiple objects with rich interconnections between them. It can also allow for collaboration by multiple parties.
#*: A ''database application'' can have multiple objects with rich interconnections between them. It can also allow for collaboration among multiple parties.
#*:
#*:
#:
#:
Line 17: Line 17:
{{:Common:Object Construction}}
{{:Common:Object Construction}}


When you're done, create the application:
When you're done specifying objects, create the application:
# Click '''[Create this Application]'''
# Click '''[Create this Application]'''
# Click '''[Open Application]''' to run it
# Click '''[Open Application]''' to run it

Revision as of 22:38, 3 July 2013

GearIcon.png > Customization > Applications > [Create New Application] > Create Using Wizard

  1. Enter the Application Name
  2. Application Type
    • Dynamic Case Management Application
      Create a DCM (Dynamic Case Management) application when your main Object records (be they cases, investigations, or incidents) could be in one of several states. For example: Open, Pending, or Closed. (The need for state-dependent behavior is a prime indicator that a DCM application may be appropriate.)
      • Case Object Title
        The default value is Cases. Throughout the documentation, and when writing code, the object always goes by that name. But the interface can display a label that is appropriate for the application. For example, Incidents or Investigations.
      Learn more: Building a Case Management Application (pdf)
    • Database Application
      A database application can have multiple objects with rich interconnections between them. It can also allow for collaboration among multiple parties.
  3. Enter the first Object name

Define an object:

  1. Click [Define Fields]
  2. Specify object labels:
    • Plural Label - The label used when the context is the object itself, or to the collection of records it contains
    • Singular Label - The label used when the context is a single record stored in the object
  3. For the Cases object, specify the label to use for the built-in subject and description fields (or use the defaults).
  4. Define up to 10 fields, to get started. (You can add more later.) For each field, specify:
    • Field Label - The label users will see.
    • Internal Field Name - The internal reference name. (Created for you. Modifiable, but generally best left alone.)
    • Field Type - Pick one of the many choices
  5. Follow the prompts to add additional information, depending on the field type.
  6. When done defining fields, click [Save]
For more, click [Add additional Object] and repeat the process.

Establish relationships between objects:

  1. Click [Add a Relationship]
  2. Under Relationships select the objects to fill in the blanks:
    Between __{baseObject}__ and __{relatedObject}__
  3. Specify the Relationship Type:
    • One to Many - One {baseObject} record can be related to many {relatedObject} records
      For example: One Order can have many OrderItems.
      This option adds a Lookup field to the {relatedObject} that targets the {baseObject}.
      Notes:
      • To make a One to One relationship, construct it as One to Many, and add a Unique Index to the target object to ensure that only one such record can ever exist.
      • To make a Master-Detail relationship, use the Cascade Rules to auto-delete detail records when a master record is deleted.
    • Many to Many - One {baseObject} record can be related to many {relatedObject} records, and each of the {relatedObject} records can be related to many {baseObject} records
      For example: One Order can have many Tags, and one Tag can be applied to many Orders.
The relationships cause Lookup fields to be added to the objects, with names like "related_to_X". For example, the OrderItems object will have a field named related_to_Orders.


When you're done specifying objects, create the application:

  1. Click [Create this Application]
  2. Click [Open Application] to run it