> For the complete documentation index, see [llms.txt](https://docs.itconductor.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.itconductor.com/user-guide/sid-refresh/getting-started.md).

# Getting Started

The following sections introduce you to the first few actions as a new user of SID-Refresh.

### General Prerequisites <a href="#gettingstarted-generalprerequisites" id="gettingstarted-generalprerequisites"></a>

* Should be run as **\<sid> adm** account.
* Requires Java Runtime Environment **(JRE) version 1.8 or higher**.
* Requires SID-Refresh license file **SIDREFRESH.LIC** in the directory with the **SIDRefresh.jar** file for Linux/Unix or the SIDRefresh.jar file for Windows systems.
* SID-Refresh can be on Linux/Unix/Windows.
* SID-Refresh can be run using GUI or the terminal console.
* It is strictly recommended to use the **R3trans version** with timestamp **24.03.17 or newer**.

### Initial Setup <a href="#gettingstarted-initialsetup" id="gettingstarted-initialsetup"></a>

1\. Download SID-Refresh [here](https://www.itconductor.com/download-sid-refresh-tool).

2\. Log in to the source system using an **\<sid> adm** account.

3\. Copy/Paste the **SIDRefresh.jar** (For Linux/Unix) or **SIDRefresh.exe** file (for Windows system) and the **SIDREFRESH.LIC** license file in the same directory.

4\. Verify if the Java version installed in the system met the minimum requirement as stated in the General Prerequisites.

* For Linux/Unix, run the following command in a terminal:&#x20;
  * **java -version**
* For Windows, run the following command in the command prompt:
  * **java -version**

5\. Verify if the x terminal is working and if necessary, adjust the DISPLAY environment variable because it is required to run the X11 server.

6\. Verify if the R3Trans path is within the SID adm directory and if you can execute a test connect.

* For Linux/Unix, run the following command in a terminal:
  * **R3trans -x**
* For Windows, run the following command in the command prompt:
  * **R3trans.exe -x**

### Installing and Updating Licenses <a href="#gettingstarted-installingandupdatinglicenses" id="gettingstarted-installingandupdatinglicenses"></a>

* You will receive an email with the license key file attached.
* If you need to renew or replace the key, please [open a support ticket](https://www.itconductor.com/support) or email us at <support@itconductor.com>.
* Copy the license key file **SIDREFRESH.LIC** to the SID-Refresh home directory where the **SIDRefresh.jar** is located.

### More Information <a href="#gettingstarted-moreinformation" id="gettingstarted-moreinformation"></a>

* To start administering system refresh with SID-Refresh, you may proceed to [Documentation](/user-guide/sid-refresh/documentation.md).
* To troubleshoot issues encountered, you may proceed to the [Troubleshooting Guide](/user-guide/sid-refresh/troubleshooting.md).
* For a more detailed guide, you may download the SID-Refresh Guide.

{% file src="/files/HnR6oQQ0A4pavcbVn64h" %}


---

# 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 dynamically by asking a question.

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

```
GET https://docs.itconductor.com/user-guide/sid-refresh/getting-started.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
