NOTE The template has been defined in the context of UK_Defence. Refer to the business context for details of related templates.

NOTE An explanation of a template and the associated instantiation path is provided in the Template overview section.

This template describes how to represent the UK_Defence concept of a message in terms of PLCS model elements (templates, entities, and reference data).

The Message business object is used by those UK_Defence Data Exchange Specifications that require information about communications between people and organizations.

Figure 1 — Graphical Representation for Business Object Message

Message:

The definition of a message object is: Data about a messages that is intended to be communicated between people / organizations.

NOTE This represents a basic message structure, that may be used for feedback messages, information item distribution etc.

Attribute name	Attribute description	Attribute type	Optionality
Communication Medium	This is the method by which the message is transmitted. EXAMPLE Radio, Channel 5, email.	Intrinsic	Mandatory
Contents	This is the reference to the records that may be contained within the message.	Record	Mandatory
Date Created	This is the date on which the message was created.	Intrinsic	Mandatory
Date Released	This is the date on which the message is sent.	Intrinsic	Optional
ID	This is the identifier of the Message.	Identifier	Mandatory
Name	This is the name of the Message.	Intrinsic	Optional
Priority	This is the priority of the message.	Intrinsic	Optional
Purpose	This is the purpose of the message.	Intrinsic	Mandatory
Recipients	This is the reference to persons and/or organizations that receive the message.	SELECT	Mandatory
Related Contract	This is the reference to the contract under which the message is exchanged.	Contract	Mandatory
Response Required By	This is the date on which a response to the message is required from the recipients.	Intrinsic	Optional
Security Classification	This is the security classification of the message.	Intrinsic	Mandatory
Sender	This is the reference to the person and/or organization that sends the message.	Person or Organization	Mandatory
Subject	This is the subject of the message	Intrinsic	Optional
Type	This is the type of the message. EXAMPLE "comment", "status change", "routine communication", "data import", "data export", "for comment", "for review", "for information", "for approval".	Intrinsic	Optional

Table 1 — Message attribute details

The following input parameters are defined for this template:

The following reference parameters are defined for this template:

The following parameter combinations specify a uniqueness constraint:

Unique constraint: Unique id

Each instance of the entity (Message) within the data set shall be uniquely identified by a combination of the following parameters on this template (message) namely: ID, ID_source_organization.
The instance is referenced by the following template parameter: message.

The instantiation path shown below specifies the entities that are to be instantiated by the template.

A description of templates and the syntax for the instantiation path is provided in the Templates Help/Information section.

-- Message
/representing_message(
    rep_msg_id=@ID,
    rep_msg_id_class_name='Message_identification_code',
    rep_msg_id_ecl_id='urn:plcs:rdl:std',
    rep_msg_id_owner=@ID_source_organization,
    rep_msg_id_owner_class_name='Organization_name',
    rep_msg_id_owner_ecl_id='urn:plcs:rdl:std',
    date_class_name='Date_actual_creation',
    date_ecl_id='urn:plcs:rdl:std',
    year=@Date_created_year,
    month=@Date_created_month,
    day=@Date_created_day,
    hour=@Date_created_hour,
    minute=@Date_created_minute,
    second=@Date_created_second,
    sense='.EXACT.',
    hour_offset='0',
    minute_offset='0',
    ap239_id_class_name='AP239_ed1_tc1_message',
    ap239_id_ecl_id='urn:plcs:rdl:std',
    dex_id_class_name='DEX_message_uk_defence',
    dex_id_ecl_id='urn:plcs:rdl:uk_defence',
    content=@Contents)/
%^message = $representing_message.message%

-- Purpose
/assigning_descriptor(
    descr=@Purpose,
    class_name='Purpose',
    ecl_id='urn:plcs:rdl:uk_defence',
    is_assigned_to=^message)/

-- Recipient (organization)
/assigning_organization(
    org_id=@Recipient_organization,
    org_id_class_name='Organization_name',
    org_id_ecl_id='urn:plcs:rdl:std',
    org_assgn_class_name='Receiver_of',
    org_assgn_ecl_id='urn:plcs:rdl:std',
    items=^message)/

-- Security classification
/assigning_security_classification(
    security_class_name=@Security_Classification,
    security_ecl_id='urn:plcs:rdl:uk_defence',
    items=^message)/

-- Communication medium
/assigning_reference_data(
    items=^message,
    class_name=@Communication_medium,
    ecl_id='urn:plcs:rdl:uk_defence')/

-- Contract reference
Contract_assignment
Contract_assignment.items -> ^message
Contract_assignment.assigned_contract -> @Related_contract

The following section details how the message template can be optionally characterized by assigning other constructs to it. These are characterizations commonly applied to the template. The ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.