# Image Archive

> Symcon documentation · English · generated on 2026-09-26  
> Index: https://www.symcon.de/en/llms.txt

Source: https://www.symcon.de/en/service/documentation/module-reference/logic/image-archive/

_Requires Symcon >= 4.2_

The module copies an image when triggered by a selected variable. It is adjustable how many images should be saved.

### Function scope
- Selectable source image and selectable trigger variable
- Adjustable number of images to be saved
- When a trigger variable is selected, an event is created that reacts to its update
- The event can be fully personalized except for the trigger variable
- Images get the time of triggering as name
- Images are displayed chronologically from old -> new in the category images
- Automatic deletion of the oldest images, when the maximum number of images is reached

### software installation
- Install the 'Image-Archive' module via the [Module Store](https://www.symcon.de/en/service/documentation/components/management-console/module-store/).

### Setting up instances in IP-Symcon
- Under "Add Instance" the 'Image-Archive' module can be found using the quick filter.
  - More information about adding instances in the [Instances documentation](https://www.symcon.de/en/service/documentation/basics/instances/)

#### configuration page

| Name             | Description                                                               |
| ---------------- | ------------------------------------------------------------------------- |
| Image            | Source image to be copied                                                 |
| Number           | Maximum number of images to be saved                                      |
| Trigger Variable | Variable at whose change the source image should be copied to the archive |

### status variables

The status variables/categories are created automatically. Deleting individual ones can lead to malfunctions.

#### Statusvariables

| Name     | Type     | Description                                                                    |
| -------- | -------- | ------------------------------------------------------------------------------ |
| Images   | Category | The source images are copied into here                                         |
| AddImage | Event    | Triggered by the trigger variable and triggers the copying of the source image |

### Visualization
The Visualization is used to display the variable. No further control or separate display is integrated.

To display the images in the 'Bildarchiv' category, a content divider can be added in the Visualization or a link of the category can be made.
Attention: It is not useful to link directly the images from the archive, because the updates change the ID's.

## BA_AddImage

Source: https://www.symcon.de/en/service/documentation/module-reference/logic/image-archive/ba-addimage/

`bool BA_AddImage(int $InstanceID)`

_Requires Symcon >= 4.2_

Copies the current source image to the "Images" category of the "ImageArchive" module with the InstanceID.

**Parameters**

- `$InstanceID` (int): ID of the Instance

**Returns** (bool): If the command could be executed successfully, it returns __TRUE__ as result, otherwise __FALSE__.

ID of the Instance

**Example**

```text
BA_AddImage(12345);
```