Template:— assigned_person (asgd_pers)
Context:— UK_Defence
Date: 2009/04/17 10:23:02
Revision: 1.2

This section specifies the template assigned_person.

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.

Description

This template describes how to represent a UK_Defence assigned person, using Person.

This represents the information describing the allocation of a human being to something.

For further information about the representation of the allocation of a person, see below.

Business perspective

This information object represents the information describing the allocation of a human being to something.

Business object definition


Figure 1 —  Graphical Representation for Business Object Person

Figure 1 —  Graphical Representation for Business Object Person

Record:

The definition of a assigned person object is: This information object represents information about the allocation of a human being.

Attribute name

Attribute description

Attribute type

Optionality

Date of Birth This is the date on which the person was born. Intrinsic Optional
Experience This is the description of the experience that a person possesses. Intrinsic Optional
Family Name This is the family name / surname of the person. Intrinsic Mandatory
First Name This is the first given name of the person. Intrinsic Mandatory
Gender This is the gender of the person (male / female). Intrinsic Optional
ID This is the identifier of the person. Identifier Mandatory
Middle Name This is the (list of) middle name(s) of the person. Intrinsic Optional
Nationality This is the (list of) nationalities of the person. Intrinsic Optional
Prefix Title This is the (list of) prefix title(s) that a person may prepend to their name. Examples may include: Mr, Mrs, Ms, Dr, Professor Intrinsic Optional
Suffix Titles This is the (list of) suffix title(s) that a person may append to their name. Examples may include: BSc, PhD, CEng, OBE Intrinsic Optional

Table 1 — Person attribute details

Model diagrams
The EXPRESS-G diagram in Figure 2 shows the templates and EXPRESS entities that are required to represent the template "assigned_person". The text highlighted in blue shows the template parameters.


Figure 2 —  An EXPRESS-G representation of the Information model for assigned_person

Figure 2 —  An EXPRESS-G representation of the Information model for assigned_person

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure  3 below.


Figure 3 —  The graphical representation of the assigned_person template

Figure 3 —  The graphical representation of the assigned_person template

Input parameters
The following input parameters are defined for this template:
family_name (Type='STRING')
The family name / surname of the person.
first_name (Type='STRING')
The first given name of the person.
ID (Type='STRING')
The identifier of the person.
source_organization (Type='STRING')
The organization that created the associated identifier. Additionally a Person or Information System could be defined when either of these are the source; see characterizations
type (Type='CLASS')
This is the name of the type of the class used to classify the identifier and so provide the role or reason for the identification.
The following classes and their sub-classes can be used:
classifications: "Identifier_type" (urn:plcs:rdl:std:Identifier_type)
middle_name (Type='STRING', Optional)
The (list of) middle name(s) of the person.
prefix_title (Type='STRING', Optional)
The (list of) prefix title(s) that a person may prepend to their name.
suffix_title (Type='STRING', Optional)
The (list of) suffix title(s) that a person may append to their name.
items (Type= 'SELECT (organization_or_person_in_organization_item)' )
The items to which the person is assigned
Reference parameters
The following reference parameters are defined for this template:
person(Type='ENTITY (Person)')
Allow the Person entity instantiated in this path to be referenced when this template is used.
Note: The Person entity can be referenced in a template path by:
%^target = $assigned_person.person%
where target is the parameter to which the Person is bound.
org(Type='ENTITY (Organization)')
Allow the Organization entity instantiated in this path to be referenced when this template is used.
Note: The Organization entity can be referenced in a template path by:
%^target = $assigned_person.org%
where target is the parameter to which the Organization is bound.
pers_in_org(Type='ENTITY (Person_in_organization)')
Allow the Person_in_organization entity instantiated in this path to be referenced when this template is used.
Note: The Person_in_organization entity can be referenced in a template path by:
%^target = $assigned_person.pers_in_org%
where target is the parameter to which the Person_in_organization is bound.
Uniqueness constraints

The following parameter combinations specify a uniqueness constraint:
Unique constraint: Unique id
Each instance of the entity (Person) within the data set shall be uniquely identified by the following parameters on this template (assigned_person) namely: ID.
The instance is referenced by the following template parameter: person.
Instantiation path
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.
-- Instantiate Organization_or_person_in_organization_assignment entity
Organization_or_person_in_organization_assignment

-- Bind the Organization_or_person_in_organization_assignment
-- to the parameter ^asgn_org. The parameter is a reference parameter
-- so the Organization_or_person_in_organization_assignment
-- entity can be referred to when this template is used.
%^asgn_org = Organization_or_person_in_organization_assignment%

-- Set the Organization_or_person_in_organization_assignment attribute role to be ignored
Organization_or_person_in_organization_assignment.role = '/IGNORE'

-- Assign the Organization_or_person_in_organization_assignment
-- to the instances passed into the template through the @items
-- input parameter (e.g. an Activity_actual)
Organization_or_person_in_organization_assignment.items -> @items
/person(
    family_name=@family_name,
    first_name=@first_name,
    ID=@ID,
    source_organization=@source_organization,
    type=@type,
    middle_name=@middle_name,
    prefix_title=@prefix_title,
    suffix_title=@suffix_title)/
%^person = $person.person%
%^org = $person.org%
%^pers_in_org = $person.pers_in_org%

-- Assign the Organization_or_person_in_organization_assignment
-- to the representing_person_in_organization template
Organization_or_person_in_organization_assignment.assigned_entity -> ^pers_in_org
The following entities are instantiated with attributes as specified:
Entity in path Value Inherited from
Organization_or_person_in_organization_assignment.role '/IGNORE'
Instance diagrams
The instance diagram in Figure  4 shows an example of the EXPRESS entities and templates that are instantiated by the template:
/assigned_person(family_name='Brown', first_name='John', ID='JB001', source_organization='BAE Systems', type='Identification_code', middle_name='', prefix_title='', suffix_title='', items='#20')/
(an illustration of the consolidated assigned_person template is shown in Figure 5 below.)


Figure 4 —  Entities instantiated by assigned_person template

Figure 4 —  Entities instantiated by assigned_person template

The instance diagram in Figure 5 shows the graphic symbol for the template that is to be used in other instance diagrams. The example template is:
/assigned_person(family_name='Brown', first_name='John', ID='JB001', source_organization='BAE Systems', type='Identification_code', middle_name='', prefix_title='', suffix_title='', items='#20')/


Figure 5 —  Instantiation of assigned_person template

Figure 5 —  Instantiation of assigned_person template

Characterizations
The following section details how the assigned_person 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.
The EXPRESS-G diagram in Figure 6 shows the possible characterizations of the template "assigned_person".


Figure 6 —  Characterizations for assigned_person

Figure 6 —  Characterizations for assigned_person

The following characterizations may apply:
Characterization Person's Experience

NOTE   this characterization is optional.

The experience a person possesses can be represented using instances of the template assigning_descriptor. These are applied to the ^person reference parameter. See Figure 6 for the an abstract view of this. The following template call shows how this might be instantiated with respect to Figure 5.

/assigning_descriptor(descr='nnn', class_name='Experience', ecl_id='urn:plcs:rdl:uk_defence', is_assigned_to='#41')/
Characterization Nationality

NOTE   this characterization is optional.

The list of a person's nationalities is provided using instances of the template assigning_reference_data. These are applied to the ^person reference parameter. See Figure 6 for the an abstract view of this. The following template call shows how this might be instantiated with respect to Figure 5.

NOTE    The assignment of Nationalities is described the capability C010: assigning_reference_data.

The following template call shows how this might be instantiated with respect to Figure 5.
/assigning_reference_data(class_name='Nationalities', ecl_id='urn:plcs:rdl:uk_defence', items='#41')/
Characterization Gender

NOTE   this characterization is optional.

The gender of a person is provided using instances of the template assigning_reference_data. These are applied to the ^person reference parameter. See Figure 6 for the an abstract view of this. The following template call shows how this might be instantiated with respect to Figure 5.

NOTE    The assignment of Nationalities is described the capability C010: assigning_reference_data.

The following template call shows how this might be instantiated with respect to Figure 5.
/assigning_reference_data(class_name='Gender', ecl_id='urn:plcs:rdl:uk_defence', items='#41')/
Characterization Date of Birth

NOTE   this characterization is optional.

The date when a person is born is applied to the person using instances of the template assigning_calendar_date This is applied to the ^person reference parameter. See Figure 6 for the an abstract view of this. The following template call shows how this might be instantiated with respect to Figure 5.

/assigning_calendar_date(date_class_name='Date_of_birth', date_ecl_id='urn:plcs:rdl:uk_defence', year='01', month='04', day='1960', items='#41')/
Characterization Previous name

NOTE   this characterization is optional.

The previous names of a person is applied to the person using instances of the template assigning_identification_with_no_organization This is applied to the ^person reference parameter. See Figure 6 for the an abstract view of this. The following template call shows how this might be instantiated with respect to Figure 5.

/assigning_identification_with_no_organization(id='Smith', id_class_name='Previous_names', id_ecl_id='urn:plcs:rdl:uk_defence', items='#41')/

© UK MOD 2010 — All rights reserved