PHENOM Portal Knowledgebase - User contributions [en]

Formatting a CSV for Platform Type Import

2026-02-06T20:18:19Z

Annie: Removed regex section from copy + paste

To bulk import platform types, the CSV file should be formatted as described in this article.

== General Column/Data Requirements ==
The following column headers must exist and contain data in each row:
* Name or Platform_Type_GUID
* Type
* Realized_Element

The following columns are optional (for example, the Package columns are only there to specify destination if desired):
* Package_Name
* Package_Description
* Package_GUID
* Description
* Platform_Type_Tags
* Constraint
* Composition_Name
* Composition_Reference
* Composition_GUID

The order of the columns is not enforced, it does not have to be in the same order as the suggested format above.

Any additional user-made columns will be ignored and will not interfere with import.

Bulk import can currently import Package and Platform Type elements.

== Column-specific Requirements ==
=== Name, Platform Type GUID ===
* Either a Name or Platform Type GUID is required. If a Platform Type GUID is given, it must be associated with an existing platform type in the model.

=== Type ===
* Must be a primitive: Boolean, Octet, Char, WChar, CharArray, WCharArray, String, WString, BoundedString, BoundedWString, Short, UShort, Long, LongLong, ULong, ULongLong, Double, LongDouble, Float, Fixed, IDLArray, IDLSequence, IDLStruct, Enumeration.

=== Realized Element ===
* Must reference the name of an existing logical:Measurement, logical:MeasurementAxis, or logical:ValueTypeUnit.

=== Package Name, Package GUID ===
* Leaving this column blank will default Package to the "Phenom" package.
* Setting this column to an existing Package will default to the first matching Platform Package within the model.
* If there is no matching Package, a new Package will be created within the "Phenom" Package.
* If a Package GUID is given, it must reference an existing platform package in the model.

=== Constraint ===
* Must reference the name of an existing platform:RealRangeConstraint, platform:IntegerRangeConstraint, or platform:RegularExpressionConstraint.

=== Composition Name, Composition Reference, Composition GUID ===
* If a Composition Name is present, a Composition Reference is required.
* Composition Reference must reference the name of an existing platform type.
* If a Composition GUID is given, it must reference an existing composition in the model.

== Additional Requirements ==
* Data within Package_Name, Name, Composition_Name must all begin with a letter, and only contain numbers, letters, or underscores. The data must also not match any of the following reserved words:
** '''IDL Reserved words:'''"and", "begin", "break", "case", "common", "compile_opt", "continue", "do", "else", "end", "endcase", "endelse", "endfor", "endforeach", "endif", "endrep", "endswitch", "endwhile", "eq", "for", "foreach", "forward_function", "function", "ge", "goto", "gt", "if", "inherits", "le", "lt", "mod", "ne", "not", "of", "on_ioerror", "or", "pro", "repeat", "switch", "then", "until", "while", "xor"
** '''OCL Reserved words:''' "abstract", "any", "attribute", "boolean", "case", "char", "component", "const", "consumes", "context", "custom", "default", "double", "emits", "enum", "eventtype", "exception", "factory", "false", "finder", "fixed", "float", "getraises", "home", "import", "in", "inout", "interface", "local", "long", "manages", "module", "multiple", "native", "object", "octet", "oneway", "out", "primarykey", "private", "provides", "public", "publishes", "raises", "readonly", "sequence", "setraises", "short", "string", "struct", "supports", "switch", "true", "truncatable", "typedef", "typeid", "typeprefix", "union", "unsigned", "uses", "valuebase", "valuetype", "void", "wchar", "wstring"
* If there are any errors during validation of the CSV file, the model import will not be initiated and a list of errors will be returned. They will be labeled by the row they occur on for convenience.
* There is a 2MB limit in place - if a larger file needs to be imported, it needs to be split up into smaller files.
* In the raw CSV (i.e., as observed from notepad), any field with commas must have surrounding quotes (Excel normally handles this).

CSV

2026-02-06T20:17:19Z

Annie: Added platform type import page link

The CSV import tool allows users to bulk import data into their model, both creating new nodes and editing existing nodes.

[[File:Csv before import.png|frameless|1199x1199px]]

Simply select a CSV file to import which is less than 5MB, and press the import button. Depending on the size of the file, it may take some time to process.

When the processing is finished, an error message will appear if the columns in the CSV file do not fit any of the acceptable formats. If the imported CSV file is valid, a table will appear for review displaying all of the created and edited nodes, as well as a summary of the import.

[[File:Csv after import.png|frameless|1190x1190px]]

Visible in the list is the following information about the processed node:

* Row Number (corresponding to the CSV line number in which the node was created or edited)
* Node Name
* Node Validity
* Node Type
* Node Guid (If this would be a new node, the guid would be replaced with "New")

There are many actions to take on this table, including:

* Nodes may be manually selected or unselected to be saved using the check box in the far left of the row. All rows are selected by default.
* Select a node to see and potentially edit its attributes. If the node is not valid, the node must be edited before finishing the import.
* Reset any manual edits made to the node using the far right column in the row.

To save the changes displayed to the model, press the "FINISH IMPORT" button. Navigating away before pressing this button will not save any of the processed nodes.

== CSV Header Formats ==
Valid formats a user can import are:
* Views & View Characteristics (see [[Formatting a CSV for View Import]])
* Enumerations (see [[Formatting a CSV for Enum Import]])
* Entities & Associations (see [[Formatting a CSV for Entities and Associations Import]])
* Constraints (See [[Formatting a CSV for Constraint Import]])
* Platform Types (See [[Formatting a CSV for Platform Type Import]])
* UoPs (see [[Formatting a CSV for UoP Import]])

Formatting a CSV for Platform Type Import

2026-02-06T20:16:52Z

Annie: Added Platform Type import page

To bulk import platform types, the CSV file should be formatted as described in this article.

== General Column/Data Requirements ==
The following column headers must exist and contain data in each row:
* Name or Platform_Type_GUID
* Type
* Realized_Element

The following columns are optional (for example, the Package columns are only there to specify destination if desired):
* Package_Name
* Package_Description
* Package_GUID
* Description
* Platform_Type_Tags
* Constraint
* Composition_Name
* Composition_Reference
* Composition_GUID

The order of the columns is not enforced, it does not have to be in the same order as the suggested format above.

Any additional user-made columns will be ignored and will not interfere with import.

Bulk import can currently import Package and Platform Type elements.

== Column-specific Requirements ==
=== Name, Platform Type GUID ===
* Either a Name or Platform Type GUID is required. If a Platform Type GUID is given, it must be associated with an existing platform type in the model.

=== Type ===
* Must be a primitive: Boolean, Octet, Char, WChar, CharArray, WCharArray, String, WString, BoundedString, BoundedWString, Short, UShort, Long, LongLong, ULong, ULongLong, Double, LongDouble, Float, Fixed, IDLArray, IDLSequence, IDLStruct, Enumeration.

=== Realized Element ===
* Must reference the name of an existing logical:Measurement, logical:MeasurementAxis, or logical:ValueTypeUnit.

=== Package Name, Package GUID ===
* Leaving this column blank will default Package to the "Phenom" package.
* Setting this column to an existing Package will default to the first matching Platform Package within the model.
* If there is no matching Package, a new Package will be created within the "Phenom" Package.
* If a Package GUID is given, it must reference an existing platform package in the model.

=== Constraint ===
* Must reference the name of an existing platform:RealRangeConstraint, platform:IntegerRangeConstraint, or platform:RegularExpressionConstraint.

=== Composition Name, Composition Reference, Composition GUID ===
* If a Composition Name is present, a Composition Reference is required.
* Composition Reference must reference the name of an existing platform type.
* If a Composition GUID is given, it must reference an existing composition in the model.

=== Regex ===
* Does not need to be valid regex.

== Additional Requirements ==
* Data within Package_Name, Name, Composition_Name must all begin with a letter, and only contain numbers, letters, or underscores. The data must also not match any of the following reserved words:
** '''IDL Reserved words:'''"and", "begin", "break", "case", "common", "compile_opt", "continue", "do", "else", "end", "endcase", "endelse", "endfor", "endforeach", "endif", "endrep", "endswitch", "endwhile", "eq", "for", "foreach", "forward_function", "function", "ge", "goto", "gt", "if", "inherits", "le", "lt", "mod", "ne", "not", "of", "on_ioerror", "or", "pro", "repeat", "switch", "then", "until", "while", "xor"
** '''OCL Reserved words:''' "abstract", "any", "attribute", "boolean", "case", "char", "component", "const", "consumes", "context", "custom", "default", "double", "emits", "enum", "eventtype", "exception", "factory", "false", "finder", "fixed", "float", "getraises", "home", "import", "in", "inout", "interface", "local", "long", "manages", "module", "multiple", "native", "object", "octet", "oneway", "out", "primarykey", "private", "provides", "public", "publishes", "raises", "readonly", "sequence", "setraises", "short", "string", "struct", "supports", "switch", "true", "truncatable", "typedef", "typeid", "typeprefix", "union", "unsigned", "uses", "valuebase", "valuetype", "void", "wchar", "wstring"
* If there are any errors during validation of the CSV file, the model import will not be initiated and a list of errors will be returned. They will be labeled by the row they occur on for convenience.
* There is a 2MB limit in place - if a larger file needs to be imported, it needs to be split up into smaller files.
* In the raw CSV (i.e., as observed from notepad), any field with commas must have surrounding quotes (Excel normally handles this).

CSV

2026-02-06T20:03:33Z

Annie: Added Constraint import page link

Formatting a CSV for Constraint Import

2026-02-06T20:02:42Z

Annie: Added Constraint import page

To bulk import constraints, the CSV file should be formatted as described in this article.

== General Column/Data Requirements ==
The following column headers must exist and contain data in each row:
* Constraint_Name or Constraint_GUID
* Constraint_Type

The following columns are optional (for example, the Package columns are only there to specify destination if desired):
* Constraint_Description
* Package_Name
* Package_GUID
* LB
* UB
* LB_Inclusive
* UB_Inclusive
* Regex

The order of the columns is not enforced, it does not have to be in the same order as the suggested format above.

Any additional user-made columns will be ignored and will not interfere with import.

Bulk import can currently import Package and Constraint elements.

== Column-specific Requirements ==
=== Constraint Name, Constraint_GUID ===
* Either a Constraint Name or Constraint GUID is required. If a Constraint GUID is given, it must be associated with an existing constraint in the model.

=== Constraint Type ===
* Must be one of the following values: Integer, String, Real.

=== Package Name, Package GUID ===
* Leaving this column blank will default Package to the "Phenom" package.
* Setting this column to an existing Package will default to the first matching Conceptual Package within the model.
* If there is no matching Package, a new Package will be created within the "Phenom" Package.
* If a Package GUID is given, it must reference an existing UoP package in the model.

=== LB, UB ===
* Denote the lower and upper bounds for a constraint.
* Must be a number.

=== LB Inclusive, UB Inclusive ===
* Must be a boolean: true, false.

=== Regex ===
* Does not need to be valid regex.

== Additional Requirements ==
* Data within Package_Name and Constraint_Name must all begin with a letter, and only contain numbers, letters, or underscores. The data must also not match any of the following reserved words:
** '''IDL Reserved words:'''"and", "begin", "break", "case", "common", "compile_opt", "continue", "do", "else", "end", "endcase", "endelse", "endfor", "endforeach", "endif", "endrep", "endswitch", "endwhile", "eq", "for", "foreach", "forward_function", "function", "ge", "goto", "gt", "if", "inherits", "le", "lt", "mod", "ne", "not", "of", "on_ioerror", "or", "pro", "repeat", "switch", "then", "until", "while", "xor"
** '''OCL Reserved words:''' "abstract", "any", "attribute", "boolean", "case", "char", "component", "const", "consumes", "context", "custom", "default", "double", "emits", "enum", "eventtype", "exception", "factory", "false", "finder", "fixed", "float", "getraises", "home", "import", "in", "inout", "interface", "local", "long", "manages", "module", "multiple", "native", "object", "octet", "oneway", "out", "primarykey", "private", "provides", "public", "publishes", "raises", "readonly", "sequence", "setraises", "short", "string", "struct", "supports", "switch", "true", "truncatable", "typedef", "typeid", "typeprefix", "union", "unsigned", "uses", "valuebase", "valuetype", "void", "wchar", "wstring"
* If there are any errors during validation of the CSV file, the model import will not be initiated and a list of errors will be returned. They will be labeled by the row they occur on for convenience.
* There is a 2MB limit in place - if a larger file needs to be imported, it needs to be split up into smaller files.
* In the raw CSV (i.e., as observed from notepad), any field with commas must have surrounding quotes (Excel normally handles this).

Formatting a CSV for UoP Import

2026-02-06T19:58:35Z

Annie: Added Package GUID

To bulk import UoPs, the CSV file should be formatted as described in this article.

== General Column/Data Requirements ==
The following column headers must exist and contain data in each row:
* UoP_Name or UoP_GUID

The following columns are optional (for example, the Package columns are only there to specify destination if desired):
* Package_Name
* Package_Description
* Package_GUID
* UoP_Description
* UoP_Tags
* Port_Name
* Port_Description
* Port_GUID
* Pattern
* Message_Request_Type
* Component_Type
* Partition_Type
* Transport_API_Language
* Profile
* Language
* Synch_Style
* Response_Type
* Exchange_Type
* Communication_Style
* Period

The order of the columns is not enforced, it does not have to be in the same order as the suggested format above.

Any additional user-made columns will be ignored and will not interfere with import.

Bulk import can currently import Package, UoP, and Port elements.

== Column-specific Requirements ==
=== UoP Name, UoP GUID ===
Either a UoP Name or UoP GUID is required. If a UoP GUID is given, it must be associated with an existing UoP in the model.

=== Package Name, Package GUID ===
* Leaving this column blank will default Package to the "Phenom" package.
* Setting this column to an existing Package will default to the first matching UoP Package within the model.
* If there is no matching Package, a new Package will be created within the "Phenom" Package.
* If a Package GUID is given, it must reference an existing UoP package in the model.

=== Port Name ===
* Port Names must be unique to the UoP they are imported under.
* Ports belonging to different UoPs may have the same name.

=== Pattern ===
* Corresponds to the messagingPattern attribute on a port.
* Must be one of the following values: pub-sub, Client, Server.

=== Message Request Type, Request Type, Response Type ===
* Correspond to the messageType, requestType, and responseType attributes on a port.
* Must reference the name of a view in the model.

=== Component Type ===
* Denotes the xmi:type of UoP.
* Must be one of the following values: PlatformSpecific, Portable.

=== Partition Type ===
* Denotes the partitionType attribute on a UoP.
* Most be one of the following values: POSIX, ARINC653.

=== Transport API Language ===
* Denotes the transportAPILanguage attribute on a UoP.
* Must be one of the following values: C, CPP, Java, Ada.

=== Profile ===
* Denotes the faceProfile attribute on a UoP.
* Must be one of the following values: GeneralPurpose, Security, SafetyBase, SafetyExtended.

=== Language ===
* Denotes the programmingLanguage attribute on a port.
* Must be one of the following values: C, CPP, Java, Ada.

=== Synch Style ===
* Denotes the synchronizationStyle attribute on a port.
* Must be one of the following values: Blocking, NonBlocking.

=== Exchange Type ===
* Denotes the messageExchangeType attribute on a port.
* Must be one of the following values: InboundMessage, OutboundMessage.

=== Communication Style ===
* Denotes the communicationStyle attribute on a port.
* Must be one of the following values: Queuing, SingleInstanceMessaging.

=== Period ===
* Denotes the period attribute on a port.
* Must be a number.

== Tagging New Elements (Optional) ==
UoP_Tags is an optional column can be used to tag new UoPs. Each field can have multiple comma-delimited tags.

The raw CSV must have quotes around fields with commas (Excel normally handles this).

== Additional Requirements ==
* Data within Package_Name, UoP_Name, and Port_Name must all begin with a letter, and only contain numbers, letters, or underscores. The data must also not match any of the following reserved words:
** '''IDL Reserved words:'''"and", "begin", "break", "case", "common", "compile_opt", "continue", "do", "else", "end", "endcase", "endelse", "endfor", "endforeach", "endif", "endrep", "endswitch", "endwhile", "eq", "for", "foreach", "forward_function", "function", "ge", "goto", "gt", "if", "inherits", "le", "lt", "mod", "ne", "not", "of", "on_ioerror", "or", "pro", "repeat", "switch", "then", "until", "while", "xor"
** '''OCL Reserved words:''' "abstract", "any", "attribute", "boolean", "case", "char", "component", "const", "consumes", "context", "custom", "default", "double", "emits", "enum", "eventtype", "exception", "factory", "false", "finder", "fixed", "float", "getraises", "home", "import", "in", "inout", "interface", "local", "long", "manages", "module", "multiple", "native", "object", "octet", "oneway", "out", "primarykey", "private", "provides", "public", "publishes", "raises", "readonly", "sequence", "setraises", "short", "string", "struct", "supports", "switch", "true", "truncatable", "typedef", "typeid", "typeprefix", "union", "unsigned", "uses", "valuebase", "valuetype", "void", "wchar", "wstring"
* If there are any errors during validation of the CSV file, the model import will not be initiated and a list of errors will be returned. They will be labeled by the row they occur on for convenience.
* There is a 2MB limit in place - if a larger file needs to be imported, it needs to be split up into smaller files.
* In the raw CSV (i.e., as observed from notepad), any field with commas must have surrounding quotes (Excel normally handles this).

CSV

2026-02-06T19:51:48Z

Annie: Added link to UoP formatting page

The CSV import tool allows users to bulk import data into their model, both creating new nodes and editing existing nodes.

[[File:Csv before import.png|frameless|1199x1199px]]

Simply select a CSV file to import which is less than 5MB, and press the import button. Depending on the size of the file, it may take some time to process.

When the processing is finished, an error message will appear if the columns in the CSV file do not fit any of the acceptable formats. If the imported CSV file is valid, a table will appear for review displaying all of the created and edited nodes, as well as a summary of the import.

[[File:Csv after import.png|frameless|1190x1190px]]

Visible in the list is the following information about the processed node:

* Row Number (corresponding to the CSV line number in which the node was created or edited)
* Node Name
* Node Validity
* Node Type
* Node Guid (If this would be a new node, the guid would be replaced with "New")

There are many actions to take on this table, including:

* Nodes may be manually selected or unselected to be saved using the check box in the far left of the row. All rows are selected by default.
* Select a node to see and potentially edit its attributes. If the node is not valid, the node must be edited before finishing the import.
* Reset any manual edits made to the node using the far right column in the row.

To save the changes displayed to the model, press the "FINISH IMPORT" button. Navigating away before pressing this button will not save any of the processed nodes.

== CSV Header Formats ==
Valid formats a user can import are:
* Views & View Characteristics (see [[Formatting a CSV for View Import]])
* Enumerations (see [[Formatting a CSV for Enum Import]])
* Entities & Associations (see [[Formatting a CSV for Entities and Associations Import]])
* Constraints
* Platform Types
* UoPs (see [[Formatting a CSV for UoP Import]])

Formatting a CSV for UoP Import

2026-02-06T19:50:24Z

Annie: Added UoP import page

To bulk import UoPs, the CSV file should be formatted as described in this article.

== General Column/Data Requirements ==
The following column headers must exist and contain data in each row:
* UoP_Name or UoP_GUID

The following columns are optional (for example, the Package columns are only there to specify destination if desired):
* Package_Name
* Package_Description
* Package_GUID
* UoP_Description
* UoP_Tags
* Port_Name
* Port_Description
* Port_GUID
* Pattern
* Message_Request_Type
* Component_Type
* Partition_Type
* Transport_API_Language
* Profile
* Language
* Synch_Style
* Response_Type
* Exchange_Type
* Communication_Style
* Period

The order of the columns is not enforced, it does not have to be in the same order as the suggested format above.

Any additional user-made columns will be ignored and will not interfere with import.

Bulk import can currently import Package, View, and Characteristic elements.

== Column-specific Requirements ==
=== UoP Name, UoP GUID ===
Either a UoP Name or UoP GUID is required. If a UoP GUID is given, it must be associated with an existing UoP in the model.

=== Package Name ===
* Leaving this column blank will default Package to the "Phenom" package.
* Setting this column to an existing Package will default to the first matching UoP Package within the model.
* If there is no matching Package, a new Package will be created within the "Phenom" Package.

=== Port Name ===
* Port Names must be unique to the UoP they are imported under.
* Ports belonging to different UoPs may have the same name.

=== Pattern ===
* Corresponds to the messagingPattern attribute on a port.
* Must be one of the following values: pub-sub, Client, Server.

=== Message Request Type, Request Type, Response Type ===
* Correspond to the messageType, requestType, and responseType attributes on a port.
* Must reference the name of a view in the model.

=== Component Type ===
* Denotes the xmi:type of UoP.
* Must be one of the following values: PlatformSpecific, Portable.

=== Partition Type ===
* Denotes the partitionType attribute on a UoP.
* Most be one of the following values: POSIX, ARINC653.

=== Transport API Language ===
* Denotes the transportAPILanguage attribute on a UoP.
* Must be one of the following values: C, CPP, Java, Ada.

=== Profile ===
* Denotes the faceProfile attribute on a UoP.
* Must be one of the following values: GeneralPurpose, Security, SafetyBase, SafetyExtended.

=== Language ===
* Denotes the programmingLanguage attribute on a port.
* Must be one of the following values: C, CPP, Java, Ada.

=== Synch Style ===
* Denotes the synchronizationStyle attribute on a port.
* Must be one of the following values: Blocking, NonBlocking.

=== Exchange Type ===
* Denotes the messageExchangeType attribute on a port.
* Must be one of the following values: InboundMessage, OutboundMessage.

=== Communication Style ===
* Denotes the communicationStyle attribute on a port.
* Must be one of the following values: Queuing, SingleInstanceMessaging.

=== Period ===
* Denotes the period attribute on a port.
* Must be a number.

== Tagging New Elements (Optional) ==
UoP_Tags is an optional column can be used to tag new UoPs. Each field can have multiple comma-delimited tags.

The raw CSV must have quotes around fields with commas (Excel normally handles this).

== Additional Requirements ==
* Data within Package_Name, UoP_Name, and Port_Name must all begin with a letter, and only contain numbers, letters, or underscores. The data must also not match any of the following reserved words:
** '''IDL Reserved words:'''"and", "begin", "break", "case", "common", "compile_opt", "continue", "do", "else", "end", "endcase", "endelse", "endfor", "endforeach", "endif", "endrep", "endswitch", "endwhile", "eq", "for", "foreach", "forward_function", "function", "ge", "goto", "gt", "if", "inherits", "le", "lt", "mod", "ne", "not", "of", "on_ioerror", "or", "pro", "repeat", "switch", "then", "until", "while", "xor"
** '''OCL Reserved words:''' "abstract", "any", "attribute", "boolean", "case", "char", "component", "const", "consumes", "context", "custom", "default", "double", "emits", "enum", "eventtype", "exception", "factory", "false", "finder", "fixed", "float", "getraises", "home", "import", "in", "inout", "interface", "local", "long", "manages", "module", "multiple", "native", "object", "octet", "oneway", "out", "primarykey", "private", "provides", "public", "publishes", "raises", "readonly", "sequence", "setraises", "short", "string", "struct", "supports", "switch", "true", "truncatable", "typedef", "typeid", "typeprefix", "union", "unsigned", "uses", "valuebase", "valuetype", "void", "wchar", "wstring"
* If there are any errors during validation of the CSV file, the model import will not be initiated and a list of errors will be returned. They will be labeled by the row they occur on for convenience.
* There is a 2MB limit in place - if a larger file needs to be imported, it needs to be split up into smaller files.
* In the raw CSV (i.e., as observed from notepad), any field with commas must have surrounding quotes (Excel normally handles this).

Formatting a CSV for Entities and Associations Import

2026-01-02T22:15:25Z

Annie: /* Element and Attribute Specialization */

To bulk import model content, the CSV file should be formatted as described in this article.

{{Info| 1=Each row of the CSV creates one attribute on an element. Creation of new elements is incidental and done only if a match isn't found.}}

== General Column/Data Requirements ==
The following column headers must exist and contain data in each row:
* Element_Name
* Operation_Type
* Attribute_Name
* Attribute_Type

The following columns are optional:
* Element_Description
* Element_Tags
* Attribute_Description
* Attribute_Tags
* Association_Path
* Package_Name
* Package_Description
* Package_Tags
* Element_Specialization
* Attribute_Specialization

== Column-specific Requirements ==
=== Element Name & Description ===
* If an Entity (or Association) with a matching name is found in the model, the attribute will be added to it.
* New created elements default to a type of Entity.
* If an Entity (or Association) is created, the description is applied to that new element. If the element already exists, its description (if not an empty string) will be updated with the description provided here.

=== Operation Type & Association Path ===
* Must be set to 'Composition' or 'Association'. If Operation_Type is Association, then the Element will automatically be turned into an Association.
* If the Attribute already exists, it will be updated to be an Associated Entity (i.e., turns the Entity into an Association)
* There '''MUST BE AT LEAST TWO''' associated entities or the creation/update operation will fail. It is possible to only add a single associated entity if the element already exists and already contains an associated entity.
* By default, the Association Path is empty. This is an advanced concept used to relate to specific attributes of an element rather than the entire element itself.

=== Attribute Name, Type & Description ===
* Attribute_Name is the desired name for the attribute.
* Attribute_Type must be a valid Observable, Entity, or Association that either
** exists in the model, or
** was created on a previous row.
* Attribute_Description is the description that will be applied to that attribute. If the attribute already exists, its description (if not an empty string) will be updated with the description provided here.

=== Package Name & Description ===
* These columns allow you to place new entity in the package specified by Package_Name. If a package with the provided name does not exist, the new package will be created under the PhenomEntities package.
* Package_Name specified the name of the existing/new package.
* Package_Description specifies the description that will be applied to that package.

=== Element and Attribute Specialization ===
* These columns can be used to create new elements specializing other new elements, create new elements specializing existing elements, and update existing elements to specialize new or existing elements.
* If an element has a child with the same rolename and type as a child to be inherited via a new specialization, Phenom will attempt to align these attributes.
* The Attribute_Specialization column is used to denote a specialization when that attribute doesn't necessarily align with the rolename and type of the target specialized attribute. This column must be paired with the Element_Specialization column.
* Remove a specialization by filling in the corresponding column with <REMOVE>.

== Tagging (Optional) ==
* Optional columns can be added in to CSV to tag new Packages, Elements, or Attributes.
* Each field can have multiple comma delimited tags.

Formatting a CSV for View Import

2026-01-02T22:11:53Z

Annie: RM platform_type_guid

To bulk import view characteristics, the CSV file should be formatted as described in this article.

== General Column/Data Requirements ==
The following column headers must exist and contain data in each row:
* View_Name
* Characteristic_Name
* Primitive
* Source
* Path
* Measurement

The following columns are optional (for example, the Package columns are only there to specify destination if desired):
* DM_Name
* Package_Name
* Package_Description
* Package_Tags
* View_Description
* View_Tags
* Characteristic_Description
* Characteristic_Tags
* Characteristic_Foreign
* Primitive_Bound_Length
* Primitive_Bound_Scale
* Optional
* Lower_Bound
* Upper_Bound
* Nested_View
* Platform_Type
* View_GUID
* Characteristic_GUID

The order of the columns is not enforced, it does not have to be in the same order as the suggested format above.

Any additional user-made columns will be ignored and will not interfere with import.

Bulk import can currently import Package, View, and Characteristic elements.

== Column-specific Requirements ==
=== DM_Name ===
* Leaving this column blank will default to the first available Data Model.
* Setting this column to the name of an existing Data Model node will default to the first matching Data Model node within the project.
* If there is no matching Data Model, a new Data Model will be created.

=== Package Name ===
* Leaving this column blank will default Package to the "Phenom" package.
* Setting this column to an existing Package will default to the first matching Platform Package within the model.
* If there is no matching Package, a new Package will be created within the "Phenom" Package.

=== Package Description ===
Package Description will be imported for new Packages only. Only the first Description for new Packages will be imported.

=== View Name ===
The data in this column for an existing View will be matched to the first View of that name within the model (there should only be one match). If there isn't a matching View, a new View will be created within the "Phenom" Package.

=== View Description ===
View Description will be imported for new Views only. Only the first Description for new Views will be imported.

=== Characteristic Name, Characteristic Description ===
* Characteristic Names must be unique to the View they are imported under.
* The Characteristic must not already exist in the desired View
* Characteristics belonging to different Views may have the same name.

=== Primitive ===
This column isn't case sensitive. Acceptable values: "Char", "Double", "Float", "Long", "Short", "String", "ULong", "UShort", "Octet", "Enumeration".

=== Source, Path, Measurement ===
* Source must exist in the model and must be the Entity/Association projected from the last element in the Path column.
* Path must have valid elements leading up to/ending with the Observable realized by the Measurement.
* Measurement must in the model and realize the Observable at the end of the Path.

''For example: '''AirSystemType''' is projected (through payload) from '''elementID''' which is realized by ''UniqueID_Unbounded_Integer'

=== Lower Bound and Upper Bound ===

* This row must have both a Source and a Path for these values to be valid.
* The bound can be set to "unbounded", which will set the bound to -1.

=== Nested View ===

* The Nested View must exist in the model and must be the name of a View.
''See Nested Views for changes to other columns''

=== View GUID and Characteristic GUID ===

* A GUID must be associated with an existing node of the relevant xmi:type in the model.

== Tagging New Elements (Optional) ==
Package_Tags, View_Tags, and Characteristic_Tags optional columns can be used to tag new Packages, Views, or Characteristics. Each field can have multiple comma-delimited tags.

The raw CSV must have quotes around fields with commas (Excel normally handles this).

Package_Tags will tag whichever package is chosen - this includes the Phenom package when a package isn't specified in the Package_Name column.

== Nested Views Requirements ==
By referencing the name of another view, whether already existing in the model or being added by the same CSV file, in the '''Nested_View''' column, the import can create view sub-structuring or nesting.

In view field rows representing nested views, the '''Source''' and '''Path''' columns represent the perspective path under which the view sub-structure is nested. At the same time, the '''Primitive''', '''Platform_Type''', and '''Measurement''' are not applicable.

By default, all sub-structure nesting view field rows will be inferred to be representing a "private" nesting. This can be made explicit, or toggled off to accomplish a sub-structure import, by using the '''Characteristic_Foreign''' column: if set to "false", the view sub-structure will be private to its nesting view, and an independent import if set to "true".

== Union Views Requirements ==
Union views are not supported by the CSV import yet.

== Additional Requirements ==
* Data within Package_Name, View_Name, and Characteristic_Name must all begin with a letter, and only contain numbers, letters, or underscores. The data must also not match any of the following reserved words:
** '''IDL Reserved words:'''"and", "begin", "break", "case", "common", "compile_opt", "continue", "do", "else", "end", "endcase", "endelse", "endfor", "endforeach", "endif", "endrep", "endswitch", "endwhile", "eq", "for", "foreach", "forward_function", "function", "ge", "goto", "gt", "if", "inherits", "le", "lt", "mod", "ne", "not", "of", "on_ioerror", "or", "pro", "repeat", "switch", "then", "until", "while", "xor"
** '''OCL Reserved words:''' "abstract", "any", "attribute", "boolean", "case", "char", "component", "const", "consumes", "context", "custom", "default", "double", "emits", "enum", "eventtype", "exception", "factory", "false", "finder", "fixed", "float", "getraises", "home", "import", "in", "inout", "interface", "local", "long", "manages", "module", "multiple", "native", "object", "octet", "oneway", "out", "primarykey", "private", "provides", "public", "publishes", "raises", "readonly", "sequence", "setraises", "short", "string", "struct", "supports", "switch", "true", "truncatable", "typedef", "typeid", "typeprefix", "union", "unsigned", "uses", "valuebase", "valuetype", "void", "wchar", "wstring"
* New Views not already within the model must be unique among elements of type IDLStruct and Enumeration.
* Multidimensional Measurements are supported, however each axis will default to the primitive found within the primitive column (these can be corrected within Phenom later if desired).
* If there are any errors during validation of the CSV file, the model import will not be initiated and a list of errors will be returned. They will be labeled by the row they occur on for convenience.
* There is a 2MB limit in place - if a larger file needs to be imported, it needs to be split up into smaller files.
* In the raw CSV (i.e., as observed from notepad), any field with commas must have surrounding quotes (Excel normally handles this).

Formatting a CSV for View Import

2026-01-02T22:11:34Z

Annie: RM platform_type_guid

To bulk import view characteristics, the CSV file should be formatted as described in this article.

== General Column/Data Requirements ==
The following column headers must exist and contain data in each row:
* View_Name
* Characteristic_Name
* Primitive
* Source
* Path
* Measurement

The following columns are optional (for example, the Package columns are only there to specify destination if desired):
* DM_Name
* Package_Name
* Package_Description
* Package_Tags
* View_Description
* View_Tags
* Characteristic_Description
* Characteristic_Tags
* Characteristic_Foreign
* Primitive_Bound_Length
* Primitive_Bound_Scale
* Optional
* Lower_Bound
* Upper_Bound
* Nested_View
* Platform_Type
* View_GUID
* Characteristic_GUID

The order of the columns is not enforced, it does not have to be in the same order as the suggested format above.

Any additional user-made columns will be ignored and will not interfere with import.

Bulk import can currently import Package, View, and Characteristic elements.

== Column-specific Requirements ==
=== DM_Name ===
* Leaving this column blank will default to the first available Data Model.
* Setting this column to the name of an existing Data Model node will default to the first matching Data Model node within the project.
* If there is no matching Data Model, a new Data Model will be created.

=== Package Name ===
* Leaving this column blank will default Package to the "Phenom" package.
* Setting this column to an existing Package will default to the first matching Platform Package within the model.
* If there is no matching Package, a new Package will be created within the "Phenom" Package.

=== Package Description ===
Package Description will be imported for new Packages only. Only the first Description for new Packages will be imported.

=== View Name ===
The data in this column for an existing View will be matched to the first View of that name within the model (there should only be one match). If there isn't a matching View, a new View will be created within the "Phenom" Package.

=== View Description ===
View Description will be imported for new Views only. Only the first Description for new Views will be imported.

=== Characteristic Name, Characteristic Description ===
* Characteristic Names must be unique to the View they are imported under.
* The Characteristic must not already exist in the desired View
* Characteristics belonging to different Views may have the same name.

=== Primitive ===
This column isn't case sensitive. Acceptable values: "Char", "Double", "Float", "Long", "Short", "String", "ULong", "UShort", "Octet", "Enumeration".

=== Source, Path, Measurement ===
* Source must exist in the model and must be the Entity/Association projected from the last element in the Path column.
* Path must have valid elements leading up to/ending with the Observable realized by the Measurement.
* Measurement must in the model and realize the Observable at the end of the Path.

''For example: '''AirSystemType''' is projected (through payload) from '''elementID''' which is realized by ''UniqueID_Unbounded_Integer'

=== Lower Bound and Upper Bound ===

* This row must have both a Source and a Path for these values to be valid.
* The bound can be set to "unbounded", which will set the bound to -1.

=== Nested View ===

* The Nested View must exist in the model and must be the name of a View.
''See Nested Views for changes to other columns''

=== View GUID, Characteristic GUID, and Platform Type GUID ===

* A GUID must be associated with an existing node of the relevant xmi:type in the model.

== Tagging New Elements (Optional) ==
Package_Tags, View_Tags, and Characteristic_Tags optional columns can be used to tag new Packages, Views, or Characteristics. Each field can have multiple comma-delimited tags.

The raw CSV must have quotes around fields with commas (Excel normally handles this).

Package_Tags will tag whichever package is chosen - this includes the Phenom package when a package isn't specified in the Package_Name column.

== Nested Views Requirements ==
By referencing the name of another view, whether already existing in the model or being added by the same CSV file, in the '''Nested_View''' column, the import can create view sub-structuring or nesting.

In view field rows representing nested views, the '''Source''' and '''Path''' columns represent the perspective path under which the view sub-structure is nested. At the same time, the '''Primitive''', '''Platform_Type''', and '''Measurement''' are not applicable.

By default, all sub-structure nesting view field rows will be inferred to be representing a "private" nesting. This can be made explicit, or toggled off to accomplish a sub-structure import, by using the '''Characteristic_Foreign''' column: if set to "false", the view sub-structure will be private to its nesting view, and an independent import if set to "true".

== Union Views Requirements ==
Union views are not supported by the CSV import yet.

== Additional Requirements ==
* Data within Package_Name, View_Name, and Characteristic_Name must all begin with a letter, and only contain numbers, letters, or underscores. The data must also not match any of the following reserved words:
** '''IDL Reserved words:'''"and", "begin", "break", "case", "common", "compile_opt", "continue", "do", "else", "end", "endcase", "endelse", "endfor", "endforeach", "endif", "endrep", "endswitch", "endwhile", "eq", "for", "foreach", "forward_function", "function", "ge", "goto", "gt", "if", "inherits", "le", "lt", "mod", "ne", "not", "of", "on_ioerror", "or", "pro", "repeat", "switch", "then", "until", "while", "xor"
** '''OCL Reserved words:''' "abstract", "any", "attribute", "boolean", "case", "char", "component", "const", "consumes", "context", "custom", "default", "double", "emits", "enum", "eventtype", "exception", "factory", "false", "finder", "fixed", "float", "getraises", "home", "import", "in", "inout", "interface", "local", "long", "manages", "module", "multiple", "native", "object", "octet", "oneway", "out", "primarykey", "private", "provides", "public", "publishes", "raises", "readonly", "sequence", "setraises", "short", "string", "struct", "supports", "switch", "true", "truncatable", "typedef", "typeid", "typeprefix", "union", "unsigned", "uses", "valuebase", "valuetype", "void", "wchar", "wstring"
* New Views not already within the model must be unique among elements of type IDLStruct and Enumeration.
* Multidimensional Measurements are supported, however each axis will default to the primitive found within the primitive column (these can be corrected within Phenom later if desired).
* If there are any errors during validation of the CSV file, the model import will not be initiated and a list of errors will be returned. They will be labeled by the row they occur on for convenience.
* There is a 2MB limit in place - if a larger file needs to be imported, it needs to be split up into smaller files.
* In the raw CSV (i.e., as observed from notepad), any field with commas must have surrounding quotes (Excel normally handles this).

Formatting a CSV for Entities and Associations Import

2026-01-02T21:14:00Z

Annie: Added specialization columns

To bulk import model content, the CSV file should be formatted as described in this article.

{{Info| 1=Each row of the CSV creates one attribute on an element. Creation of new elements is incidental and done only if a match isn't found.}}

== General Column/Data Requirements ==
The following column headers must exist and contain data in each row:
* Element_Name
* Operation_Type
* Attribute_Name
* Attribute_Type

The following columns are optional:
* Element_Description
* Element_Tags
* Attribute_Description
* Attribute_Tags
* Association_Path
* Package_Name
* Package_Description
* Package_Tags
* Element_Specialization
* Attribute_Specialization

== Column-specific Requirements ==
=== Element Name & Description ===
* If an Entity (or Association) with a matching name is found in the model, the attribute will be added to it.
* New created elements default to a type of Entity.
* If an Entity (or Association) is created, the description is applied to that new element. If the element already exists, its description (if not an empty string) will be updated with the description provided here.

=== Operation Type & Association Path ===
* Must be set to 'Composition' or 'Association'. If Operation_Type is Association, then the Element will automatically be turned into an Association.
* If the Attribute already exists, it will be updated to be an Associated Entity (i.e., turns the Entity into an Association)
* There '''MUST BE AT LEAST TWO''' associated entities or the creation/update operation will fail. It is possible to only add a single associated entity if the element already exists and already contains an associated entity.
* By default, the Association Path is empty. This is an advanced concept used to relate to specific attributes of an element rather than the entire element itself.

=== Attribute Name, Type & Description ===
* Attribute_Name is the desired name for the attribute.
* Attribute_Type must be a valid Observable, Entity, or Association that either
** exists in the model, or
** was created on a previous row.
* Attribute_Description is the description that will be applied to that attribute. If the attribute already exists, its description (if not an empty string) will be updated with the description provided here.

=== Package Name & Description ===
* These columns allow you to place new entity in the package specified by Package_Name. If a package with the provided name does not exist, the new package will be created under the PhenomEntities package.
* Package_Name specified the name of the existing/new package.
* Package_Description specifies the description that will be applied to that package.

=== Element and Attribute Specialization ===
* These columns can be used to create new elements specializing other new elements, create new elements specializing existing elements, and update existing elements to specialize new or existing elements.
* If an element has a child with the same rolename and type as a child to be inherited via a new specialization, Phenom will attempt to align these attributes.
* The Attribute_Specialization column is used to denote a specialization when that attribute doesn't necessarily align with the rolename and type of the target specialized attribute. This column must be paired with the Element_Specialization column.

== Tagging (Optional) ==
* Optional columns can be added in to CSV to tag new Packages, Elements, or Attributes.
* Each field can have multiple comma delimited tags.

Formatting a CSV for Entities and Associations Import

2026-01-02T21:12:05Z

Annie: Added element and attribute specialization columns

To bulk import model content, the CSV file should be formatted as described in this article.

{{Info| 1=Each row of the CSV creates one attribute on an element. Creation of new elements is incidental and done only if a match isn't found.}}

== General Column/Data Requirements ==
The following column headers must exist and contain data in each row:
* Element_Name
* Operation_Type
* Attribute_Name
* Attribute_Type

The following columns are optional:
* Element_Description
* Element_Tags
* Attribute_Description
* Attribute_Tags
* Association_Path
* Package_Name
* Package_Description
* Package_Tags

== Column-specific Requirements ==
=== Element Name & Description ===
* If an Entity (or Association) with a matching name is found in the model, the attribute will be added to it.
* New created elements default to a type of Entity.
* If an Entity (or Association) is created, the description is applied to that new element. If the element already exists, its description (if not an empty string) will be updated with the description provided here.

=== Operation Type & Association Path ===
* Must be set to 'Composition' or 'Association'. If Operation_Type is Association, then the Element will automatically be turned into an Association.
* If the Attribute already exists, it will be updated to be an Associated Entity (i.e., turns the Entity into an Association)
* There '''MUST BE AT LEAST TWO''' associated entities or the creation/update operation will fail. It is possible to only add a single associated entity if the element already exists and already contains an associated entity.
* By default, the Association Path is empty. This is an advanced concept used to relate to specific attributes of an element rather than the entire element itself.

=== Attribute Name, Type & Description ===
* Attribute_Name is the desired name for the attribute.
* Attribute_Type must be a valid Observable, Entity, or Association that either
** exists in the model, or
** was created on a previous row.
* Attribute_Description is the description that will be applied to that attribute. If the attribute already exists, its description (if not an empty string) will be updated with the description provided here.

=== Package Name & Description ===
* These columns allow you to place new entity in the package specified by Package_Name. If a package with the provided name does not exist, the new package will be created under the PhenomEntities package.
* Package_Name specified the name of the existing/new package.
* Package_Description specifies the description that will be applied to that package.

=== Element and Attribute Specialization ===
* These columns can be used to create new elements specializing other new elements, create new elements specializing existing elements, and update existing elements to specialize new or existing elements.
* If an element has a child with the same rolename and type as a child to be inherited via a new specialization, Phenom will attempt to align these attributes.
* The Attribute_Specialization column is used to denote a specialization when that attribute doesn't necessarily align with the rolename and type of the target specialized attribute. This column must be paired with the Element_Specialization column.

== Tagging (Optional) ==
* Optional columns can be added in to CSV to tag new Packages, Elements, or Attributes.
* Each field can have multiple comma delimited tags.

Formatting a CSV for View Import

2025-12-17T22:16:23Z

Annie:

To bulk import view characteristics, the CSV file should be formatted as described in this article.

== General Column/Data Requirements ==
The following column headers must exist and contain data in each row:
* View_Name
* Characteristic_Name
* Primitive
* Source
* Path
* Measurement

The following columns are optional (for example, the Package columns are only there to specify destination if desired):
* DM_Name
* Package_Name
* Package_Description
* Package_Tags
* View_Description
* View_Tags
* Characteristic_Description
* Characteristic_Tags
* Characteristic_Foreign
* Primitive_Bound_Length
* Primitive_Bound_Scale
* Optional
* Lower_Bound
* Upper_Bound
* Nested_View
* Platform_Type
* View_GUID
* Characteristic_GUID
* Platform_Type_GUID

The order of the columns is not enforced, it does not have to be in the same order as the suggested format above.

Any additional user-made columns will be ignored and will not interfere with import.

Bulk import can currently import Package, View, and Characteristic elements.

== Column-specific Requirements ==
=== DM_Name ===
* Leaving this column blank will default to the first available Data Model.
* Setting this column to the name of an existing Data Model node will default to the first matching Data Model node within the project.
* If there is no matching Data Model, a new Data Model will be created.

=== Package Name ===
* Leaving this column blank will default Package to the "Phenom" package.
* Setting this column to an existing Package will default to the first matching Platform Package within the model.
* If there is no matching Package, a new Package will be created within the "Phenom" Package.

=== Package Description ===
Package Description will be imported for new Packages only. Only the first Description for new Packages will be imported.

=== View Name ===
The data in this column for an existing View will be matched to the first View of that name within the model (there should only be one match). If there isn't a matching View, a new View will be created within the "Phenom" Package.

=== View Description ===
View Description will be imported for new Views only. Only the first Description for new Views will be imported.

=== Characteristic Name, Characteristic Description ===
* Characteristic Names must be unique to the View they are imported under.
* The Characteristic must not already exist in the desired View
* Characteristics belonging to different Views may have the same name.

=== Primitive ===
This column isn't case sensitive. Acceptable values: "Char", "Double", "Float", "Long", "Short", "String", "ULong", "UShort", "Octet", "Enumeration".

=== Source, Path, Measurement ===
* Source must exist in the model and must be the Entity/Association projected from the last element in the Path column.
* Path must have valid elements leading up to/ending with the Observable realized by the Measurement.
* Measurement must in the model and realize the Observable at the end of the Path.

''For example: '''AirSystemType''' is projected (through payload) from '''elementID''' which is realized by ''UniqueID_Unbounded_Integer'

=== Lower Bound and Upper Bound ===

* This row must have both a Source and a Path for these values to be valid.
* The bound can be set to "unbounded", which will set the bound to -1.

=== Nested View ===

* The Nested View must exist in the model and must be the name of a View.
''See Nested Views for changes to other columns''

=== View GUID, Characteristic GUID, and Platform Type GUID ===

* A GUID must be associated with an existing node of the relevant xmi:type in the model.

== Tagging New Elements (Optional) ==
Package_Tags, View_Tags, and Characteristic_Tags optional columns can be used to tag new Packages, Views, or Characteristics. Each field can have multiple comma-delimited tags.

The raw CSV must have quotes around fields with commas (Excel normally handles this).

Package_Tags will tag whichever package is chosen - this includes the Phenom package when a package isn't specified in the Package_Name column.

== Nested Views Requirements ==
By referencing the name of another view, whether already existing in the model or being added by the same CSV file, in the '''Nested_View''' column, the import can create view sub-structuring or nesting.

In view field rows representing nested views, the '''Source''' and '''Path''' columns represent the perspective path under which the view sub-structure is nested. At the same time, the '''Primitive''', '''Platform_Type''', and '''Measurement''' are not applicable.

By default, all sub-structure nesting view field rows will be inferred to be representing a "private" nesting. This can be made explicit, or toggled off to accomplish a sub-structure import, by using the '''Characteristic_Foreign''' column: if set to "false", the view sub-structure will be private to its nesting view, and an independent import if set to "true".

== Union Views Requirements ==
Union views are not supported by the CSV import yet.

== Additional Requirements ==
* Data within Package_Name, View_Name, and Characteristic_Name must all begin with a letter, and only contain numbers, letters, or underscores. The data must also not match any of the following reserved words:
** '''IDL Reserved words:'''"and", "begin", "break", "case", "common", "compile_opt", "continue", "do", "else", "end", "endcase", "endelse", "endfor", "endforeach", "endif", "endrep", "endswitch", "endwhile", "eq", "for", "foreach", "forward_function", "function", "ge", "goto", "gt", "if", "inherits", "le", "lt", "mod", "ne", "not", "of", "on_ioerror", "or", "pro", "repeat", "switch", "then", "until", "while", "xor"
** '''OCL Reserved words:''' "abstract", "any", "attribute", "boolean", "case", "char", "component", "const", "consumes", "context", "custom", "default", "double", "emits", "enum", "eventtype", "exception", "factory", "false", "finder", "fixed", "float", "getraises", "home", "import", "in", "inout", "interface", "local", "long", "manages", "module", "multiple", "native", "object", "octet", "oneway", "out", "primarykey", "private", "provides", "public", "publishes", "raises", "readonly", "sequence", "setraises", "short", "string", "struct", "supports", "switch", "true", "truncatable", "typedef", "typeid", "typeprefix", "union", "unsigned", "uses", "valuebase", "valuetype", "void", "wchar", "wstring"
* New Views not already within the model must be unique among elements of type IDLStruct and Enumeration.
* Multidimensional Measurements are supported, however each axis will default to the primitive found within the primitive column (these can be corrected within Phenom later if desired).
* If there are any errors during validation of the CSV file, the model import will not be initiated and a list of errors will be returned. They will be labeled by the row they occur on for convenience.
* There is a 2MB limit in place - if a larger file needs to be imported, it needs to be split up into smaller files.
* In the raw CSV (i.e., as observed from notepad), any field with commas must have surrounding quotes (Excel normally handles this).

Formatting a CSV for View Import

2025-11-14T18:21:41Z

Annie: /* General Column/Data Requirements */

To bulk import view characteristics, the CSV file should be formatted as described in this article.

== General Column/Data Requirements ==
The following column headers must exist and contain data in each row:
* View_Name
* Characteristic_Name
* Primitive
* Source
* Path
* Measurement

The following columns are optional (for example, the Package columns are only there to specify destination if desired):
* DM_Name
* Package_Name
* Package_Description
* Package_Tags
* View_Description
* View_Tags
* Characteristic_Description
* Characteristic_Tags
* Characteristic_Foreign
* Primitive_Bound_Length
* Primitive_Bound_Scale
* Optional
* Lower_Bound
* Upper_Bound
* Nested_View
* Platform_Type
* View_GUID
* Characteristic_GUID
* Platform_Type_GUID

The order of the columns is not enforced, it does not have to be in the same order as the suggested format above.

Any additional user-made columns will be ignored and will not interfere with import.

Bulk import can currently import Package, View, and Characteristic elements.

== Column-specific Requirements ==
=== DM_Name ===
* Leaving this column blank will default Datamodel to the first available Datamodel.
* Setting this column to an existing Datamodel will default to the first matching Datamodel within the model.
* If there is no matching Datamodel, a new Datamodel will be created.

=== Package Name ===
* Leaving this column blank will default Package to the "Phenom" package.
* Setting this column to an existing Package will default to the first matching Platform Package within the model.
* If there is no matching Package, a new Package will be created within the "Phenom" Package.

=== Package Description ===
Package Description will be imported for new Packages only. Only the first Description for new Packages will be imported.

=== View Name ===
The data in this column for an existing View will be matched to the first View of that name within the model (there should only be one match). If there isn't a matching View, a new View will be created within the "Phenom" Package.

=== View Description ===
View Description will be imported for new Views only. Only the first Description for new Views will be imported.

=== Characteristic Name, Characteristic Description ===
* Characteristic Names must be unique to the View they are imported under.
* The Characteristic must not already exist in the desired View
* Characteristics belonging to different Views may have the same name.

=== Primitive ===
This column isn't case sensitive. Acceptable values: "Char", "Double", "Float", "Long", "Short", "String", "ULong", "UShort", "Octet", "Enumeration".

=== Source, Path, Measurement ===
* Source must exist in the model and must be the Entity/Association projected from the last element in the Path column.
* Path must have valid elements leading up to/ending with the Observable realized by the Measurement.
* Measurement must in the model and realize the Observable at the end of the Path.

''For example: '''AirSystemType''' is projected (through payload) from '''elementID''' which is realized by ''UniqueID_Unbounded_Integer'

=== Lower Bound and Upper Bound ===

* This row must have both a Source and a Path for these values to be valid.
* The bound can be set to "unbounded", which will set the bound to -1.

=== Nested View ===

* The Nested View must exist in the model and must be the name of a View.
''See Nested Views for changes to other columns''

=== View GUID, Characteristic GUID, and Platform Type GUID ===

* A GUID must be associated with an existing node of the relevant xmi:type in the model.

== Tagging New Elements (Optional) ==
Package_Tags, View_Tags, and Characteristic_Tags optional columns can be used to tag new Packages, Views, or Characteristics. Each field can have multiple comma-delimited tags.

The raw CSV must have quotes around fields with commas (Excel normally handles this).

Package_Tags will tag whichever package is chosen - this includes the Phenom package when a package isn't specified in the Package_Name column.

== Nested Views Requirements ==
By referencing the name of another view, whether already existing in the model or being added by the same CSV file, in the '''Nested_View''' column, the import can create view sub-structuring or nesting.

In view field rows representing nested views, the '''Source''' and '''Path''' columns represent the perspective path under which the view sub-structure is nested. At the same time, the '''Primitive''', '''Platform_Type''', and '''Measurement''' are not applicable.

By default, all sub-structure nesting view field rows will be inferred to be representing a "private" nesting. This can be made explicit, or toggled off to accomplish a sub-structure import, by using the '''Characteristic_Foreign''' column: if set to "false", the view sub-structure will be private to its nesting view, and an independent import if set to "true".

== Union Views Requirements ==
Union views are not supported by the CSV import yet.

== Additional Requirements ==
* Data within Package_Name, View_Name, and Characteristic_Name must all begin with a letter, and only contain numbers, letters, or underscores. The data must also not match any of the following reserved words:
** '''IDL Reserved words:'''"and", "begin", "break", "case", "common", "compile_opt", "continue", "do", "else", "end", "endcase", "endelse", "endfor", "endforeach", "endif", "endrep", "endswitch", "endwhile", "eq", "for", "foreach", "forward_function", "function", "ge", "goto", "gt", "if", "inherits", "le", "lt", "mod", "ne", "not", "of", "on_ioerror", "or", "pro", "repeat", "switch", "then", "until", "while", "xor"
** '''OCL Reserved words:''' "abstract", "any", "attribute", "boolean", "case", "char", "component", "const", "consumes", "context", "custom", "default", "double", "emits", "enum", "eventtype", "exception", "factory", "false", "finder", "fixed", "float", "getraises", "home", "import", "in", "inout", "interface", "local", "long", "manages", "module", "multiple", "native", "object", "octet", "oneway", "out", "primarykey", "private", "provides", "public", "publishes", "raises", "readonly", "sequence", "setraises", "short", "string", "struct", "supports", "switch", "true", "truncatable", "typedef", "typeid", "typeprefix", "union", "unsigned", "uses", "valuebase", "valuetype", "void", "wchar", "wstring"
* New Views not already within the model must be unique among elements of type IDLStruct and Enumeration.
* Multidimensional Measurements are supported, however each axis will default to the primitive found within the primitive column (these can be corrected within Phenom later if desired).
* If there are any errors during validation of the CSV file, the model import will not be initiated and a list of errors will be returned. They will be labeled by the row they occur on for convenience.
* There is a 2MB limit in place - if a larger file needs to be imported, it needs to be split up into smaller files.
* In the raw CSV (i.e., as observed from notepad), any field with commas must have surrounding quotes (Excel normally handles this).