Agent CISE Core Vocabulary Specification

Table of Contents

Model Element Type
AgentClass
AgentAgentClass
AgentLocationClass
AgentObjectClass
AgentRiskClass
AgentRoleInAgentTypeEnumeration
AgentRoleInLocationTypeEnumeration
AgentRoleInObjectTypeEnumeration
AgentRoleInRiskTypeEnumeration
DutyTypeEnumeration
ISO3166CountryCodeTypeEnumeration

UML Conceptual Model



Elements defined in the Core Vocabulary

Agent Class, subclass of Entity 

The Agent is one of the core entities of the overall data model of the information sharing environment. By definition, an Agent is an operative entity that plays a role in any Event, owns, handles or operates Objects such as Cargo or Assets, creates and exploits Documents etc. It is an entity which holds information about individual persons or organizations which are involved as actors or targets in the various events and activities. Agent can have relationship with other agents, objects and locations. Agent can also be related to risks in different roles. Agent is an abstract entity which has two sub-entities Person and Organization.

Attributes for Agent

UML Name Data type Description Example
ContactInformation String

vCard [IETF RFC6350] is a data format for representing and exchanging information about individuals and other entities. It is a text-based format (as opposed to a binary format). xCard [IETF RFC6351] is an XML representation for vCard. All available attributes are described in the vCard document [IETF RFC6350] and listed bellow:

• General Properties (BEGIN, END, SOURCE, KIND, XML)

• Identification Properties (FN, N, NICKNAME, PHOTO, BDAY, ANNIVERSARY, GENDER)

• Delivery Addressing Properties (ADR)

• Communications Properties (TEL, EMAIL, IMPP, LANG)

• Geographical Properties (TZ, GEO)

• Organizational Properties (TITLE, ROLE, LOGO, ORG, MEMBER, RELATED)

• Explanatory Properties (CATEGORIES, NOTE, PRODID, REV, SOUND, UID, CLIENTPIDMAP, URL, VERSION)

• Security Properties (KEY)

• Calendar Properties (FBURL, CALADRURI, CALURI)

Name of a person called Mr John Brown, M.Sc.:

<fn><text>Mr John Brown, M.Sc.</text></fn>

<n>

<surname>Brown</surname>

<given>John</given>

<additional/>

<prefix>Mr<prefix/>

<suffix>M.Sc.<suffix/>

</n>

more examples found in: [IETF RFC6351]

Identifier UniqueIdentifier

Identifier of the agent.

Each UniqueIdentifier can be correlated with other UniqueIdentifiers, either manually, by operators, or automatically, by systems, so that duplicate objects in the network can be identified and brought together for a better understanding of the information being shared.

 

IsOfInterest boolean

Attribute is flagging an interest to follow more closely any activities related to the Agent. Value of the attribute can be either true or false (true = 1 and false = 0)

0

IsSuspect boolean

Attribute is flagging a possible suspicion of illegal activities related to the Agent. Value of the attribute can be either true or false (true = 1 and false = 0)

There is some suspect related to the agent:

1

Metadata Metadata

see: Core Vocabulary Specification for "Metadata"

DCMI

Nationality String

Three-letter country codes to represent countries, dependent territories, and special areas of geographical interest

Portugal: PT

Association Roles for Agent

UML Name Data type Description Multiplicity
Document Document

Agents (persons, organizations) can be associated to zero to multiple documents.

0..*
InvolvedEvent Event

Agents (persons, organizations) can be involved in zero to multiple events (movements, incidents, anomalies, actions) as actors or targets in many different roles.

The association has additional attributes - please check association class AgentEvent.

0..* (allow duplicates)
InvolvedObject Object

Agents (persons, organizations) can be associated to zero to multiple objects (crafts, cargo) in different roles. The length of the association can vary which is described by association involvedDuring with class Period (described later in connection with class AgentInvolvementInObject). Passenger have special relationship to craft via Boolean type attribute TransitPassanger which carries information about the status of the passenger (Transit passenger or not). Crew has also a special relationship to craft which is described by attribute Duty which carries information about the responsibilities and position of the person in the vessel.

The association has additional attributes - please check association class AgentObject.

0..* (allow duplicates)
InvolvedRisk Risk

Agents (persons, organizations) can be associated to zero to multiple risks in different roles.

The association has additional attributes - please check association class AgentRisk.

0..* (allow duplicates)
InvolvedWith Agent

Agents (persons, organizations) can be associated to zero to multiple agents (persons, organizations) in different roles. The length of the association can vary which is described by association involvedDuring with class Period (described later in connection with class AgentInvolvementInAgent).

The association has additional attributes - please check association class AgentAgent.

0..* (allow duplicates)
Location Location

Agents (persons, organizations) can be associated to zero to multiple location in different roles. The lenght of the association can vary which is described by association involvedDuring with class Period (described later in connection with class AgentInvolvementInLocation).

The association has additional attributes - please check association class AgentLocation.

0..* (allow duplicates)

AgentAgent Association Class

This class allows the association between two Agents (or one of their sub-classes: person, organization). It is not mandatory to associate an Agent with another Agent but one Agent can be associated to multiple other Agents. The association further describes the role of the Agent in relation to the other Agent. Crew members have also a special relationship with the Organization inside the vessel company which is described by attribute Duty. This attribute carries information about the responsibilities and position of the person in the vessel. The duration of the relationship between the Agents is described by an association with class Period.

Attributes for AgentAgent

UML Name Data type Description Example
AgentRole AgentRoleInAgentType

Enumerated - Describes the relationship between Agents.

Person who leads an organization: AgentRole

01

Duty DutyType

Attribute carries information about the positions and responsibilities of individual crew members.

31

InvolvementPeriod Period

Defines the duration of the relationship between the Agents.

 

AgentLocation Association Class

This class allows the association between Agent (or one of its sub-classes: person, organization) and Location. It is not mandatory to associate an Agent with a Location but one Agent can be associated to multiple different Locations. The association further describes the role of the Agent in relation to the Location. The duration of the relationship between the Agent and the Location is described by an association with class Period.

Attributes for AgentLocation

UML Name Data type Description Example
AgentRole AgentRoleInLocationType

Enumerated. Describes the relationship between Agent and Location; Place where the person was born or

04

InvolvementPeriod Period

Defines the duration of the relationship between the Agent and the Location.

 

AgentObject Association Class

This class allows the association between Agent (or one of its sub-classes: person, organization) and Object (or one of its sub-classes: Vehicle (Vessel, Aircraft, Landvehicle, CargoPackage). It is not mandatory to associate an Agent with an Object but one Agent can be associated to multiple different Objects. The association further describes the role of the Agent in relation to the Object. The special relationship between Passengers and Craft is described by Boolean type attribute TransitPassanger which carries information about the status of the passenger (Transit passenger or not) and by two associations with class Location. Crew members have also a special relationship to Craft which is described by attribute Duty. This attribute carries information about the responsibilities and position of the person in the vessel. The duration of the relationship between the Agent and the Object is described by an association with class Period.

Attributes for AgentObject

UML Name Data type Description Example
AgentRole AgentRoleInObjectType

Enumerated - Describes the relationship between the Agent and the Object.

03

Duty DutyType

Attribute carries information about the positions and responsibilities of individual crew members.

31

InvolvementPeriod Period

The period of involvement

 

TransitPassenger boolean

Attribute is carrying information about the voyage details of an individual passenger. Is he/her a transit passenger or not. Value of the attribute can be either true or false (true = 1 and false = 0)

In question of a transit passenger:

1

AgentRisk Association Class

This class allows the association between Agent (or one of its sub-classes) and Risk. It is not mandatory to associate an Agent with a Risk but one Agent can be associated to multiple different Risks. The association further describes the role of the Agent in relation to the Risk.

Attributes for AgentRisk

UML Name Data type Description Example
AgentRole AgentRoleInRiskType

Enumerated - Describes the relationship between Agent and Risk.

Person who is the cause of the risk:

01

InvolvementPeriod Period

The period of Involvement