auxiliary structure to transport validation status of a file
VIEW_ENTITY attached_file_validation_line;
attachment_id: INTEGER;
file_id: INTEGER;
file_type: STRING;
file_name: STRING;
file_introduced: STRING;
file_creator: STRING;
node_id: INTEGER;
node_path_name: STRING;
valid: LOGICAL;
END_VIEW_ENTITY;
Attributes:
attachment_id |
ms::attached_file EDM database identifier |
file_type |
type of the attached file |
file_name |
name of the validated (or not) file |
file_introduced |
time stamp of the attachment |
file_creator |
name of the attachment creator/last editor |
node_id |
ms::node EDM db id for parent node where the file as stored |
node_path_name |
path (one of) and name of the node |
valid |
FALSE if the file has errors in validation
TRUE if the file does not have errors in validation
UNKNOWN if file was not validated or validation was reduced
|
db_object
represents a database object with its name and database id
VIEW_ENTITY db_object;
name: STRING;
db_id: INTEGER;
END_VIEW_ENTITY;
Attributes:
name |
name of the object |
db_id |
EDM database id of the object |
extract_result
represents result of export procedure, see pbs_extract_ext function
VIEW_ENTITY extract_result;
repository: STRING;
model_name: STRING;
log_id: INTEGER;
END_VIEW_ENTITY;
Attributes:
repository |
name of the repository with exported model |
model |
name of the exported model |
log_id |
EDM id of the comment with the export log |
info_line
auxiliary structure to keep information lines returned from
node_info, pbs_info. They represent simple two column row elements.
VIEW_ENTITY info_line;
name: STRING;
text: STRING;
END_VIEW_ENTITY;
Attributes:
name |
attribute name like 'Name', 'Description'... see constants
with prefix 'INFO_', 'PBS_INFO_' and 'NODE_INFO_' |
text |
value of the attribute |
merge_result
represents result of merge procedure, see node_merge function
VIEW_ENTITY merge_result;
target: v_node;
log_id: INTEGER;
END_VIEW_ENTITY;
Attributes:
target |
merged node representation |
log_id |
EDM id of the comment with the merge log |
specified_master_item
is representation of reference to an instance of SimDM Master Model with its type specification
VIEW_ENTITY specified_master_item;
instance_id: INTEGER;
ms_type: STRING;
END_VIEW_ENTITY;
Attributes:
instance_id |
database ID of the instance |
ms_type |
entity name of the instance in upper case like 'COMMENT', 'NODE' |
represents attached file/document info
VIEW_ENTITY stm_file;
instance_id : INTEGER;
name : STRING;
extension : STRING;
file_type : STRING;
size : OPTIONAL INTEGER;
description : OPTIONAL STRING;
link : OPTIONAL STRING;
properties : OPTIONAL LIST OF stm_property;
remarks : OPTIONAL LIST OF stm_remark;
introduced_by : STRING;
introduced : STRING;
END_VIEW_ENTITY;
Attributes:
instance_id |
file handler |
name |
file name to show in folder |
extension |
file extension in format '.xxx' |
file_type |
file type familiar for a system |
size |
size in bytes |
description |
|
link |
link to external source of the file |
properties |
|
remarks |
|
introduced_by |
login of user who introduced file to the system |
introduced |
'YYYY/MM/DD hh:mm:ss' |
stm_file_system_item
represent item of user's file system (folder or file)
VIEW_ENTITY stm_file_system_item;
name : STRING;
level : INTEGER;
link : OPTIONAL STRING;
size : INTEGER;
END_VIEW_ENTITY;
Attributes:
name |
name of the folder/file (with extension if required) |
level |
indent of the item in file system breakdown, for the first (root) item(s) equal to 1 |
link |
link to a file uploaded before (unset for folder) |
size |
size of the file |
stm_instance_wrapper
represent some instance id
VIEW_ENTITY stm_instance_wrapper;
instance_id : INTEGER;
inst_type : STRING;
END_VIEW_ENTITY;
Attributes:
instance_id |
instance handler |
inst_type |
instance type |
stm_node_in_tree
represents node for a tree browsing
VIEW_ENTITY stm_node_in_tree;
instance_id : INTEGER;
name : STRING;
node_type : STRING;
version : STRING;
description : OPTIONAL STRING;
preferable,
readable,
editable,
manageable,
has_children : BOOLEAN;
alternatives : LIST OF stm_node_version;
children : LIST OF stm_node_in_tree;
files : OPTIONAL LIST OF stm_file;
END_VIEW_ENTITY;
Attributes:
instance_id |
node handler |
name |
name of the node in tree |
node_type |
type of the node (icon) |
version |
version of the node (possible appendix to name) |
description |
node description (string to show in raising yellow label) |
preferable |
unset for nodes without alternatives, TRUE for explicitly preferable, FALSE - for all other alternatives |
readable |
R/O |
editable |
EDITOR |
manageable |
ADMIN |
has_children |
|
alternatives |
|
children |
only after call to stm_open_node or stm_node_get_file_system |
files |
only after call to stm_node_get_file_system |
stm_node_representation
represents detailed node view
VIEW_ENTITY stm_node_representation;
instance_id : INTEGER;
name : STRING;
node_type : STRING;
version : STRING;
description : OPTIONAL STRING;
preferable : BOOLEAN;
created_by : STRING;
created : STRING;
modified_by : OPTIONAL STRING;
modified : OPTIONAL STRING;
files : OPTIONAL LIST OF stm_file;
properties : OPTIONAL LIST OF stm_property;
resolutions : OPTIONAL LIST OF stm_resolution;
remarks : OPTIONAL LIST OF stm_remark;
versions : LIST OF stm_node_version;
END_VIEW_ENTITY;
Attributes:
instance_id |
node handler |
name |
name of the node in tree |
node_type |
type of the node (icon) |
version |
version of the node (possible appendix to name) |
preferable |
unset for nodes without alternatives, TRUE for explicitly preferable, FALSE - for all other alternatives |
description |
node description (string to show in raising yellow label) |
created_by |
login |
created |
'YYYY/MM/DD hh:mm:ss' |
modified_by |
login |
modified |
'YYYY/MM/DD hh:mm:ss' |
files |
attached to node files |
properties |
assigned to node properties |
resolutions |
stated for the node resolutions (approvals) |
remarks |
comments/remarks/search tags |
versions |
list of node versions |
stm_node_version
VIEW_ENTITY stm_node_version;
instance_id : INTEGER;
name,
version,
created : STRING;
derived_from : stm_node_version;
END_VIEW_ENTITY;
Attributes:
instance_id |
node handler |
name |
name of the node in tree |
version |
ode version spec |
created |
when created |
derived_from |
ref. to parent version |
stm_property
represents node or file property
VIEW_ENTITY stm_property;
name : STRING;
value_type : STRING;
p_value : STRING;
description : OPTIONAL STRING;
assigned_by : STRING;
assigned : STRING;
END_VIEW_ENTITY;
Attributes:
name |
|
value_type |
|
p_value |
|
description |
|
assigned_by |
login |
assigned |
'YYYY/MM/DD hh:mm:ss' |
stm_remark
represent remark attached to node or file
VIEW_ENTITY stm_remark;
instance_id : INTEGER;
subj : STRING;
remark : STRING;
related_to : INTEGER;
related_type : STRING;
login : STRING;
dropped_by : STRING;
dropped : STRING;
mine : BOOLEAN;
feedbacks : LIST OF stm_remark;
END_VIEW_ENTITY;
Attributes:
instance_id |
remark handler |
subj |
remark subject (name) |
remark |
remark text |
related_to |
handler of the commented item |
related_type |
entity name of commented item |
login |
login |
dropped_by |
author name |
dropped |
'YYYY/MM/DD hh:mm:ss' |
mine |
|
feedbacks |
for web client and future use |
stm_resolution
represents node resolution (approvals)
VIEW_ENTITY stm_resolution;
instance_id : INTEGER;
resolution : STRING;
description : OPTIONAL STRING;
assigned_by : STRING;
assigned : STRING;
mine : BOOLEAN;
END_VIEW_ENTITY;
Attributes:
instance_id |
resolution handler |
resolution |
resolution type |
description |
|
assigned_by |
login |
assigned |
'YYYY/MM/DD hh:mm:ss' |
mine |
|
t_nodus
VIEW_ENTITY t_nodus;
item: v_item;
locked: BOOLEAN;
editable: BOOLEAN;
version: STRING;
versions: LIST OF STRING;
ancestor: INTEGER;
nodes: LIST OF t_nodus;
END_VIEW_ENTITY;
Attributes:
v_approval
VIEW_ENTITY v_approval;
item: v_item;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.instance_id |
db ID of the ms::approval instance |
item.item_type |
could be depending of generic approval type |
POSITIVE_TYPE |
any positive signals like: 'OK', 'Accepted', 'Confirmed', 'Fixed', etc. |
NEGATIVE_TYPE |
any negative signals or labels like: 'Bad', 'Red flag', 'Critical', 'Cancelled' etc. |
NEUTRAL_TYPE |
other type approvals, like: 'Postponed', 'Delayed', etc. |
item.name |
approval label, like 'Rejected', 'Critical', etc. |
item.description |
description of the approval rules (what are generic reasons to assign and circumstances) |
item.comments |
db ID of comments (could be used to discuss rules of the approval) |
|
v_assigned_approval
represents approval in context of some node
or task. It is a attributed relationship between node or task and generic approval.
in SimDM Master Model corresponds to ms::assigned_approval
VIEW_ENTITY v_assigned_approval;
item: v_item;
assignment: INTEGER;
domain: specified_master_item;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.instance_id |
db ID of the ms::assigned_approval instance |
item.item_type |
could be unset, NEUTRAL_TYPE to assign
typed approvals or be POSITIVE_TYPE or NEGATIVE_TYPE to
assign neutral approvals |
item.name |
assignment name (normally inherited from
the assigned approval) |
item.description |
optional explanation of the approval |
item.comments |
db ID of comments (could be used to discuss,
argue the approval) |
|
assignment |
db ID of the ms::approval instance - reference to assigned
approval |
domain |
instance of specified_master_item with the following
attributes:
ms_type |
'NODE' or 'TASK' - depending of the assignment
domain type |
instance_id |
db ID of the ms::node or ms::task instance to
what assigned the approval |
|
v_assigned_item
representation of assignments search result
see pbs_assignments_select
VIEW_ENTITY v_assigned_item;
item: v_item;
assignment: INTEGER;
domain: INTEGER;
ms_type: STRING;
END_VIEW_ENTITY;
Attributes:
item |
representation of found assignment |
assignment |
EDM db id of assigned item (e.g. person, organization, approval) |
domain |
EDM db id of assigning node |
ms_type |
entity name of the assignment in upper case like
'ASSIGNED_PERSON', 'ASSIGNED_ORGANIZATION' |
v_assigned_organization
represents assignment of user's group
to some node, could be used to grant specific access role to a group of
SimDM users.
in SimDM Master Model corresponds to ms::assigned_organization
VIEW_ENTITY v_assigned_organization;
item: v_item;
assignment: INTEGER;
domain: INTEGER;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.instance_id - db ID of the ms::assigned_organization
instance
item.item_type - could be unset or be ADMIN_TYPE,
EDITOR_TYPE, READER_TYPE depending of granted rights,
then it could be INELIGIBLE_TYPE - to stop access rights
starting from the node and down
SHALLOW_NOTIFICATION_TYPE or DEEP_NOTIFICATION_TYPE
if the assignment is related to e-mail notification of the
group (by organization e-mail or a-mail of persons registered
in the organization)
item.name - assignment name (normally inherited from
the assigned organization)
item.description - optional explanation of the assignment |
assignment |
db ID of the ms::organization instance - reference to
assigned organization |
domain |
db ID of the ms::node instance to be assigned |
v_assigned_person
represents assignment of user
to some node, could be used to grant specific access role to the SimDM users.
in SimDM Master Model corresponds to ms::assigned_person
VIEW_ENTITY v_assigned_person;
item: v_item;
assignment: INTEGER;
domain: INTEGER;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.instance_id |
db ID of the ms::assigned_person
instance |
item.item_type |
could be unset (use default role of the
person) or be ADMIN_TYPE, EDITOR_TYPE, READER_TYPE
depending of granted rights, then it could be
INELIGIBLE_TYPE - to stop access rights starting from the
node and down to its children
SHALLOW_NOTIFICATION_TYPE or DEEP_NOTIFICATION_TYPE
if the assignment is related to e-mail notification of the
person |
item.name |
assignment name (normally inherited from
the assigned person name) |
item.description |
optional explanation of the assignment
or notification options (CSV list) |
|
assignment |
db ID of the ms::person instance - reference to the
assigned person |
domain |
db ID of the ms::node instance to be assigned |
v_assigned_property
represents some property value of the
assigning node. In SimDM Master Model corresponds to ms::assigned_property
VIEW_ENTITY v_assigned_property;
item: v_item;
assignment: INTEGER;
domain: INTEGER;
values: LIST OF STRING;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.item_type |
could be unset or set to UNSET_PROPERTY to
underline empty value |
item.name |
assignment name (normally inherited from
the assigned property) |
item.description |
optional explanation of the assignment
(source of the value, confidence, etc.) |
|
assignment |
db ID of the ms::property instance - reference to the
assigned property definition |
domain |
db ID of the ms::node instance to be assigned |
values |
list of the property values (in string format) |
v_attached_file
represents meta data of a file attached to the
assigning node (normally uploaded by SimDM users), in SimDM Master Model
corresponds to ms::attached_file
VIEW_ENTITY v_attached_file;
item: v_item;
domain: INTEGER;
file: INTEGER;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.instance_id |
db ID of the ms::attached_file
instance |
item.item_type |
represent file content type
item.name - name of the attachment if different from file
name |
item.name |
name of the attachment if different from file
name |
item.description |
optional explanation of the attachment
reasons (source, confidence, issued by, etc.) |
|
domain |
db ID of the ms::node instance to be attached with the file |
file |
db ID of the ms::file_spec instance |
v_baseline
represents fixed baselines of nodes (PBS subset)
VIEW_ENTITY v_baseline;
item: v_item;
editable: BOOLEAN;
nodes: LIST OF INTEGER;
exported_to: LIST OF STRING;
END_VIEW_ENTITY;
Attributes:
v_comment
editable |
(read-only) TRUE if the nodes of the baseline can not be
edited |
nodes |
list of db ID nodes included into the baseline |
exported_to |
optional list of models (.)
where the baseline is exported to |
v_comment
represents comments that could be attached to any pbs items
in SimDM Master Model corresponds to ms::comment
VIEW_ENTITY v_comment;
item: v_item;
commented_item: INTEGER;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.instance_id |
db ID of the comment instance |
item.item_type |
could be depending of comment type 'NEUTRAL_TYPE',
'QUESTION_TYPE', 'EXCLAMATION_TYPE', 'UNDEFINED_TYPE' |
item.name |
subject of the comment |
item.description |
text of the comment |
item.introduced |
when the comment was done |
item.creator |
the comment's author |
item.preview |
attached picture |
item.cancelled |
normally FALSE, but could be TRUE for comment
that was recall by author |
item.comments |
db ID of the answers (instances of ms::comment)
to the comment |
|
commented_item |
db ID of the commented pbs item (read only) |
v_event
represents event connected to an item
VIEW_ENTITY v_event;
event_type: STRING;
item: INTEGER;
timestamp: STRING;
who: INTEGER;
failed: BOOLEAN;
END_VIEW_ENTITY;
Attributes:
event_type |
on of 'CREATE', 'UPDATE', 'CANCEL', 'READ'; |
item |
db ID of the pbs item of the event |
timestamp |
date/time stamp, when the even is done,
format see in definition of TIMESTAMP_FORMAT constant |
who |
db ID of the person who has done the event |
failed |
TRUE if the event was not successive |
v_file
represents file meta-data, in SimDM Master Model corresponds to
instances derived from ms::file_spec
VIEW_ENTITY v_file;
item: v_item;
extension: STRING;
owner: INTEGER;
-- source
produced_by: STRING;
interface: STRING;
OS: STRING;
original_name: STRING;
original_format: STRING;
check_sum: STRING;
-- body
size: INTEGER;
body: INTEGER;
link: STRING;
-- extension
express_schema: STRING;
model_name: STRING;
CAX: INTEGER;
validation: INTEGER;
import_log: INTEGER;
instances: INTEGER;
errors: INTEGER;
validation_options: INTEGER;
warnings: INTEGER;
derived_files: LIST OF INTEGER;
derived_from: LIST OF INTEGER;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.instance_id |
db ID of the ms::file_spec or derived
instance |
item.item_type |
specify file format |
item.name |
name of the file |
item.description |
optional file description |
|
extension |
string of the file name extension, like 'ZIP', 'P21', etc. |
owner |
optional db ID of the ms::organization - owner of the file |
produced_by |
optional name of software (system) produced the file |
interface |
optional interface of the file |
OS |
optional name of operational system native for the file |
original_name |
optional name of the file in local file system on a original
PC (where the file was uploaded from) |
original_format |
optional reference to the format of data source for the
file |
check_sum |
optional check sum of the file to check integrity and to be
sure if not changed, could be image of integer or time
stamp |
size |
0 or size of the file in bytes |
link |
optional link to external file |
body |
0 or id DB of the file instance (0 for linked or not
uploaded yet file) |
express_schema |
optional express schema name could be used to import the
file |
model_name |
optional model name where content of the AP209 or AP203 are
exported, could be empty if the file is not converted into
a model, could be equal '[NO SCHEMA]' if the file can not be
imported due to absence of underlyed schema (not defined
on the server) |
CAX |
0 if the file is not converted into CAX,
db id of the ms::file_spec instance with cax model of
the AP209 or AP203
-1 if the file can not be converted into a CAX |
validation |
0 if the file was not validated
db id of the ms::file_spec instance with validation
results
-1 if the file can not be validated |
instances |
optional number of validated instances |
errors |
optional number of errors in validation |
warnings |
optional number of warnings in validation |
derived_files |
optional list of ms::file_spec instance db id-s derived from
this file |
derived_from |
optional list of ms::file_spec instance db id-s what were
sources of this derived file |
v_item
representation of most basic part for most instances of SimDM
Master Model ms::pbs_item
VIEW_ENTITY v_item;
instance_id: INTEGER;
item_type: STRING;
name: STRING;
description: STRING;
introduced: STRING;
creator: INTEGER;
last_changed: STRING;
last_editor: INTEGER;
preview: STRING;
cancelled: BOOLEAN;
limited: BOOLEAN;
comments: LIST OF INTEGER;
events: LIST OF INTEGER;
END_VIEW_ENTITY;
Attributes:
instance_id |
db ID of the instance |
item_type |
string representation of ms::item_type enum elements, see
definitions of string constants with suffix _TYPE, like
PROGRAM_TYPE |
name |
content of ms::pbs_item.name, name of the item to be
represented in GUI |
description |
content of ms::pbs_item.description, short description of
the item to be represented as tip or on property page,
could be empty |
introduced |
content of ms::pbs_item.introduced, string with date/time
stamp, when the item was created in GMT, format see in
definition of TIMESTAMP_FORMAT constant, normally the filed
could not be set or updated by client |
creator |
db ID of the person who created the instance |
preview |
picture file name that represents preview of the item
(reserved but not used); |
cancelled |
TRUE if the item can not be used any more, FALSE - for
alive items could be referenced in assignment and similar; |
limited |
TRUE if user does not have access to full view of the node
FALSE/UNSET - opposite |
comments |
list of db ID-s of the item's comments (normally read only) |
v_link
represents reference from node to another node or file.
In SimDM Master Model corresponds to ms::file_shortcut or ms::node_reference
VIEW_ENTITY v_link;
item: v_item;
domain: INTEGER;
link: INTEGER;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.instance_id |
db ID of the ms::node_reference or
ms::file_shortcut instance |
item.item_type |
is ignored (replaced with linked item type) |
item.name |
name of the link (normally replaced with name
of the linked item) |
|
domain |
db ID of ms::node instance to show the reference |
link |
db ID of ms::node or ms::attached_file referred instance |
v_method
represents some method definitions (how to
perform typical assigned task), in SimDM Master Model corresponds to
ms::method
VIEW_ENTITY v_method;
item: v_item;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.instance_id |
db ID of the ms::method instance |
item.item_type |
ignored, could be unset or UNDEFINED_TYPE |
item.name |
label for the method, like 'Thermal simulation',
'Cinematic simulation', etc. |
item.description |
optional description of the method and
tool set. |
item.comments |
db ID of comments (could be used to discuss
the method applicability and tool set) |
|
v_node
represents version of some tree node borrowed from AP209
population, like part, product, document and other concepts required in
SimDM browser. In SimDM Master Model corresponds to ms::node
VIEW_ENTITY v_node;
nodus: v_nodus;
id: STRING;
realization: STRING;
parents: LIST OF specified_master_item;
baselines: LIST OF INTEGER;
file_shortcuts: LIST OF INTEGER;
node_shortcuts: LIST OF INTEGER;
back_links: LIST OF INTEGER;
assigned_persons: LIST OF INTEGER;
assigned_organizations: LIST OF INTEGER;
attached_files: LIST OF INTEGER;
assigned_approvals: LIST OF INTEGER;
assigned_properties: LIST OF INTEGER;
tasks: LIST OF INTEGER;
updated: BOOLEAN;
is_new: BOOLEAN;
END_VIEW_ENTITY;
Attributes:
nodus |
reference to common for the pbs and node part of the
structure, see v_nodus comments |
id |
id of the node to be used for mapping to and from AP209 |
realization |
optional reference to other SimDM master model of the same
database where content of the node is represented as PBS,
actually that is qualified by repository model name |
parents |
list of nodes and/or pbs where the node is used as child |
baselines |
list of baselines where the node is listed |
file_shortcuts |
optional read only list of db ID of ms::file_shortcut
instances - references to attached files in other nodes |
node_shortcuts |
optional read only list of db ID of ms::node_reference
instances that refer to another nodes |
back_links |
optional read only list of db ID of ms::node_reference
instances that refer to the node |
assigned_persons |
optional read only list of db ID of ms::assigned_person -
persons assigned to the node in context of some role (as
manager, writer, reader or prohibiter) |
assigned_organizations |
optional read only list of db ID of
ms::assigned_organization - organizations assigned to the
node to grant some role (as manager, writer, reader or
prohibiter) to all their members |
attached_files |
optional read only list of db ID of
ms::attached_file - files with data related to the node
and uploaded by SimDM users |
assigned_approvals |
optional read only list of db ID of
ms::assigned_approval - approvals assigned by managers to
the node |
assigned_properties |
optional read only list of db ID of
ms::assigned_property, data of the node - values of
properties associated with the node |
tasks |
optional read only list of db ID of
ms::task - tasks assigned to persons in context of the node |
updated |
the nodus was updated after last visit of the user |
is_new |
the node was added after last user visit |
node_domain
represents context of node domain
VIEW_ENTITY node_domain;
parent_id: INTEGER;
ms_type: STRING;
alternatives: LIST OF INTEGER;
END_VIEW_ENTITY;
Attributes:
parent_id |
id of parent |
ms_type |
entity name of the parent like 'PBS', 'NODE' |
alternatives |
list of alternative version tags (versions of the node
either available in context of this domain) |
v_update_flag
...
VIEW_ENTITY v_update_flag;
nodus_id : INTEGER;
updated : BOOLEAN;
END_VIEW_ENTITY;
Attributes:
v_nodus
represents common part of v_node and v_pbs,
in SimDM Master Model corresponds to abstract ms::nodus
VIEW_ENTITY v_nodus;
item: v_item;
locked: BOOLEAN;
editable: BOOLEAN;
version: STRING;
versions: LIST OF INTEGER;
ancestor: INTEGER;
nodes: LIST OF INTEGER;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, see
comments to v_item |
locked |
(read-only) TRUE if the node/pbs could not be used to derive
following version, so the node/pbs is finalized |
editable |
(read-only) TRUE if data of the node/pbs could not be
edited by the current user (not allowed by state of
ms::nodus.editable flag, or not sufficient access rights of
the user, or as a content of some baseline)
FALSE in opposite case |
version |
version tag is empty for current state of pbs, shall be set
with unique value within line of versions, it could be set
manually in new version creating or generated by server (as
numerical sequence: 1,2,3...). Version tag is subject for
update if it keeps uniqueness within line of versions |
versions |
list of versions available in DB for the node/pbs |
ancestor |
db ID of previous version instance of node/pbs,
could be empty for initial (first) version |
nodes |
list of db ID child nodes (nodes that used in context of the
parent, NOTE: one node could be used by different parents) |
v_notifications
VIEW_ENTITY v_notifications;
email,
subj,
text : STRING;
END_VIEW_ENTITY;
Attributes:
v_organization
represents user's groups (departments) registered
in PBS may be to assign some particular role to all users of the group,
in SimDM Master Model corresponds to ms::organization
VIEW_ENTITY v_organization;
item: v_item;
email: STRING;
persons: LIST OF INTEGER;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.instance_id |
db ID of the ms::organization instance |
item.item_type |
could be depending of user type
ADMIN_TYPE - to assign manager role by default to
all included users
EDITOR_TYPE - to assign writer role by default to
all included users
READER_TYPE - to assign read only role by default to
all included users
GROUP_TYPE - users group without any default role
assignment
DEPARTMENT_TYPE users group representing mother's
organization structure
...
|
|
email |
group e-mail for notifications |
persons |
(read only) list of db ID ms::person - members of the group |
v_pbs
represents version of pbs, in SimDM Master Model corresponds to ms::pbs
VIEW_ENTITY v_pbs;
nodus: v_nodus;
parents: LIST OF STRING;
persons: LIST OF INTEGER;
organizations: LIST OF INTEGER;
approvals: LIST OF INTEGER;
properties: LIST OF INTEGER;
methods: LIST OF INTEGER;
END_VIEW_ENTITY;
Attributes:
nodus |
reference to common for the pbs and node part of the
structure, see v_nodus comments |
parents |
list of qualified nodes in supermodels, every element of the
list specify in string value node of SimDM master model where
the pbs is used as branch in format :
(just reserved, not implemented in current release) |
persons |
(read only) list of db ID ms::person (users) registered in
the pbs, the list could be converted into list of v_person |
organizations |
(read only) list of db ID ms::organization (departments and
user groups) registered in the pbs, the list could be
converted into list of v_organization |
approvals |
(read only) list of db ID ms::approval defined on the pbs,
the list could be converted into list of v_approval |
properties |
(read only) list of db ID ms::property defined on the pbs,
the list could be converted into list of v_property |
methods |
(read only) list of db ID ms::method defined on the pbs,
the list could be converted into list of v_method |
v_pbs_item
representation of a search result
see pbs_search
VIEW_ENTITY v_pbs_item;
item: v_item;
ms_type: STRING;
END_VIEW_ENTITY;
Attributes:
item |
representation of found item inherited from pbs_item |
ms_type |
entity name of the instance in upper case like 'COMMENT', 'NODE' |
v_person
represents SimDM user registered in PBS in some
particular role, in SimDM Master Model corresponds to ms::person
VIEW_ENTITY v_person;
item: v_item;
login: STRING;
email: STRING;
organizations: LIST OF INTEGER;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.instance_id |
db ID of the ms::person instance |
item.item_type |
could be depending of user type
ADMIN_TYPE - for default manager role
EDITOR_TYPE - for default writer role
READER_TYPE - for default read only role
UNDEFINED_TYPE - without default role (role could be
assigned locally)
|
item.name |
normal name of the user |
item.description |
optional user's description |
... |
item.comments |
db ID of comments (could be used as list of
private local messages to user by other SimDM users) |
|
email |
personal e-mail for notifications |
login |
user's login in target DB |
organizations |
(read only) list of db ID ms::organization (departments and
user groups) where the user takes part |
v_property
VIEW_ENTITY v_property;
item: v_item;
applicable_to: LIST OF STRING;
units: STRING;
mandatory: BOOLEAN;
scalar: BOOLEAN;
low_dimension: INTEGER;
high_dimension: INTEGER;
default_value: STRING;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.instance_id |
db ID of the ms::property instance |
item.item_type |
depending of the expected property value
could be one of the following: INTEGER_PROPERTY_TYPE,
DOUBLE_PROPERTY_TYPE, STRING_PROPERTY_TYPE,
BOOLEAN_PROPERTY_TYPE, UNDEFINED_TYPE |
item.name |
property name, like 'Volume', 'Length', etc. |
item.comments |
db ID of comments (could be used to discuss
the property application and definition) |
|
applicable_to |
list of node types like PROJECT_TYPE, PRODUCT_TYPE, etc. |
units |
string with name of the property measure units |
mandatory |
TRUE for properties mandatory for the applicable node type |
scalar |
TRUE for scalar values, FALSE for aggregated |
low_dimension |
for aggregated properties minimal number of elements or 0 |
high_dimension |
for aggregated properties maximal number of elements or 0 |
default_value |
default value of the mandatory property |
v_task
represents task associated with some node and may be
assigned to person in context of some method definition.
In SimDM Master Model corresponds to ms::task
VIEW_ENTITY v_task;
item: v_item;
subject: INTEGER; -- v_node;
assigned: INTEGER; -- v_person;
action: INTEGER; -- v_method;
to_start: STRING;
to_finish: STRING;
approvals: LIST OF INTEGER; -- v_assigned_approval;
END_VIEW_ENTITY;
Attributes:
item |
reference to representation of derived ms::pbs_item, where
item.instance_id |
db ID of the ms::task instance |
item.item_type |
is ignored for a while (could be later
qualified with priority level or level or importance)
item.name - name of the task (could be replaced with name
of the linked method if any) |
item.description |
optional task specifications or reference
to input data |
|
subject |
db ID of ms::node instance to show the task (node associated
to the task) |
assigned |
optional db ID of ms::person who should perform the task |
action |
optional db ID of ms::method how it shall be done |
to_start |
optional date/time stamp to start activity over the task,
see format in constant TIMESTAMP_FORMAT |
to_finish |
optional date/time stamp to finish activity over the task,
see format in constant TIMESTAMP_FORMAT |
approvals |
read only list of db ID of ms::assigned_approval - approvals
of the task assigned by managers or person mentioned in
'assigned' |
validation_line
auxiliary structure to transport validation summary over
the STEP files.
VIEW_ENTITY validation_line;
file: INTEGER;
file_name: STRING;
parent_folder: STRING;
validation_options: INTEGER;
errors: INTEGER;
warnings: INTEGER;
END_VIEW_ENTITY;
Attributes:
file |
ms::file_spec EDM db id |
file_name |
name of the file |
parent_folder |
node name where the file was found in the validation
validation_options |
errors |
number of validation critical errors |
warnings |
number of validation warnings |