Application Specification Proposal Template

FOUNDATION FOR INTELLIGENT PHYSICAL AGENTS
APPLICATION SPECIFICATION PROPOSAL
<<Replace with the specification title>>
<<Replace with the ACRONIM>>
Document title
Document number
Document status
Supersedes
Access level
Contact
Change history
<<e.g. 2010/02/30>>
<<e.g. 2010/03/07>>
<<Replace with the specification title>>
<<e.g. PC00301A >>
Document source
Preliminary
Date of this status
FIPA ASWG
<<date>>
<<CONFIDENTIAL, RESTRICTED TO ASWG, RESTRICTED TO FIPA, PUBLIC>>
<<e.g. management@fipa.org>>
<<e.g. Carried forward from FIPA 2009 Specification 1 V1.05>>
<<e.g. Incorporated comments from Barcelona meeting>>
© 2010 IEEE Foundation for Intelligent Physical Agents (FIPA) - http://www.fipa.org/
Notice
Use of the technologies described in this specification may infringe patents, copyrights or other intellectual
property rights of IEEE-FIPA Members and non-members. Nothing in this specification should be construed
as granting permission to use any of the technologies described. Anyone planning to make use of
technology covered by the intellectual property rights of others should first obtain permission from the
holder(s) of the rights. IEEE-FIPA strongly encourages anyone implementing any part of this specification to
determine first whether part(s) sought to be implemented are covered by the intellectual property of others,
and, if so, to obtain appropriate licenses or other permission from the holder(s) of such intellectual property
prior to implementation. This specification is subject to change without notice. Neither IEEE-FIPA nor any of
its Members accept any responsibility whatsoever for damages or liability, direct or consequential, which
may result from the use of this specification.
Authors
Name: <<person name>>
e-mail: <<email>>
Name: <<person name>>
e-mail: <<email>>
Name: <<person name>>
e-mail: <<email>>
…
Copyright © 2010 by the Institute of Electrical and Electronics Engineers, Inc.
IEEE - Foundation for Intelligent Physical Agents - http://www.fipa.org/
Three Park Avenue
New York, New York 10016-5997, USA
All rights reserved.
This document is an unapproved draft of a proposed IEEE Standard. As such, this document is subject to change.
USE AT YOUR OWN RISK! Because this is an unapproved draft, this document must not be utilized for any
conformance/compliance purposes. Permission is hereby granted for IEEE Standards Committee participants to
reproduce this document for purposes of international standardization consideration. Prior to adoption of this
document, in whole or in part, by another standards development organization, permission must first be obtained
from the IEEE Standards Activities Department (stds.ipr@ieee.org). Other entities seeking permission to
reproduce this document, in whole or in part, must also obtain permission from the IEEE Standards Activities
Department.
IEEE Standards Activities Department
445 Hoes Lane
Piscataway, NJ 08854, USA
This is an unapproved IEEE-FIPA Standard Draft, subject to change.
ii
Foreword
The Foundation for Intelligent Physical Agents (IEEE-FIPA) is an international organization that is dedicated to
promoting the industry of intelligent agents by openly developing specifications supporting interoperability among
agents and agent-based applications. This occurs through open collaboration among its member organizations,
which are companies and universities that are active in the field of agents. IEEE-FIPA makes the results of its
activities available to all interested parties and intends to contribute its results to the appropriate formal standards
bodies.
The members of IEEE-FIPA are individually and collectively committed to open competition in the development of
agent-based applications, services and equipment. Membership in IEEE-FIPA is open to any corporation and
individual firm, partnership, governmental body or international organization without restriction. In particular,
members are not bound to implement or use specific agent-based standards, recommendations and IEEE-FIPA
specifications by virtue of their participation in IEEE-FIPA.
The IEEE-FIPA specifications are developed through direct involvement of the IEEE-FIPA membership. The status
of a specification can be either Preliminary, Experimental, Standard, Deprecated or Obsolete. More detail about
the process of specification may be found in the IEEE-FIPA Procedures for Technical Work. A complete overview
of the IEEE-FIPA specifications and their current status may be found in the IEEE-FIPA List of Specifications. A list
of terms and abbreviations used in the IEEE-FIPA specifications may be found in the IEEE-FIPA Glossary.
IEEE-FIPA is a non-profit association registered in Geneva, Switzerland. As of January 2010, the 54 members of
IEEE-FIPA represented 17 countries worldwide. Further information about IEEE-FIPA as an organization,
membership information, IEEE-FIPA specifications and upcoming meetings may be found at http://www.fipa.org/.
This is an unapproved IEEE-FIPA Standard Draft, subject to change.
iii
Abstract
<<Max length: 2.000 characters>>
This is an unapproved IEEE-FIPA Standard Draft, subject to change.
iv
Contents
1
2
Introduction ..........................................................................................................................................................1
1.1
Scope and objectives ...................................................................................................................................1
1.2
Progress beyond the state-of-the-art ............................................................................................................1
The new <<ACRONIM>> Application Specification.............................................................................................2
2.1
Actors of the Application ...............................................................................................................................2
2.1.1
Application Ontology .............................................................................................................................2
2.2
Existing protocols to be used by the Application ..........................................................................................2
2.2.1
IEEE-FIPA Interaction Protocols ...........................................................................................................2
2.2.2
External Protocols .................................................................................................................................2
2.3
New protocol specifications ..........................................................................................................................2
2.3.1
State Diagrams .....................................................................................................................................2
2.3.2
Message Specifications ........................................................................................................................2
2.3.3
Internal logic of the Agents ....................................................................................................................2
2.3.4
Sequence Diagrams..............................................................................................................................2
2.4
<<ACRONIM>> Application Deployment .....................................................................................................2
3
Application example.............................................................................................................................................3
4
References ..........................................................................................................................................................4
Annexes ......................................................................................................................................................................5
This is an unapproved IEEE-FIPA Standard Draft, subject to change.
v
© 2010 IEEE-Foundation for Intelligent Physical Agents
<<ACRONIM>> Application Specification
1 Introduction
<< Maximum length for the whole of section 1: three pages, including pictures and graphs. >>
1.1
Scope and objectives
<< Explain the concept of your new Application Specification. What are the main ideas that led you to propose it?
Describe in detail the AS objectives. Show how they relate to the needs of its potential users. >>
1.2
Progress beyond the state-of-the-art
<< Describe the state-of-the-art in the area concerned, with references to related Application Specifications.
Highlight the added value of this Application Specification compared with the existing ones. >>
This is an unapproved IEEE-FIPA Standard Draft, subject to change.
1
© 2010 IEEE-Foundation for Intelligent Physical Agents
<<ACRONIM>> Application Specification
2 The new <<ACRONIM>> Application Specification
<< Maximum length for the whole of section 2: 20 pages, including pictures and graphs. >>
2.1
Actors of the Application
<< Identify the Agents as well as the users and other entities that are part or interact with the Application. >>
2.1.1 Application Ontology
<< Optional subsection to identify ontology(ies) associated to the Application. >>
2.2
Existing protocols to be used by the Application
2.2.1 IEEE-FIPA Interaction Protocols
<< List the existing Interaction Protocols that are used by the Application, if any. Explain which actors use them and
for which purpose are needed. >>
2.2.2 External Protocols
<<Complete the list of protocols used by the Application Actors, with those that are not specified in the framework of
IEEE-FIPA, if any. >>
2.3
New protocol specifications
<< Specific and new protocols at Application level may be needed to cover communication features not solved by
the other existing protocols. In that case, a formal description of the communication among the main actors of the
Application is expected. In case the specific Application Specification proposal does not need to formalise this, skip
this section. >>
2.3.1 State Diagrams
<< Describe each state and each transition of the different Agents that will take part on the system. Include the
graphs to illustrate each diagram state. When needed, describe also the counters and timers that the protocol may
have to use. >>
2.3.2 Message Specifications
<< Formalise all the messages to support the communication among the Actors of the protocol. >>
2.3.3 Internal logic of the Agents
<< Describe the pseudo-code and behaviour of the Agents at state level. >>
2.3.4 Sequence Diagrams
<< Illustrate how the actors of the system might interact among them with the sequence diagrams needed to cover
most possible dialogues. >>
2.4
<<ACRONIM>> Application Deployment
<< Describe how the Application works and show the interaction among the different actors. >>
This is an unapproved IEEE-FIPA Standard Draft, subject to change.
2
© 2010 IEEE-Foundation for Intelligent Physical Agents
<<ACRONIM>> Application Specification
3 Application example
<< Maximum length for the whole of section 3: 5 pages, including pictures and graphs. >>
This is an unapproved IEEE-FIPA Standard Draft, subject to change.
3
© 2010 IEEE-Foundation for Intelligent Physical Agents
<<ACRONIM>> Application Specification
4 References
<<Replace with a list of references of the form:
[FIPA00023]
[RFC822]
[ISO8601]
[OMG99]
FIPA Agent Management Specification. Foundation for Intelligent Physical Agents, 2000.
http://www.fipa.org/specs/fipa00023/
Standard for the Format of ARPA Internet Text Messages, D. H. Crocker, IETF RFC822, August,
1982.
Date Elements and Interchange Formats, Information Interchange – Representation of Dates and
Times, ISO 8601:1988(E), 1988.
OMG Internet Inter-ORB Protocol (IIOP): Common Object Request Broker Architecture Version
2.2, Object Management Group, 1999.
>>
This is an unapproved IEEE-FIPA Standard Draft, subject to change.
4
© 2010 IEEE-Foundation for Intelligent Physical Agents
<<ACRONIM>> Application Specification
Annexes
<< Optional section for extended code, additional examples, etc >>
This is an unapproved IEEE-FIPA Standard Draft, subject to change.
5