IP-XACT Editor Quick Start

1                   Start Eclipse

If you are running a new installation of Eclipse for the first time, a dialog similar to the one below will appear:

Enter a suitable directory for your workspace files.  (This is where your projects and personal settings will be stored.)

Eclipse will display a Welcome window - you may close this (inner) window.

2                   Set Preferences

Select Window - Preferences... to display the Preferences dialog.

Locate the IP‑XACT node in the tree and select it.

Enter values for Default Vendor Name and Default Library Name, and press OK.

3                   Set the IP‑XACT Perspective

Select Window - Open Perspective - Other...

In the Open Perspective dialog, select IP‑XACT, and press OK.

The set of open windows will change reflecting the new perspective.

4                   Create a new Project

Select File - New - Project...

In the New Project wizard, expand the General tree node and select Project.

Select Next, and enter Example, then press Finish.

5                   Create a new IP‑XACT File[1]

Select File - New - IP‑XACT File...

In the Create XML File wizard, select the Example project, and then enter a name for the file.  For this example, enter busDef.spirit.  (We will create a Bus Definition IP‑XACT file.)

Select Next.

The following page should appear:

Select busDefinition for the Root Element and then select Next.

Fill out the Name and Version fields on the Set VLNV page with busDef and 1.0 respectively.  (The Vendor and Library fields should be filled in with your Preference default values.  The Name and Version fields are set to the file name and 1.0 respectively.)

[If you have not set the Preference default values, the Vendor and Library fields are set to <username> and <username>Lib respectively since empty fields in the VLNV structure are not valid.]

Select Finish

An IP‑XACT editor window should appear (busDef.spirit) that has both Design and Source tabs.  In addition, in the IP‑XACT Library view, the file should be shown under its VLNV path.

If you have completed these steps, the editor is correctly installed.

Create IP‑XACT File Options

Option

Purpose

Create optional attributes

Both mandatory and optional attributes will be generated.

Create optional elements

Both mandatory and optional elements will be generated.

Create first choice of required choice

The first option of a required choice will be generated in your XML file.

Fill elements and attributes with data

Any elements and attributes generated will be filled with sample data.

If you do not select any of these options, then only the minimum amount of content required for the XML file will be created.

 



[1] This step requires an Internet connection to download the IP-XACT schemas from the SPIRIT Consortium.  Once the schemas have been downloaded, they are cached in the current workspace.  (If you switch workspace, they will be downloaded once again.)