How to import a .farki package

Import a package

1. File > Import Package…
2. Select the file from your filesystem — a .farki model file or a .farki.zip archive (attachments included)
3. The file’s contents are imported into your current project

While it imports, a progress panel shows the current step, with counts where they’re known. The imported packages appear in the Explorer. If the file contains an M2 metamodel, its element types and relationship types become available in the Palette for any diagram that imports that metamodel.

After importing an M2 metamodel

When the imported package is an M2 metamodel and the project has M1 models, Farkitect offers to import it into them on the spot: a dialog lists your M1 models — models with no imports yet come pre-ticked — and Import wires them up in one step. Click Not now to skip; imports can always be managed later from each model’s Properties panel (see How to declare package imports).

If the model needs a metamodel you don’t have

An M1 model is built on one or more metamodels. If a metamodel it needs isn’t in the project, the import stops before anything is written, and a dialog names what’s missing — for example, “M1 Farquind ArchiMate 4” needs a metamodel this project doesn’t have.

1. Click Import <metamodel name>… (or Import metamodel… when several are missing)
2. Choose that metamodel’s .farki file
3. Repeat for each one listed — each is ticked off as it comes in

Once every metamodel is in, your original file imports on its own. Cancel stops without importing the model.

File > Import Project… doesn’t offer this: a project file with a missing metamodel is refused with an error message. Import the metamodel into the project, or use a project file that includes it.

If a package with the same name exists

When the project already has a package of that name, a Package Already Exists dialog asks what to do:

Choice	What it does
Skip	Leave the existing package alone and don’t import this one
Import as Copy	Import beside the existing package (M1 models only)
Replace	Delete the existing package and import the file in its place
Upgrade…	Shown instead of Replace for an M2 metamodel that models use

Replace isn’t offered for a metamodel in use. Replacing it would give its types new ids and leave every model’s elements without a type, so the dialog explains: “N models use this metamodel. Replacing it would leave their elements without types. Upgrade it instead…”. Upgrade… opens the upgrade dialog with this file already chosen — see How to upgrade a metamodel.

The same choices appear when you import a package FarkiBot has staged.

If an import fails

A failed import shows an error message that says what went wrong. It stays on screen until you close it, and the same message is written to the Log panel.

Importing attachments (.farki.zip)

A .farki.zip archive (produced by exporting a package with attachments) is auto-detected on import. Its bundled images and files are restored to their elements, and a confirmation summarises what came in — for example, “12 elements, 3 attachments restored”. Archive import works in both the desktop and web apps. See How to attach files, images, and links.

What gets imported

A .farki file can contain:

• M2 metamodel packages — element types, relationship types, notation, properties, enumerations, and constraints
• M1 model packages — elements, relationships, property values, diagrams, catalogs, boards, and the view links between them
• Both — a file can include an M2 metamodel and M1 models that use it

All packages in the file are imported into the current project. If a package with the same name already exists, you’re asked what to do — see above.

Project-scope vs package-scope files

• Package-scope files (the most common) contain one or more packages. Use File > Import Package… to bring them into an existing project.
• Project-scope files contain a complete project. Use File > New Project… > From File to create a new project from these.

The file’s scope is set when it’s exported. You can check the scope by opening the .farki file in a text editor and looking at the "scope" field.