Form:Use Case Definition: Difference between revisions

From City Data Model Project Collaboratory
Jump to navigation Jump to search
No edit summary
No edit summary
 
(25 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"
! Domain:
| {{{field|Domain|input type=dropdown|values=Smart Government, Smart Transportation, Smart Education, Smart Healthcare, Smart Home, Smart Campus}}}
|-
! Summary:  
! Summary:  
| {{{field|Summary|input type=textarea|mandatory|maxlength=280|placeholder="Short description (max 280 characters).  
| {{{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>»."}}}
The summary should identify the goal and one or more value proposition(s) in the form: «Verb» «direct object».}}}
|-
|-
! Description:  
! Description:  
| {{{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."}}}
| {{{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.}}}
|-
|-
! Actors:  
! Actors:  
Line 22: Line 25:
|-
|-
! Basic Flow of Events:  
! Basic Flow of Events:  
| {{{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."}}}
| {{{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.}}}
|-
|-
! Flow Exceptions:  
! Flow Exceptions:  
| {{{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."}}}
| {{{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:  
! 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."}}}
| {{{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}}}
|-
|-
! Scenario Licensing:  
! 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}}}
| {{{field|Scenario License|mandatory|input type=dropdown|values from category=License}}}
<!-- crude initial set of pages defined in Category:License -->
<!-- crude initial set of pages defined in Category:License -->
Line 36: Line 70:
! Other Licensing Notes:
! Other Licensing Notes:
| {{{field| Licensing Comments| input type=textarea}}}
| {{{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}}}


{{{for template|Supplementary Figures|label=Supplementary Figure(s)|multiple}}}
{{{for template|Supplementary Figures|label=Supplementary Figure(s)}}}
{{{field|Figure Row|holds template}}}
{{{end template}}}
{{{for template|Figure Row|label=Figure|multiple|embed in field=Supplementary Figures[Figure Row]}}}
{| class="formtable"
{| class="formtable"
! Figure(s): Include any figures needed to assist the user in better understanding the scenario. Any figures should be explained and referenced by either the description or the flow of events.
! Figure:  
| {{{field|Figure|uploadable}}}
| {{{field|Figure|uploadable}}}
|  
|-
! Caption:
| {{{field|Caption|input type=text}}}
|}
|}
{{{end template}}}
{{{end template}}}

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.