---
title: Import Instance(s) Wizard
slug: solutions/import-instances-wizard
docTags: 
createdAt: 2025-08-21T14:19:27.445Z
---

The Import Instance(s) Wizard allows users to search for Digital Twin Instance(s) on a Litmus Edge and select which of these Instance(s) they want to import the Instance settings into the DT Instance Management tool.

# Open the Import Instance(s) Wizard

To open the Import Instance(s) Wizard, press the **Import Instance(s)** button from the **LitmusConfiguration&#x20;**&#x52;ibbon.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/b_5djwE1dwWH1ugviIuNx_image.png" size="80" width="396" height="141" position="center" showCaption="false"}

:::hint{type="info"}
**Notes:**

To open the Import Instance(s) Wizard, the tool will verify that it is **not** in the Status:

- Offline
- DigitalTwin not responding
- No LE Set
- No API Key

If the Tool found to be in one of these states, a message is displayed.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/EdUZ3IZBvYDwaqbutbqik_image.png" size="60" width="405" height="172" position="center" showCaption="false"}
:::

# Setting up the Search Filter

To search for Digital Twin Instance(s), the user can setup a filter to apply to the search.
This allows them to reduce the list for potentially imports to only the Instance(s) they are truly interested in.

## Select the LE Device IP

### Tool set to One LE

If the tool is set to **Connect To** *One LE*, the user will not be able to change or select the LE Device IP.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/0PCmofeo1-k6x962p0DYK_image.png" size="70" width="465" height="320" position="center" showCaption="false"}

### Tool set to Multiple LE

If the tool is set to **Connect To** *Multiple LE,* the user can select which Litmus Edge to search for, provided that more than one **Target Litmus Edge IP** has been defined.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Jv2v-mF4VIBDUweNREnwg_image.png" size="80" width="1115" height="516" position="center" showCaption="false"}

Additionally users can also enter a Litmus Edge IPv4 which is not yet present in the sheet

The tool will check if it does have an API Key for the Litmus Edge IPv4 address.
If no API Key is found, it will notify the user and request the API Key.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/eQ-H2s9b-SjtGOsOcP9qk_image.png" size="80" width="795" height="476" position="center" showCaption="false"}

Press the **Yes** Button, provide the API Key and press the **Save&#x20;**&#x42;utton.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/TrmTsEHnoDpyjUQH-MysO_image.png" size="80" width="716" height="557" position="center" showCaption="false"}

## Set Search Option

The tool provides a number of Filter Options the user can select from.
The include:

- **ALL**: Do not apply any filter and return all Instance(s) defined in DigitalTwin on the selected Litmus Edge
- **EQUAL TO**: Select all Instance(s) whith a Instance Name equal to my [Instance Name Mask](docId\:XAVoZF7Yih7-eQqHvotlU).
- **NOT** **EQUAL TO**: Select all Instance(s) whith a Instance Name not equal to my [Instance Name Mask](docId\:XAVoZF7Yih7-eQqHvotlU).
- **CONTAINS**: Select all Instance(s) where the Instance Name contains the value from my [Instance Name Mask](docId\:XAVoZF7Yih7-eQqHvotlU).
- **DOES NOT CONTAIN**: Select all Instance(s) where the Instance Name does not contain the value from my [Instance Name Mask](docId\:XAVoZF7Yih7-eQqHvotlU).
- **BEGINS WITH**: Select all Instance(s) where the Instance Name begins with the value from my [Instance Name Mask](docId\:XAVoZF7Yih7-eQqHvotlU).
- **ENDS WITH**: Select all Instance(s) where the Instance Name ends with the value from my [Instance Name Mask](docId\:XAVoZF7Yih7-eQqHvotlU).

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/dM-8Nh0wFhGRew5h-R8dy_image.png" size="80" width="818" height="389" position="center" showCaption="false"}

:::hint{type="info"}
**Notes:**

Al&#x6C;**&#x20;Search Options** except *ALL*, require a value for the [Instance Name Mask](docId\:XAVoZF7Yih7-eQqHvotlU).&#x20;
:::

## Define the Instance Name Mask

For any **Search Option** except *ALL*, a mask is required to apply to the Instance Name.

Example: Selected **Search Option** set to *EQUAL TO* and **Instance Name Mask** set to *Test&#x20;*

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/E2yc-jl4QCQpDpuQMU8GU_image.png" size="80" width="758" height="344" position="center" showCaption="false"}

## Define the Digital Twin Model

Select if you want to search for Instance(s) only from a specific Digital Twin Model or over all (field is empty) Model(s).

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/7KQ7tYSRR18ZFTJRS1my5_image.png" size="80" width="760" height="568" position="center" showCaption="false"}

The Import Wizard will show what Filter will be applied.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/J_EXiEZCheo38WvZF7-NO_image.png" size="80" width="797" height="563" position="center" showCaption="false"}

## Initiate the Search

If all settings are correctly set, the Search Button will be set to green and allows to initiate the search.
To initiate the search press the green **Search** button.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/_CVmsUngIxEh_t_6ch5dN_image.png" size="80" width="862" height="743" position="center" showCaption="false"}

:::hint{type="info"}
**Notes:**

If the Filter is invalid, the Search button will be grayed out and can not be used.

Example: No **Instance Name Mask** has been defined for the **Search Option&#x20;***EQUAL TO*

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/gQiNAYSOoXCSTpiP8wlAp_image.png" size="80" width="848" height="743" position="center" showCaption="false"}
:::

# Importing Instance(s)

After the Search has been initiated, the results are shown in a List Box.

The User will see the **Model Name&#x20;**&#x61;s well as the **Instance Name**.

![](https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/7kOYlfRxxKYLTjIzXxAqR_image.png)

:::hint{type="info"}
**Notes:**

In case a Filter returned no Instance(s), the user is informed and can initiate a new Search.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/hQDzoT6AF73QwlBImKOH4_image.png" size="70" width="879" height="732" position="center" showCaption="false"}
:::

## Selecting all Instance(s)

To select all Instance(s) for Import, check the Checkbox of the Header Row.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/CDQsq8nH20PUnq-T-5M0v_image.png" size="70" width="669" height="326" position="center" showCaption="false"}

## Unselecting all Instance(s)

To unselect all Instance(s) for Import, uncheck the Checkbox of the Header Row.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Y888ZYx1hk-0Zq9Gijnnf_image.png" size="70" width="650" height="305" position="center" showCaption="false"}

## Select individual Instance(s)

To select individual Instance(s) for Import, check their respective Row or Checkbox.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/br2jCSkGz6GrbAX9kjAt7_image.png" size="70" width="727" height="361" position="center" showCaption="false"}

## Unselect individual Instance(s)

To unselect individual Instance(s) for Import, uncheck their respective Checkbox or Row.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/AR0bgS7KEG7ejUFwqbpoX_image.png" size="70" width="683" height="349" position="center" showCaption="false"}

## Import Instance(s)

If at least one Instance has been selected from the list, the Import button will change to green and an Import can be initiated.
To initiate an Import press the green **Import&#x20;**&#x62;utton.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/Zw4cI5IXk_p1dxBTqn1Gq_image.png" size="80" width="789" height="713" position="center" showCaption="false"}

If no Instance(s) have been selected, the Import button will be greyed out.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/sYwCSVuAj7mlgrW_CvRHY_image.png" size="80" width="786" height="653" position="center" showCaption="false"}

:::hint{type="info"}
**Notes:**

The Import wizard will show how many Instance(s) have been selected in the left lower corner.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/3YWTD6FxyFAWA1eYMNZhh_image.png" size="60" width="259" height="600" position="center" showCaption="false"}
:::

## After an Import finished

Once all the selected Instance(s) have been imported, the user is informed about the result and has three further options:

1. **Close&#x20;**&#x74;he Wizard. This will end the import and the user can proceed with their desired actions on the sheet.
2. Set up a new [Search Filter](docId\:XAVoZF7Yih7-eQqHvotlU) to execute a **New Search.**
3. [Select further Instance(s)](docId\:XAVoZF7Yih7-eQqHvotlU) from the list they previously hadn't selected for another **Import**.

::Image[]{src="https://api.archbee.com/api/optimize/SSUUxKZUk9bFTEPNn_6Zo/TljDO3vYVsyUUJHHUKiqU_image.png" size="80" width="884" height="755" position="center" showCaption="false"}

