# Omron Sysmac Studio

## Agent Requirements

{% hint style="warning" %}
Below are the Agent system requirements to configure a Copia Agent for the backup of Omron Sysmac Studio based projects (NJ/NX controllers). You can find the Omron Source Control documentation here: [Omron](/docs/git-based-source-control/supported-vendors/omron.md)
{% endhint %}

* You will need a licensed copy of Omron Sysmac Studio that is capable of backing up your controller.
* The Copia Agent must be run as an administrator. Since Omron Sysmac Studio runs with administrator privileges, the Copia Agent will not be able to back up your controllers unless it is similarly elevated

<figure><img src="/files/NGWCAgkJs3I5ROaIHZUA" alt=""><figcaption></figcaption></figure>

## Project Configuration

To configure an Omron Sysmac Studio project, you will need a repository with an existing Omron Sysmac Studio file.&#x20;

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

<figure><img src="/files/AkiiSsd2QLumMDLIi4Vb" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
In Copia nomenclature, NJ/NX controllers are referred to as "devices"
{% endhint %}

The *Add a new project* configuration dialog will appear which allows you to fully configure the project, controller device(s) and job for the project. This is a multi-step process with each section explained in detail.  At any time, you can edit the prior section of this workflow. &#x20;

{% hint style="info" %}
The project can be edited after creation.  Controller "Devices" and Jobs can also be edited or created directly, using the Devices or Jobs tab.  The steps for creation are similar to the steps provided below for those sections.
{% endhint %}

### Define the Project

{% hint style="info" %}
Any screenshot items with an asterisk are required.
{% endhint %}

To get started, we will first select the *Project Type* from the list provided, and then select an *Agent*.  If you have not already created an Agent, you can create and assign an Agent at a later time.  See more about this in the [Agents ](/docs/devicelink/sitesandagents/agents.md)section of the documentation.

<figure><img src="/files/Tbo3NAGT7EzY2X9DjbPE" alt=""><figcaption></figcaption></figure>

When complete, press *Save and Continue*.

<figure><img src="/files/JWNV3WQ9j884rh2olsiV" alt=""><figcaption></figcaption></figure>

You will now select the Project Path, which is the location (Repository and Branch) that the project is, or will be stored.

{% hint style="info" %}
You can edit the previous steps at any time.
{% endhint %}

First, select a repository. You may use the search bar to navigate your organizations repositories.&#x20;

<figure><img src="/files/mCFeGpS6pGZCau32O5Wy" alt=""><figcaption></figcaption></figure>

Second, you'll need to select a branch.

<figure><img src="/files/Y7wzm91GUTgfNVvliYSs" alt=""><figcaption></figcaption></figure>

And lastly for Project Path you'll need to select the file you want to back up.

{% hint style="info" %}
You may need to navigate down through folders depending on how you've set up your repository.
{% endhint %}

<figure><img src="/files/bnWWo3fOHbWht2YnmNFA" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
The file that you select must include controller communication settings. Copia makes use of saved settings to back up from individual controllers.
{% endhint %}

### Project Details

Add a relevant name and description for your project.

<figure><img src="/files/t3v2FuM2YqZssSF6Tont" alt=""><figcaption></figcaption></figure>

### Define the Controller Device(s)

The controller "Device Setup" section is for defining the information Copia needs to communicate with a controller (Name, authetntication, etc.).  If you have pre-created devices before entering the *Add Project* portal, you can select *Add Existing Devices*. Otherwise you can *Add a Device* as seen.

For Omron Sysmac Studio backups, you may add as many controller devices as are in your project, where each name matches the device name in the **Multiview Explorer**.

{% hint style="warning" %}
If your controller is password protected, you **MUST** include the username and password or the agent will not be able to back up the controller. If there is no username/password combination, leave this section blank.
{% endhint %}

{% hint style="warning" %}
**Each** controller "Device Name" **MUST** match the name found in the **Multiview Explorer**.
{% endhint %}

<figure><img src="/files/wuX3VwcBrtTMyHej0W3G" alt=""><figcaption></figcaption></figure>

Press *Save Device* when complete.

### Define the Job(s)

Creating Jobs is similar for all vendor types, and is described in the [Creating Jobs](/docs/devicelink/jobs/creating-jobs.md) section.  It is recommended to review that section while completing a job configuration, and press Save to save the job.

### Submit the Configuration

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

<figure><img src="/files/05e951REQv0O6VQeTKcA" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Don't forget to enable/disable the [Watch ](/docs/devicelink/projects-and-devices.md#watching-a-project)button, based on your preferences for project [Notifications](/docs/devicelink/administration/notifications.md).
{% endhint %}


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.copia.io/docs/devicelink/basic/omron-sysmac-studio.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.