> ## 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.

# NSArchiveConfiguration

> Used to store and fetch the configuration of an archive. The configuration consists of entities and columns; entities correspond to archive provider entities and the checkboxes you see in the bottom of standard archives. Column configuration includes both what columns should be visible, what order they are in (left to right), and whether the archive rows should be sorted by one or more columns.

Used to store and fetch the configuration of an archive. The configuration consists of entities and columns; entities correspond to archive provider entities and the checkboxes you see in the bottom of standard archives. Column configuration includes both what columns should be visible, what order they are in (left to right), and whether the archive rows should be sorted by one or more columns.

Desired columns can be set through the selectable MDO list called archiveColumns:\\\<perovider name>, and entities can be set through the selectable MDO list archiveEntities:\\\<provider name>. You can also use the SetChosenEntities and SetChosenColumns method of this service. The selectable MDO list implementation is suitable for data binding using mdo list controls.

## Constructors

### NSArchiveConfiguration()

```crmscript theme={null}
NSArchiveConfiguration
```

Initializes a new instance of the NSArchiveConfiguration class.

## Methods

## GetArchiveColumnInfo()

```crmscript theme={null}
NSArchiveColumnInfo[] GetArchiveColumnInfo()
```

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

**Example:**

```crmscript theme={null}
NSArchiveConfiguration thing;
NSArchiveColumnInfo[] archiveColumnInfo = thing.GetArchiveColumnInfo();
```

## GetArchiveEntityInfo()

```crmscript theme={null}
NSSelectableMDOListItem[] GetArchiveEntityInfo()
```

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

**Example:**

```crmscript theme={null}
NSArchiveConfiguration thing;
NSSelectableMDOListItem[] archiveEntityInfo = thing.GetArchiveEntityInfo();
```

## GetArchiveOrderByInfo()

```crmscript theme={null}
NSArchiveOrderByInfo[] GetArchiveOrderByInfo()
```

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

**Example:**

```crmscript theme={null}
NSArchiveConfiguration thing;
NSArchiveOrderByInfo[] archiveOrderByInfo = thing.GetArchiveOrderByInfo();
```

## GetOwnerKeys()

```crmscript theme={null}
String GetOwnerKeys()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The actual ownership information for the configuration that was retrieved.

**Example:**

```crmscript theme={null}
NSArchiveConfiguration thing;
String ownerKeys = thing.GetOwnerKeys();
```

## SetArchiveColumnInfo(NSArchiveColumnInfo\[])

```crmscript theme={null}
Void SetArchiveColumnInfo(NSArchiveColumnInfo[] archiveColumnInfo)
```

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

**Example:**

```crmscript theme={null}
NSArchiveConfiguration thing;
NSArchiveColumnInfo[] archiveColumnInfo;
thing.SetArchiveColumnInfo(archiveColumnInfo);
```

## SetArchiveEntityInfo(NSSelectableMDOListItem\[])

```crmscript theme={null}
Void SetArchiveEntityInfo(NSSelectableMDOListItem[] archiveEntityInfo)
```

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

**Example:**

```crmscript theme={null}
NSArchiveConfiguration thing;
NSSelectableMDOListItem[] archiveEntityInfo;
thing.SetArchiveEntityInfo(archiveEntityInfo);
```

## SetArchiveOrderByInfo(NSArchiveOrderByInfo\[])

```crmscript theme={null}
Void SetArchiveOrderByInfo(NSArchiveOrderByInfo[] archiveOrderByInfo)
```

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

**Example:**

```crmscript theme={null}
NSArchiveConfiguration thing;
NSArchiveOrderByInfo[] archiveOrderByInfo;
thing.SetArchiveOrderByInfo(archiveOrderByInfo);
```

## SetOwnerKeys(String)

```crmscript theme={null}
Void SetOwnerKeys(String ownerKeys)
```

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

**Example:**

```crmscript theme={null}
NSArchiveConfiguration thing;
String ownerKeys;
thing.SetOwnerKeys(ownerKeys);
```


## Related topics

- [NSArchiveAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSArchiveAgent.md)
- [Namespace CRMScript.NetServer](/en/automation/crmscript/reference/CRMScript.NetServer.md)
- [Get Archive Configuration](/en/api/reference/restful/agent/archive_agent/get-archive-configuration.md)
- [Get Archive Configuration With Context](/en/api/reference/restful/agent/archive_agent/get-archive-configuration-with-context.md)
- [Get Archive Configuration V2](/en/api/reference/restful/agent/archive_agent/get-archive-configuration-v2.md)
- [SuperOffice.WebApi.Data.ArchiveConfiguration](/en/api/reference/webapi/SuperOffice.WebApi.Data.ArchiveConfiguration.md)