FOUNDATION FOR INTELLIGENT PHYSICAL AGENTS
| Document title |
FIPA
Input Document Policy |
| Document number |
f-out-00001A |
Document source |
FIPA Board of Directors |
| Document status |
Preliminary |
Date of this status |
2000/08/10 |
| Change history |
| 2000/01/27 |
Complete rework |
| 2000/08/10 |
FAB consistency and editorial |
Forward
This is an official document of FIPA, the Foundation for Intelligent Physical
Agents. Information about FIPA and FIPA documents, including copyright
notices, may be found on the world-wide web at http://www.fipa.org/.
Introduction
This document defines the policies and procedures for the creation
and management of FIPA input documents. It is hereafter referred to as
the "FIPA Input Document Policy". This policy is established to facilitate
the operational working of FIPA.
Contents
This document is divided into the following sections:
-
Document identifiers
-
Document structure, formats and storage
-
Document approval
-
Document lifecycle
-
Archive methodology
-
Example
Document identifiers
Every FIPA input document is given an identifier with the
following format:
-
A five digit decimal number, with leading zero fill. Numbers are assigned
sequentially for all input documents. Numbers are assigned by the FIPA
Architecture Board, or electronically by a mechanism approved by the FIPA
Architecture Board.
An input document is stored with its file name as the identifier suffixed
with the appropriate type of the document (.pdf, .html, etc.).
Document Structure, Formats and Storage
A FIPA input document should have the following header on the first page:
FOUNDATION FOR INTELLIGENT PHYSICAL AGENTS
| Document
title |
<<Document
title>> |
| Document
number |
f-in-<<identifier>> |
Document
source |
<<Source>> |
| Document
status |
Preliminary |
Date of this
status |
<<Date>> |
| Change
history |
| <<Date>> |
Entered into archive |
An input document is entered into the FIPA repository in the following
manner:
-
A subdirectory of the input document archive is created with the same name
as the document identifier.
-
The input document is stored in this directory.
-
All files associated with the input document are stored in this directory.
See [f-out-00043] for a template input document.
Document Approval and Lifecycle
FIPA input documents do not have any predefined life-cycle. Documents
may be updated or become Obsolete.
Archival Methodology
TBD.
Example
A company, XYZ Corp, has submitted a response to a FIPA call for work programs.
The response is received in the form of a ZIP archive containing a set
of HTML pages and GIF images. The document is assigned the number "00732".
The material is stored in the FIPA repository as follows:
-
A subdirectory "f-in-00732" is created within the FIPA input document area.
-
The ZIP archive is unpacked into this subdirectory, being careful to preserve
the subdirectory structure and file naming.
-
The following table is added to the main document which
has a file name which is the same as the document identifier, in this case,
"f-in-00732.html" (if it is a HTML document).
FOUNDATION FOR INTELLIGENT PHYSICAL AGENTS
| Document
title |
Work
Plan Submission
for Cobol Agent API |
| Document
number |
f-in-00732 |
Document
source |
XYZ Corp |
| Document
status |
Preliminary |
Date of this
status |
2000/01/27 |
| Change
history |
| 2000/01/27 |
Entered into archive |
<<Submitted material begins here>>