Appendix C: SERVICE INTERFACE PROFILE TEMPLATEBased on analysis of the “Technical Service Data Sheet for Notification Broker v.002”, [NC3A RD-3139] and “RD-3139 Publish/Subscribe Service Interface Profile Proposal v.1.0” [DEU SDS] the following document structure is proposed for the consolidated Profile.North Atlantic Treaty OrganizationNATO_4c62b5be-8b86-11e2-bbba-8b8d68e382cb_49e3dfa6-8a53-11ea-98df-082c0e83ea00To define a template based on the NCI Agency and IABG proposal for a standard profiling document_49e3e17c-8a53-11ea-98df-082c0e83ea00KeywordsInclude relevant keywords_a9449098-8b9e-11ea-85b3-142c1683ea001Description: Should contain relevant names of the [C3 Taxonomy] services plus other relevant keywords like the names of profiled standards._a945e380-8b9e-11ea-85b3-142c1683ea00MetadataProvide metadata based on the NATO Discovery Metadata Specification [NCMS]_ae4b5c08-8e45-11ea-9d1f-973a2783ea002Metadata of the document, that should be based on the NATO Discovery Metadata Specification [NCMS] and MUST include: Security classification, Service name (title), Version, Unique identifier, Date, Creator, Subject, Description, Relation with other SIPs. The unique identifier MUST encode a version number and C3 Board needs to decide on a namespace. It needs to be decided whether URN or URL should be used to format the identifier.SecurityInclude security classification_ae4b5dc0-8e45-11ea-9d1f-973a2783ea002.1TitleInclude service name (title)_ae4b5ef6-8e45-11ea-9d1f-973a2783ea002.2VersionInclude service version_ae4b6022-8e45-11ea-9d1f-973a2783ea002.3IdentifierInclude service unique identifier_ae4b6130-8e45-11ea-9d1f-973a2783ea002.4DateInclude the date_ae4b6248-8e45-11ea-9d1f-973a2783ea002.5CreatorName the creator_ae4b6356-8e45-11ea-9d1f-973a2783ea002.6SubjectName the subject_ae4b6478-8e45-11ea-9d1f-973a2783ea002.7DescriptionDescribe the SIP_ae4b6586-8e45-11ea-9d1f-973a2783ea002.8RelationshipsDocument the relationships with other SIPs_ae4b66a8-8e45-11ea-9d1f-973a2783ea002.9AbstractProvide a description of the service being profiled_ae4b67c0-8e45-11ea-9d1f-973a2783ea003General description of the service being profiled._ae4b68ce-8e45-11ea-9d1f-973a2783ea00ChangesList the changes made to the previous version_ae4b6a54-8e45-11ea-9d1f-973a2783ea004Record of Changes and Amendments -- The list of changes should include version number, date, originator and main changes.Version NumberInclude the version number_ae4b6b80-8e45-11ea-9d1f-973a2783ea004.1DateInclude the date_ae4b6c98-8e45-11ea-9d1f-973a2783ea004.2OriginatorName the originator_ae4b6db0-8e45-11ea-9d1f-973a2783ea004.3The originator should identify an organisation/Nation (not a person).ChangesExplain the main changes_ae4b6f9a-8e45-11ea-9d1f-973a2783ea004.4Table of ContentsInclude a table of contents _ae4b70bc-8e45-11ea-9d1f-973a2783ea005_ae4b71f2-8e45-11ea-9d1f-973a2783ea00Table of FiguresInclude a table of figures_ae4b7314-8e45-11ea-9d1f-973a2783ea006_ae4b7436-8e45-11ea-9d1f-973a2783ea00OverviewProvide an overview about the key administrative information and the goals/nongoals of the service_ae4b7562-8e45-11ea-9d1f-973a2783ea007Should provide an overview about the key administrative information and the goals/nongoals of the service._ae4b7684-8e45-11ea-9d1f-973a2783ea00PurposeProvide a set of specifications, along with clarifications, refinements, interpretations and amplifications of those specifications which promote interoperability._ae4b77b0-8e45-11ea-9d1f-973a2783ea008Purpose of the Document Same for all SIPs. Does not contain a service specific description. “Provide a set of specifications, along with clarifications, refinements, interpretations and amplifications of those specifications which promote interoperability.”_ae4b78e6-8e45-11ea-9d1f-973a2783ea00AudienceDocument the envisioned audience_ae4b7a12-8e45-11ea-9d1f-973a2783ea009Project Managersprocuring Bi-Strategic Command (Bi-SC) or FMN related systemsArchitectsof service consumers and providersDevelopersof service consumers and providersCoalition Partnerswhose services may need to interact with FMN ServicesSystems Integratorsdelivering systems into the NATO environmentThe envisioned audience consists of:_ae4b7b3e-8e45-11ea-9d1f-973a2783ea00Notational ConventionsDescribe the notational conventions for the document_ae4b7dbe-8e45-11ea-9d1f-973a2783ea0010Describes the notational conventions for this document: italics Syntax derived from underpinning standards should use the Courier font._ae4b7efe-8e45-11ea-9d1f-973a2783ea00Taxonomy AllocationDocument the position and description of the service within the [C3Taxonomy]_ae4b8034-8e45-11ea-9d1f-973a2783ea0011Provides information on the position and description of the service within the [C3Taxonomy]._ae4b817e-8e45-11ea-9d1f-973a2783ea00Terminology/DefinitionsBriefly describe each term used in the document_ae4b82be-8e45-11ea-9d1f-973a2783ea0012Introducing service specific terminology used in the document with short descriptions for every term._ae4b8408-8e45-11ea-9d1f-973a2783ea00NamespacesInclude a table with the prefix and the namespaces used in the document._ae4b8552-8e45-11ea-9d1f-973a2783ea0013Table with the prefix and the namespaces used in the document._ae4b869c-8e45-11ea-9d1f-973a2783ea00GoalsDocument the goals of the service profile_ae4b87dc-8e45-11ea-9d1f-973a2783ea0014Service specific goals of the profile. They will tell which aspects of the service will be covered by the profile, e.g. identify specific protocols, data structures, security mechanisms etc.ProtocolsIdentify specific protocols_ae4b8944-8e45-11ea-9d1f-973a2783ea0014.1DataIdentify data structures_ae4b8a8e-8e45-11ea-9d1f-973a2783ea0014.2SecurityIdentify security mechanisms_ae4b8bd8-8e45-11ea-9d1f-973a2783ea0014.3Non-GoalsExplain why some potentially relevant goals are not being addressed_ae4b8d9a-8e45-11ea-9d1f-973a2783ea0015An explanation for not addressing the listed non-goals potentially relevant in a given context. This section may contain references to external documents dealing with the identified issues (e.g. security mechanisms are described in different SIP/document)._ae4b8eda-8e45-11ea-9d1f-973a2783ea00ReferencesDocument references to other specifications_ae4b9024-8e45-11ea-9d1f-973a2783ea0016Normative and non-normative references to external specifications._ae4b9182-8e45-11ea-9d1f-973a2783ea00Service RelationshipsDocument relationships to other services_ae4b92cc-8e45-11ea-9d1f-973a2783ea0017Relationships to other services in the [C3 Taxonomy]._ae4b9416-8e45-11ea-9d1f-973a2783ea00ConstraintsDocument preconditions to run the service_ae4b9632-8e45-11ea-9d1f-973a2783ea0018Preconditions to run the service; when to use and when not to use the service. "Service is not intended to work with encrypted messages”._ae4b9786-8e45-11ea-9d1f-973a2783ea00Background_ae4b98e4-8e45-11ea-9d1f-973a2783ea0019(non-normative) Descriptive part of the document.Operational RequirementsProvide an overview of where and in which environment the service will be deployed_ae4b9a4c-8e45-11ea-9d1f-973a2783ea0019.1Description of the Operational Requirements -- Description of the operational background of the service to give an overview where and in which environment the service will be deployed.ServiceDescribe the functionality and intended use of the service_ae4b9baa-8e45-11ea-9d1f-973a2783ea0019.2Description of the Service -- Purpose of the service, its functionality and intended use. Which potential issues can be solved with this service?InteractionsDescribe typical service interactions_ae4b9cfe-8e45-11ea-9d1f-973a2783ea0019.3Typical Service Interactions -- Most typical interactions the service can takepart in. Should provide better understanding and potential application of a service and its context. This part is non-normative and will not be exhaustive (i.e. is not intended to illustrate all possible interactions). Interactions can be illustrated using UML interaction, sequence, use case, and/or state diagrams.Service Interface Specification_ae4b9e70-8e45-11ea-9d1f-973a2783ea0020(normative) Prescriptive part of the document (not repeating the specification).Interface OverviewBriefly describe the interface_ae4b9fc4-8e45-11ea-9d1f-973a2783ea0020.1Introduction with a short description (containing operations, etc.) of the interface.Short overview table with all operations identifying which ones are defined by the SIP as mandatory, recommended or optional. Any extensions to underlying services (e.g. new operations) must be clearly marked. Specific example: Response “service unavailable” if operations are not implemented/available.Technical RequirementsDescribe the technical requirements_ae4ba122-8e45-11ea-9d1f-973a2783ea0020.2Description of the specific technical requirements. Generic non-functional requirements.OperationsDescribe mandatory, recommended and optional operations_ae4ba29e-8e45-11ea-9d1f-973a2783ea0020.3Detailed description of mandatory, recommended and optional operations: input, output, faults, sequence diagram if necessary.Clearly mark extensions to the underlying referenced standards. Any non-standard behaviour must be explicitly requested and described, including specific operations or parameters to initiate it. Specific examples: Explicitly request non-standard filter mode; explicitly request particular transport mode. - Internal faults could be handled as an unknown error. Additional information (internal error code) can be ignored by the user.ErrorsDescribe errors and how the recipient is informed about them_ae4ba406-8e45-11ea-9d1f-973a2783ea0020.4(Optional Section) Description of the specific errors and how therecipient is informed about them.ReferencesCite references_ae4ba564-8e45-11ea-9d1f-973a2783ea0021Contains document references._ae4ba6e0-8e45-11ea-9d1f-973a2783ea00AppendicesDocument service-specific artefacts_ae4ba852-8e45-11ea-9d1f-973a2783ea0022(Optional) Service specific artefacts (non-normative and normative), e.g. WSDLs / Schemas for specific extensions_ae4ba9ba-8e45-11ea-9d1f-973a2783ea002018-08-032020-05-04OwenAmburOwen.Ambur@verizon.net