Wiki Based SUM Template
Note: Look on the e-Framework website for newer templates.
%< cut here %<
e-Framework Service Usage Model - ?Name?
- Name
- Version
- Rationale
- Classification 1
- Notation [optional]
- Description
- Business Process Modelling
- SUM Diagram
- Usage Scenarios [optional]
- Applicability [optional]
- Functionality
- Structure & Arrangement
- Applicable Standards [recommended]
- Design Decisions & Tradeoffs [optional]
- Implementation Guide & Dependencies [optional]
- Known Uses [optional]
- Data Sources Used
- Related SUMs [optional]
- Services Used
- CORE SUMs Used [recommended]
- References
- Terms [optional]
Name
Provide a simple, informative name for the Service Usage Model (SUM).
- Name: ?name of service usage model?
- Alternative Names: ?alternative names?
Version
Provide the e-Framework Service Usage Model Version for this description.
- ?version number?
Version History
Include requested information about all versions of this document.
| Version | Date | Author | Description | Organization / Project |
| v1.0 | dd-mon-yyyy | Initial Draft | ||
Rationale
Briefly summarise the intended use of the SUM; justify including it in the e-Framework.
?type text here?
Classification 1
Type an "X" in the brackets next to the most appropriate choice for each category. Required categories are shown in Bold; any non-required categories that are not used may be deleted.
To be provided by the submitter:
| SUM Type | [ ] Domain | [ ] CORE (a commonly recurring SUM; designation requires e-Framework Integrity Group approval) | ||
| Domain(s) | [ ] Learning & Teaching | [ ] Research [ ] Libraries | [ ] Administration [ ] IT Services | [ ] Common |
| Maturity | [ ] Immature | [ ] Mature | ||
| Purpose(s) | [ ] Exemplar | [ ] Application | [ ] Modelling | [ ] Toolkit |
| XOR (exclusive "or") | [ ] Service Genres | [ ] Service Expressions | ||
| Development Status | [ ] Proposed | [ ] Developmental | [ ] Prototype | [ ] Production |
| Deployment Scale | [ ] Isolated | [ ] Ubiquitous | ||
| State Behaviour | [ ] Stateful | [ ] Stateless | ||
| Transactional Behaviour | [ ] Transactional and ACID | [ ] Transactional but Non ACID | [ ] Non-Transactional | |
| Batch Behaviour(s) | [ ] Individual | [ ] Batch | ||
| Time-Constraint Behaviour | [ ] Hard Real Time | [ ] Soft Real Time | [ ] None | |
| Service End Point | [ ] Provider | [ ] Requestor | [ ] Transcoder (both requests and provides) | |
| Authentication/Authorization Dependency | [ ] Auth-Dependent | [ ] Auth-Independent | ||
| Protocol Binding(s) (only applies to service expression-based SUMs) | [ ] Web Service [ ] SOAP | [ ] REST [ ] HTTP | [ ]Other |
To be determined by the e-Framework:
| Status | [ ] Approved | [ ] Placeholder [ ] Unapproved | [ ] Superseded [ ] Withdrawn |
| Confidence Level | [ ] High | [ ] Medium | [ ] Low |
Notation [optional]
List and explain the conventions and terminology used that are essential for understanding the rest of the Service Usage Model description. A complete list should be included in Terms (below).
?type text here?
Description
Write an informal, non-technical narrative describing what the Service Usage Model does and how it does it: the problem it addresses and its intended function, business-level capabilities and basic workflow.
?type text here?
Business Process Modelling
Summarise the business analysis motivating the Service Usage Model and provide a link to the full analysis. Then outline the business function(s) and process(es) that the Service Usage Model supports to provide context for its Functionality, but do not go into detail about system functions, services or workflows.
?type text here?
SUM Diagram
Provide a diagram that is similar to the Generic SUM diagram used on the e-Framework website. Include only the SUM diagram here; the narrative explaining the diagram belongs in "Structure & Arrangement". When submitting this completed document, also upload the diagram graphics as a separate file, or combine the file with this document to upload as a ZIP file. (Attach the diagram and link here using the Image macro.)
Usage Scenarios [optional]
Briefly describe one or more applications that use the Service Usage Model or give examples of business scenarios that use the SUM’s workflows.
?type text here?
Applicability [optional]
Provide a detailed explanation about how and when the Service Usage Model is to be used or not used; include specific constraints and assumptions.
?type text here?
Functionality
Outline the individual system functions that the Service Usage Model provides in terms of messages, data (documents) and steps within the individual functions; include constraints and conditions but do not include implementation-specific information. If appropriate, include an illustration of how the functions work together via their related data and processes
?type text here?
Structure & Arrangement
Outline the services, data sources and coordination that underlie all the individual functionalities in the Service Usage Model. Describe how the functions are integrated at the service level as a whole system.
?type text here?
Applicable Standards [recommended]
List the standards that pertain to the functionality of the Service Usage Model as a whole; provide the name, version and citation link (to the JISC Standards Catalogue if possible). Note any conformance requirements and extensions.
?type text here?
Design Decisions & Tradeoffs [optional]
Describe the decisions involved in designing the Service Usage Model. Limit the discussion to the design of the overall Service Usage Model; do not discuss internal details of the services or specific applications.
?type text here?
Implementation Guide & Dependencies [optional]
Describe all anticipated issues that may affect the implementation of applications that use the Service Usage Model, such as the organisation, performance, behaviours, representations and policies.
?type text here?
Known Uses [optional]
List the known implementations or uses of the Service Usage Model by any applications or systems. List other Service Usage Models that incorporate, use or are dependent on this Service Usage Model.
?type text here?
Data Sources Used
Provide the names and descriptions of all data sources used in the Service Usage Model.
?type text here?
Related SUMs [optional]
List the names and versions of other Service Usage Models that are used within this Service Usage Model to build the functionality.
?type text here?
Services Used
List the names and versions of the Service Genres XOR Service Expressions that this Service Usage Model is based on.
?type text here?
CORE SUMs Used [recommended]
List the names and versions of all Commonly Recurring (CORE) SUMs that this Service Usage Model is based on.
?type text here?
References
List references and bibliographic citations to works needed to understand the Service Usage Model.
?type text here?
Terms [optional]
List and define the domain-specific terms used in documenting the Service Usage Model.
?type text here?
Footnote
1 See definitions of the Service Usage Model Classification Scheme categories and their allowable choices at: http://www.e-framework.org/Services/ServiceClassificationScheme/ClassificationSchemeForSUMs/tabid/817/Default.aspx
This SUM is licensed under:
Creative Commons Attribution-Noncommercial-Share Alike 2.5 licence
http://creativecommons.org/licenses/by-nc-sa/2.5/au/
SUM Template v7.2 20070725 © Copyright, e-Framework Partners, 2008
SUM Content © Copyright ?name of organization?, ?year?
Submitting the Service Usage Model Description
For additional guidance in preparing the Service Usage Model description, refer to Guidelines for Submitting a Service Usage Model to the e-Framework and the technical definitions of the Service Usage Model Description Elements. For further assistance, contact the e-Framework editor at: editor (AT) e-framework.org
Prior to submitting the description, please read the e-Framework Intellectual Property Rights statement. Also add your information to the copyright statements in the footer of this template.
By submitting this document, you agree to contribute this document under the Creative Commons Attribution-NonCommercial-ShareAlike 2.5 licence.
When you have completed the Service Usage Model description, go to the Submit SUMs page at www.e-framework.org. Click on “Upload your submission” and follow the directions.
