> For the complete documentation index, see [llms.txt](https://docs.copia.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.copia.io/docs/devicelink/basic/ge-ifix.md).

# GE iFIX

## Overview

GE iFIX stores its configuration, alarm, historical and picture data in a set of system folders on each iFIX node. Using a [Copia Scripting](https://docs.copia.io/docs/devicelink/basic/copia-scripting.md) project, the Copia Agent can copy these folders on a schedule, commit them to your repository, and notify you when changes occur.

This page explains how to prepare a backup script for iFIX and configure the Script project in DeviceLink.

## Agent Requirements

Below are the Agent system requirements to configure a Copia Agent for the backup of GE iFIX nodes:

* The Agent must be able to reach the iFIX node over the network (for example, through an administrative share such as `\\[IP ADDRESS]\c$`, or a dedicated shared folder).
* The user account that runs the Copia Agent must have permission to read the iFIX system folders on the target node.
* The script path must be added to the Agent's [Script Path Allowlist](https://docs.copia.io/docs/devicelink/basic/copia-scripting#script-path-allowlist).

{% hint style="info" %}
Before configuring the project, log in to the Agent machine with the account that runs the Copia Agent and manually browse to the iFIX folders on the target node. This confirms the Agent will have access during the backup.
{% endhint %}

## iFIX Back Up

Copia recommends backing up the iFIX system folders listed in GE's Backing Up and Restoring Files documentation:

* ALM path (\*.\*)
* APP path (\*.\*)
* HTR path (\*.\*)
* HTRDATA path (\*.\*)
* LOCAL path (\*.\*)
* PDB path (\*.\*)
* PIC path (\*.\*)
* RCC path (\*.\*)
* RCM path (\*.\*)

{% hint style="warning" %}
The location of each folder is set in the iFIX System Configuration Utility (SCU) under *Configure > Paths*, and can differ from the default installation path. Confirm the paths on each node before creating the script.
{% endhint %}

{% hint style="info" %}
HTRDATA can grow large over time. If you only need to track configuration changes, you can remove it from the script.&#x20;
{% endhint %}

## Scripts

The script below copies each iFIX folder into the `%temp%\backup_results\` folder on the Agent. Copia compresses this folder and commits the contents to your repository.

1. On the Agent, create the folder `C:\copia\scripts\`.
2. Create a new text file in that folder and rename it, for example `ifix_backup.bat`.
3. Copy the script below into the file.
4. Replace `IFIX_PATH` with the path to the iFIX installation on the target node.
5. Remove any folders you do not want to back up from the `FOLDERS` list.
6. Save the file and test it from the command line on the Agent.

```batch
echo Running iFIX ALM Backup Script...
@echo off
REM -Setup-------------------------------------------------------------
echo %date% %time% Starting iFIX ALM Backup Script >> %temp%\backup_results\CopiaError.log

REM -Script------------------------------------------------------------
xcopy "\\[IP ADDRESS]\c$\Program Files (x86)\GE\iFIX\LOCAL" %temp%\backup_results\ALM /e /v /h /k /o /y /f /d /i

REM -Cleanup and Exit--------------------------------------------------
echo %date% %time% Completed Backup Command >> %temp%\backup_results\CopiaError.log

REM -Remove Error Log:  No error log is considered a success ----------
del %temp%\backup_results\CopiaError.log
exit 
```

#### (Optional) Use the iFIX Backup and Restore Wizard

Optionally, instead of copying modified folders and files directly, you could create a script to run the iFIX Backup and Recovery feature via command line, and copy the results to Copia.

## Project Configuration

The first step is to create a repository for your iFIX backup to reside in. You can just create a single repository (*i.e. perhaps named iFIX\_\[servername]*). Depending on the type of backup you will perform, you may want to create subfolders in the repo for each of the folders to be backed up (*such as ALM, HTR, PDB, etc.*).

More information about the proper folders to back up can be found in the [iFIX Backup and Recovery feature documentation](https://www.ge.com/digital/documentation/ifix/version2024/index.html#understanding-ifix/und_backing_up_and_restoring_files.htm?TocPath=*Understanding%2520iFIX*%257CManaging%2520iFIX%2520Nodes%257CBacking%2520up%2520and%2520Restoring%2520Files%257C_____0).

Click either of the *Add a Project* buttons in the Projects tab.

<figure><img src="https://3704730939-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4lSQNVI3DZ15V7kjkMCA%2Fuploads%2F7MK9TYvucWnrlbZ0AKPB%2Fimage.png?alt=media&amp;token=f00aed8d-d6df-41b0-9509-ca5e86edacd6" alt=""><figcaption></figcaption></figure>

The *Add a new project* configuration dialog will appear which allows you to fully configure the project, devices and job for the project.

<figure><img src="https://3704730939-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4lSQNVI3DZ15V7kjkMCA%2Fuploads%2Ff3vkLdZp09VgauvwZ2Ey%2Fimage.png?alt=media&amp;token=37d723ba-f460-4010-9869-6c977d6df8da" alt=""><figcaption></figcaption></figure>

#### Define the Project

Now you just need to make a Copia Scripting project in Copia. Select **Script** as the *Project Type*, and then select an *Agent*. See more about this in the [Agents](https://docs.copia.io/docs/devicelink/sitesandagents/agents.md) section of the documentation.

<figure><img src="https://3704730939-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4lSQNVI3DZ15V7kjkMCA%2Fuploads%2FVn2oGBOfqEhsKYk0eAue%2Fimage.png?alt=media&amp;token=e0213a91-a8a5-4085-ab47-d616db490309" alt=""><figcaption></figcaption></figure>

When choosing the *Project Path*, select the repository you created, and (if not already created) choose to make a new folder named the same as the iFIX system folder you are backing up (*i.e. ALM, HTR, PDB, etc.*).

<figure><img src="https://3704730939-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4lSQNVI3DZ15V7kjkMCA%2Fuploads%2FMF5IeHbEolEeHrKNGSGv%2Fimage.png?alt=media&amp;token=b86a473c-05b4-42ff-8d8f-12fe61906e0a" alt=""><figcaption></figcaption></figure>

When defining the script, add the full path to the script on the Agent. In the above example: `c:\copia\scripts\ifix_ALM_backup.bat`

<figure><img src="https://3704730939-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4lSQNVI3DZ15V7kjkMCA%2Fuploads%2F3wt2kxE8elI3EURSfUoO%2Fimage.png?alt=media&amp;token=dc835198-8f23-44d9-a53a-ae05e45df86c" alt=""><figcaption></figcaption></figure>

#### Define the Device

Since the Script exists on the Agent, there is no need to define a Device for Projects that use a Script during setup. You can skip to the Job section.

#### Define the Job

Creating Jobs is similar for all vendor types, and is described in the [Creating Jobs](https://docs.copia.io/docs/devicelink/jobs/creating-jobs.md) section.

#### Submit the Configuration

Once complete, press *Submit Project Setup* to create the Project, Device and Job.

<figure><img src="https://3704730939-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4lSQNVI3DZ15V7kjkMCA%2Fuploads%2F6Mx8cT0DD4yHQuohyjG1%2Fimage.png?alt=media&amp;token=f5189109-a7ef-48b3-98fd-b307fe795108" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.copia.io/docs/devicelink/basic/ge-ifix.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
