> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSReplicationAgent

> Replication/Travel administration.

Replication/Travel administration.

## Constructors

### NSReplicationAgent()

```crmscript theme={null}
NSReplicationAgent
```

Replication/Travel administration.

## Methods

## CreateDefaultSatellite()

Sets default values into a new NSSatellite.

```crmscript theme={null}
NSSatellite CreateDefaultSatellite()
```

**Returns:** [CRMScript.NetServer.NSSatellite](CRMScript.NetServer.NSSatellite)

<Note>
  NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance
</Note>

**Example:**

```crmscript theme={null}
NSReplicationAgent agent;
NSSatellite thing = agent.CreateDefaultSatellite();
thing = agent.SaveSatellite(thing);
```

## GetArea(Integer)

Gets an NSArea object.

```crmscript theme={null}
NSArea GetArea(Integer areaId)
```

**Returns:** [CRMScript.NetServer.NSArea](CRMScript.NetServer.NSArea)

**Example:**

```crmscript theme={null}
NSReplicationAgent agent;
NSArea thing = agent.GetArea(123);
```

## GetAreaList(Integer\[])

Gets an array of NSArea objectsGets an array of NSArea objects.

```crmscript theme={null}
NSArea[] GetAreaList(Integer[] areaIds)
```

**Returns:** [CRMScript.NetServer.NSArea](CRMScript.NetServer.NSArea)\[]

**Example:**

```crmscript theme={null}
Integer[] ids;
NSReplicationAgent agent;
agent.GetAreaList(ids);
```

## GetCentralLicense()

```crmscript theme={null}
NSLicenseOwner[] GetCentralLicense()
```

**Returns:** [CRMScript.NetServer.NSLicenseOwner](CRMScript.NetServer.NSLicenseOwner)\[]

## GetSatellite(Integer)

Gets an NSSatellite object.

```crmscript theme={null}
NSSatellite GetSatellite(Integer satelliteId)
```

**Returns:** [CRMScript.NetServer.NSSatellite](CRMScript.NetServer.NSSatellite)

**Example:**

```crmscript theme={null}
NSReplicationAgent agent;
NSSatellite thing = agent.GetSatellite(123);
```

## SaveCentralLicense(NSLicenseOwner\[])

```crmscript theme={null}
NSLicenseOwner[] SaveCentralLicense(NSLicenseOwner[] license)
```

**Returns:** [CRMScript.NetServer.NSLicenseOwner](CRMScript.NetServer.NSLicenseOwner)\[]

## SaveSatellite(NSSatellite)

Updates the existing NSSatellite or creates a new NSSatellite if the ID parameter is 0.

```crmscript theme={null}
NSSatellite SaveSatellite(NSSatellite satellite)
```

**Returns:** [CRMScript.NetServer.NSSatellite](CRMScript.NetServer.NSSatellite) - The new or updated NSSatellite.

**Example:**

```crmscript theme={null}
NSReplication  agent;
NSSatellite thing = agent.CreateDefaultSatellite();
thing = agent.SaveSatellite(thing);
```

## SetFreetextSearchEnabledOnArea(Integer,Bool)

Enables free-text search on this area

```crmscript theme={null}
Void SetFreetextSearchEnabledOnArea(Integer areaId, Bool freetextEnabled)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSReplicationAgent agent;
Integer areaId;
Bool freetextEnabled;
agent.SetFreetextSearchEnabledOnArea(areaId, freetextEnabled);
```


## Related topics

- [Preference section FieldReplication](/en/admin/user-preferences/reference/field-replication.md)
- [dbi_agent table](/en/database/tables/dbi-agent.md)
- [dbi_agent_field table](/en/database/tables/dbi-agent-field.md)
- [dbi_agent_schedule table](/en/database/tables/dbi-agent-schedule.md)
- [SuperOffice.WebApi.Data.UserPreferenceStrings.FieldReplication](/en/api/reference/webapi/SuperOffice.WebApi.Data.UserPreferenceStrings.FieldReplication.md)
- [Database mirroring](/en/online/mirroring/overview.md)