Difference between revisions of "Form:Use Case Definition"

From City Data Model Project Collaboratory
Jump to navigation Jump to search
(Created page with "<noinclude> This is the "Use Case Definition" form. To create a page with this form, enter the page name below; if a page with that name already exists, you will be sent to a...")
 
 
(39 intermediate revisions by the same user not shown)
Line 5: Line 5:
  
  
−
{{#forminput:form=Use Case Definition}}
+
{{#forminput:form=Use Case Definition|query string=namespace=UseCase&={{PAGENAME}}}}
  
 
</noinclude><includeonly>
 
</noinclude><includeonly>
Line 11: Line 11:
 
{{{for template|Use Case}}}
 
{{{for template|Use Case}}}
 
{| class="formtable"
 
{| class="formtable"
−
! Use Case Name:  
+
! Domain:
−
| {{{field|Use Case Name}}}
+
| {{{field|Domain|input type=dropdown|values=Smart Government, Smart Transportation, Smart Education, Smart Healthcare, Smart Home, Smart Campus}}}
 
|-
 
|-
−
! Use Case Description:  
+
! Summary:  
−
| {{{field|Use Case Description}}}
+
| {{{field|Summary|input type=textarea|mandatory|maxlength=280|placeholder=Short description (max 280 characters).
 +
The summary should identify the goal and one or more value proposition(s) in the form: «Verb» «direct object».}}}
 
|-
 
|-
−
! Data Flows:  
+
! Description:  
−
| {{{field|Data Flows}}}
+
| {{{field| Description |input type=textarea|mandatory|placeholder=A more extended description of the use case. It should provide sufficient context to provide insight into the data that needs to be exchanged and processed.}}}
 
|-
 
|-
−
! Required Classes:  
+
! Actors:  
−
| {{{field|Required Classes|values from category=Class|list}}}
+
| {{{field| Actors |input type=textarea|mandatory}}}
 
|-
 
|-
−
! Required Object Properties:  
+
! Basic Flow of Events:  
−
| {{{field|Required Object Properties|values from category=ObjectProperty|list}}}
+
| {{{field|Basic Flow of Events|input type=textarea|mandatory|placeholder=The sequence of events that occur during the normal flow of this use case with any notes.}}}
 
|-
 
|-
−
! Required Data Properties:  
+
! Flow Exceptions:
−
| {{{field|Required Data Properties|property=RequiresDataProperty|values from category=DataProperty}}}
+
| {{{field|Flow Exceptions|input type=textarea|placeholder=If applicable, highlighted alternative flow(s) of events that reveal the need for additional data to be exchanged among the actors of the use case.}}}
 +
|-
 +
! Information Requirements:
 +
| {{{field|Information Requirements|input type=textarea|placeholder=This is a very high-level description, for example, "origin location, destination location, and travel preferences". Details can be hashed out later and shown in the diagrams; this can be updated later to provide correspondence linkages to the defined data concepts in the Information View. While not technically required to define a use case, this field should be populated prior to beginning work on the data definitions.}}}
 +
|-
 +
! Required Classes
 +
| {{#ask:[[RequiredByUseCase::{{PAGENAME}}]] [[Category:Class]] |format=list}}
 +
{{#ask:[[-RequiresClass::{{PAGENAME}}]] [[Category:Class]] |format=list}}
 +
|-
 +
!
 +
| {{{field|Required Classes|input type=listbox|values from category=Class|multiple}}}
 +
|-
 +
! Required Object Properties
 +
| {{#ask:[[RequiredByUseCase::{{PAGENAME}}]] [[Category:ObjectProperty]] |format=list}}
 +
{{#ask:[[-RequiresObjectProperty::{{PAGENAME}}]] |format=list}}
 +
|-
 +
!
 +
| {{{field|Required Object Properties|input type=listbox|values from category=ObjectProperty|multiple}}}
 +
|-
 +
! Required Data Properties
 +
| {{#ask:[[RequiredByUseCase::{{PAGENAME}}]] [[Category:DataProperty]] |format=list}}
 +
{{#ask:[[-RequiresDataPRoperty::{{PAGENAME}}]] |format=list}}
 +
|-
 +
!
 +
| {{{field|Required Data Properties|input type=listbox|values from category=DataProperty|multiple}}}
 +
|-
 +
 
 +
! Issues
 +
| {{{field|Issues|input type=textarea}}}
 +
|-
 +
! Reference(s)
 +
| {{{field|References|input type=textarea| placeholder=Source materials used to develop this use case}}}
 +
|-
 +
! Relevant Specification(s)
 +
| {{{field|Specifications|input type=listbox|values from category=Specification|multiple}}}
 +
|-
 +
! Licensing Information:
 +
| {{{field|Scenario License|mandatory|input type=dropdown|values from category=License}}}
 +
<!-- crude initial set of pages defined in Category:License -->
 +
|-
 +
! Other Licensing Notes:
 +
| {{{field| Licensing Comments| input type=textarea}}}
 +
|-
 +
! Use Case Status:
 +
| {{{field|Use Case Status|input type=dropdown|mandatory|restricted|default=Pending Approval|values=Pending Approval, Approved, Closed}}}
 
|}
 
|}
 
{{{end template}}}
 
{{{end template}}}
  
−
'''Free text:'''
+
{{{for template|Supplementary Figures|label=Supplementary Figure(s)}}}
−
 
+
{{{field|Figure Row|holds template}}}
−
{{{standard input|free text|rows=10}}}
+
{{{end template}}}
−
 
+
{{{for template|Figure Row|label=Figure|multiple|embed in field=Supplementary Figures[Figure Row]}}}
 +
{| class="formtable"
 +
! Figure:  
 +
| {{{field|Figure|uploadable}}}
 +
|-
 +
! Caption:
 +
| {{{field|Caption|input type=text}}}
 +
|}
 +
{{{end template}}}
  
 
{{{standard input|summary}}}
 
{{{standard input|summary}}}

Latest revision as of 12:20, 18 July 2022

This is the "Use Case Definition" form. To create a page with this form, enter the page name below; if a page with that name already exists, you will be sent to a form to edit that page.



Retrieved from "http://citydatastandard.org/index.php?title=Form:Use_Case_Definition&oldid=31429"