CSV: Difference between revisions

From PHENOM Portal Knowledgebase
Jump to navigation Jump to search
VisualWikitext
(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...")
 
No edit summary
 
(8 intermediate revisions by the same 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.
[[File:Phenom-data model-import csv.png|1200px|border]]
To import a CSV file,
* Select the type of data from the Import Type dropdown. Selecting the "... UPDATE" option for any type of data will overwrite existing information.
* Under Import File, select a properly formatted CSV file (formatting rules are provided below)
* Click the Import button on the lower right side
The import might take some time depending on the size of the file. After the import finishes, a success message or an Import Errors message with each error and its respective row will be displayed.
[[File:Phenom-data model-import csv update.png|1200px|border]]


The types of data the user can import are:
The types of data the user can import are:
* View-Characteristic
* View-Characteristic (see [[Formatting a CSV for View Import]])
* Enum-Literal
* Enum-Literal (see [[Formatting a CSV for Enum Import]])
* Model-Content
* Model-Content (see [[Formatting a CSV for Model Content Import]])
* Constraints
* Constraints
* Message Data Model
* Message Data Model
* Platform Types
* 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 the Import Type dropdown:
Click the Browse button under Import File:
Select a properly formatted CSV file (see CSV Format/ Instructions / API):
Click the Import button on the lower right side:
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.
Formatting a CSV for DSDM Import
Use the following CSV Format/ Instructions / API [CSV Template]
Each row creates 1 attribute on 1 element. Creation of new elements is incidental and done only if a match isn't found.
Column & Data Requirements:
Required column headers
Element_Name
Operation_Type
Attribute_Name
Attribute_Type
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 14:55, 18 October 2022

The CSV import tool allows users to bulk import data into their model.

To import a CSV file,

  • Select the type of data from the Import Type dropdown. Selecting the "... UPDATE" option for any type of data will overwrite existing information.
  • Under Import File, select a properly formatted CSV file (formatting rules are provided below)
  • Click the Import button on the lower right side

The import might take some time depending on the size of the file. After the import finishes, a success message or an Import Errors message with each error and its respective row will be displayed.

The types of data the user can import are:

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