CSV: Difference between revisions

From PHENOM Portal Knowledgebase
Jump to navigation Jump to search
VisualWikitext
Nathalie (talk | contribs)
548 edits
Created page with "The CSV import tool allows users to bulk import data into their model. The types of data the user can import are: * View-Characteristic * Enum-Literal * Model-Content * Constraints * Message Data Model * Platform Types DSDM Import DSDM Import or the Model-Content Bulk Import is a convenient tool for bulk creation of Entities and Associations. Importing DSDM Content To import a Bulk CSV file containing DSDM content from the Bulk Import page: Select "Model-Content" from..."
 
Josh (talk | contribs)
33 edits
Update to the CSV import page after refactor
 
(13 intermediate revisions by one other user not shown)
Line 1: Line 1:
The CSV import tool allows users to bulk import data into their model.
The CSV import tool allows users to bulk import data into their model, both creating new nodes and editing existing nodes.


The types of data the user can import are:
[[File:Csv before import.png|frameless|1199x1199px]]
* View-Characteristic
* Enum-Literal
* Model-Content
* Constraints
* Message Data Model
* Platform Types


DSDM Import
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.
DSDM Import or the Model-Content Bulk Import is a convenient tool for bulk creation of Entities and Associations.
Importing DSDM Content
To import a Bulk CSV file containing DSDM content from the Bulk Import page:
Select "Model-Content" from the Import Type dropdown:


Click the Browse button under Import File:
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.


Select a properly formatted CSV file (see CSV Format/ Instructions / API):
[[File:Csv after import.png|frameless|1190x1190px]]


Click the Import button on the lower right side:
Visible in the list is the following information about the processed node:


After the import has finished, Phenom will display a popup message with either a success message or an Import Errors message with each error and its respective row.
* 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")


Formatting a CSV for DSDM Import
There are many actions to take on this table, including:
Use the following CSV Format/ Instructions / API [CSV Template]


* 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 ==
Each row creates 1 attribute on 1 element. Creation of new elements is incidental and done only if a match isn't found.
Valid formats a user can import are:
Column & Data Requirements:
* Views & View Characteristics (see [[Formatting a CSV for View Import]])
Required column headers
* Enumerations (see [[Formatting a CSV for Enum Import]])
Element_Name
* Entities & Associations (see [[Formatting a CSV for Entities and Associations Import]])
Operation_Type
* Constraints
Attribute_Name
* Platform Types
Attribute_Type
* UoPs
Optional columns
Element_Description
Element_Tags
Attribute_Description
Attribute_Tags
Association_Path
Package_Name
Package_Description
Package_Tags
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 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 your 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.
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.
 
Enum-Literal Import
The Enum-Literal Bulk Import is a convenient tool for bulk creation of Enumerations/Enumeration Literals.
 
FACE XMI v2.1 Import
View-Characteristic Import
The View-Characteristic Bulk Import is a convenient tool for bulk creation of Views/Characteristics.

Latest revision as of 15:49, 15 December 2025

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

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.

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:

Retrieved from "https://kb.phenomportal.com/index.php?title=CSV&oldid=1533"