NSArchiveAgent - SuperOffice

ArchiveList functions of all kinds.

Constructors

NSArchiveAgent()

NSArchiveAgent

ArchiveList functions of all kinds.

Methods

CreateDefaultArchiveListResult()

Sets default values into a new NSArchiveListResult.

NSArchiveListResult CreateDefaultArchiveListResult()

Returns: CRMScript.NetServer.NSArchiveListResult - A new NSArchiveListResult with default values.

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

Example:

NSArchiveAgent agent;
NSArchiveListResult thing = agent.CreateDefaultArchiveListResult();
thing = agent.SaveArchiveListResult(thing);

ExportArchive(String,String,String[],String[],String,String[],Integer)

Exports the target archive to a downloadable format.

NSExportArchiveResult ExportArchive(String providerName, String context, String[] desiredEntities, String[] columns, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restrictions, String exportType, String[] selectedRowIds, Integer estimatedRowCount)

Returns: CRMScript.NetServer.NSExportArchiveResult

GetActivityFilter()

Gets activity filter for the specified list.

NSActivityFilter GetActivityFilter()

Returns: CRMScript.NetServer.NSActivityFilter - The activity filter for the specified list. Example:

NSArchiveAgent agent;
NSActivityFilter res = agent.GetActivityFilter();

GetArchiveConfiguration(String,String)

Gets the configuration for one archive. The configuration is keyed by a combination of archive provider name and gui name.

NSArchiveConfiguration GetArchiveConfiguration(String guiName, String providerName)

Returns: CRMScript.NetServer.NSArchiveConfiguration Example:

NSArchiveAgent agent;
String guiName;
String providerName;
NSArchiveConfiguration res = agent.GetArchiveConfiguration(guiName, providerName);

GetArchiveConfigurationV2(String,String,String,String)

Gets the configuration for one archive. The configuration is keyed by a combination of archive provider name (plus optional context), gui name, and optional table binding.

NSArchiveConfiguration GetArchiveConfigurationV2(String guiName, String providerName, String context, String ownerKeys)

Returns: CRMScript.NetServer.NSArchiveConfiguration Example:

NSArchiveAgent agent;
String guiName;
String providerName;
String context;
String ownerKeys;
NSArchiveConfiguration res = agent.GetArchiveConfigurationV2(guiName, providerName, context, ownerKeys);

GetArchiveConfigurationWithContext(String,String,String)

Gets the configuration for one archive, with context parameter. The configuration is keyed by a combination of archive provider name and gui name.

NSArchiveConfiguration GetArchiveConfigurationWithContext(String guiName, String providerName, String context)

Returns: CRMScript.NetServer.NSArchiveConfiguration Example:

NSArchiveAgent agent;
String guiName;
String providerName;
String context;
NSArchiveConfiguration res = agent.GetArchiveConfigurationWithContext(guiName, providerName, context);

GetArchiveList(String,String,String[],Integer,Integer)

Gets a page of data for an archive.

NSArchiveListItem[] GetArchiveList(String guiName, String providerName, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restriction, String[] entities, Integer page, Integer pageSize)

Returns: CRMScript.NetServer.NSArchiveListItem[] - The columns returned will be those set as chosen columns, using either the SetChosenColumns service or the corresponding SelectableMDOList.SetSelected. Example:

NSArchiveAgent agent;
String guiName;
String providerName;
NSArchiveOrderByInfo[] sortOrder;
NSArchiveRestrictionInfo[] restriction;
String[] entities;
Integer page;
Integer pageSize;
NSArchiveListItem[] res = agent.GetArchiveList(guiName, providerName, sortOrder, restriction, entities, page, pageSize);

GetArchiveList2(String,String,String,String,String,Integer,Integer)

Gets a page of data for an archive using a restriction string.

NSArchiveListItem[] GetArchiveList2(String guiName, String providerName, String sortOrder, String restriction, String entities, Integer page, Integer pageSize)

NSArchiveAgent agent;
String guiName;
String providerName;
String sortOrder;
String restriction;
String entities;
Integer page;
Integer pageSize;
NSArchiveListItem[] res = agent.GetArchiveList2(guiName, providerName, sortOrder, restriction, entities, page, pageSize);

GetArchiveListByColumns(String,String[],String[],Integer,Integer)

Gets a page of results for an archive list, explicitly specifying the restrictions, orderby and chosen columns.

NSArchiveListItem[] GetArchiveListByColumns(String providerName, String[] columns, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restriction, String[] entities, Integer page, Integer pageSize)

Returns: CRMScript.NetServer.NSArchiveListItem[] Example:

NSArchiveAgent agent;
String providerName;
String[] columns;
NSArchiveOrderByInfo[] sortOrder;
NSArchiveRestrictionInfo[] restriction;
String[] entities;
Integer page;
Integer pageSize;
NSArchiveListItem[] res = agent.GetArchiveListByColumns(providerName, columns, sortOrder, restriction, entities, page, pageSize);

GetArchiveListByColumns2(String,String,String,String,String,Integer,Integer)

Gets a page of results for an archive list, explicitly specifying the restrictions as a string, orderby and chosen columns.

NSArchiveListItem[] GetArchiveListByColumns2(String providerName, String columns, String sortOrder, String restrictions, String entities, Integer page, Integer pageSize)

Returns: CRMScript.NetServer.NSArchiveListItem[] Example:

NSArchiveAgent agent;
String providerName;
String columns;
String sortOrder;
String restrictions;
String entities;
Integer page;
Integer pageSize;
NSArchiveListItem[] res = agent.GetArchiveListByColumns2(providerName, columns, sortOrder, restrictions, entities, page, pageSize);

GetArchiveListByColumnsWithContext(String,String[],String[],Integer,Integer,String)

Gets a page of results for an archive list with context parameter, explicitly specifying the restrictions, orderby and chosen columns.

NSArchiveListItem[] GetArchiveListByColumnsWithContext(String providerName, String[] columns, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restriction, String[] entities, Integer page, Integer pageSize, String context)

Returns: CRMScript.NetServer.NSArchiveListItem[] Example:

NSArchiveAgent agent;
String providerName;
String[] columns;
NSArchiveOrderByInfo[] sortOrder;
NSArchiveRestrictionInfo[] restriction;
String[] entities;
Integer page;
Integer pageSize;
String context;
NSArchiveListItem[] res = agent.GetArchiveListByColumnsWithContext(providerName, columns, sortOrder, restriction, entities, page, pageSize, context);

GetArchiveListByColumnsWithContext2(String,String,String,String,String,Integer,Integer,String)

Gets a page of results for an archive list with context parameter, explicitly specifying the restrictions as a string, orderby and chosen columns.

NSArchiveListItem[] GetArchiveListByColumnsWithContext2(String providerName, String columns, String sortOrder, String restriction, String entities, Integer page, Integer pageSize, String context)

Returns: CRMScript.NetServer.NSArchiveListItem[] Example:

NSArchiveAgent agent;
String providerName;
String columns;
String sortOrder;
String restriction;
String entities;
Integer page;
Integer pageSize;
String context;
NSArchiveListItem[] res = agent.GetArchiveListByColumnsWithContext2(providerName, columns, sortOrder, restriction, entities, page, pageSize, context);

GetArchiveListByColumnsWithHeader(String,String[],String[],Integer,Integer,String)

Gets a page of results for an archive list, explicitly specifying the restrictions, orderby and chosen columns; as well as a name/value string formatted set of options. The return value includes a header that has various extra information, in addition to the actual rows.

NSArchiveListResult GetArchiveListByColumnsWithHeader(String providerName, String[] columns, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restriction, String[] entities, Integer page, Integer pageSize, String options)

Returns: CRMScript.NetServer.NSArchiveListResult Example:

NSArchiveAgent agent;
String providerName;
String[] columns;
NSArchiveOrderByInfo[] sortOrder;
NSArchiveRestrictionInfo[] restriction;
String[] entities;
Integer page;
Integer pageSize;
String options;
NSArchiveListResult res = agent.GetArchiveListByColumnsWithHeader(providerName, columns, sortOrder, restriction, entities, page, pageSize, options);

GetArchiveListByColumnsWithHeader2(String,String,String,String,String,Integer,Integer,String)

Gets a page of results for an archive list, explicitly specifying the restrictions as strings, orderby and chosen columns; as well as a name/value string formatted set of options.

NSArchiveListResult GetArchiveListByColumnsWithHeader2(String providerName, String columns, String sortOrder, String restriction, String entities, Integer page, Integer pageSize, String options)

Returns: CRMScript.NetServer.NSArchiveListResult - Includes a header that has various extra information, in addition to the actual rows. Example:

NSArchiveAgent agent;
String providerName;
String columns;
String sortOrder;
String restriction;
String entities;
Integer page;
Integer pageSize;
String options;
NSArchiveListResult res = agent.GetArchiveListByColumnsWithHeader2(providerName, columns, sortOrder, restriction, entities, page, pageSize, options);

GetArchiveListByColumnsWithHeaderWithContext(String,String[],String[],Integer,Integer,String,String)

Gets a page of results for an archive list, with context parameter, explicitly specifying the restrictions, orderby and chosen columns; as well as a name/value string formatted set of options.

NSArchiveListResult GetArchiveListByColumnsWithHeaderWithContext(String providerName, String[] columns, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restriction, String[] entities, Integer page, Integer pageSize, String options, String context)

Returns: CRMScript.NetServer.NSArchiveListResult - Includes a header that has various extra information, in addition to the actual rows. Example:

NSArchiveAgent agent;
String providerName;
String[] columns;
NSArchiveOrderByInfo[] sortOrder;
NSArchiveRestrictionInfo[] restriction;
String[] entities;
Integer page;
Integer pageSize;
String options;
String context;
NSArchiveListResult res = agent.GetArchiveListByColumnsWithHeaderWithContext(providerName, columns, sortOrder, restriction, entities, page, pageSize, options, context);

GetArchiveListByColumnsWithHeaderWithContext2(String,String,String,String,String,Integer,Integer,String,String)

Gets a page of results for an archive list, with context parameter, explicitly specifying the restrictions as strings, orderby and chosen columns; as well as a name/value string formatted set of options.

NSArchiveListResult GetArchiveListByColumnsWithHeaderWithContext2(String providerName, String columns, String sortOrder, String restriction, String entities, Integer page, Integer pageSize, String options, String context)

Returns: CRMScript.NetServer.NSArchiveListResult - Includes a header that has various extra information, in addition to the actual rows. Example:

NSArchiveAgent agent;
String providerName;
String columns;
String sortOrder;
String restriction;
String entities;
Integer page;
Integer pageSize;
String options;
String context;
NSArchiveListResult res = agent.GetArchiveListByColumnsWithHeaderWithContext2(providerName, columns, sortOrder, restriction, entities, page, pageSize, options, context);

GetArchiveListWithContext(String,String,String[],Integer,Integer,String)

Gets a page of data for an archive, with context parameter. The columns returned will be those set as chosen columns, using either the SetChosenColumns service or the corresponding SelectableMDOList.SetSelected.

NSArchiveListItem[] GetArchiveListWithContext(String guiName, String providerName, NSArchiveOrderByInfo[] sortOrder, NSArchiveRestrictionInfo[] restriction, String[] entities, Integer page, Integer pageSize, String context)

Returns: CRMScript.NetServer.NSArchiveListItem[] Example:

NSArchiveAgent agent;
String guiName;
String providerName;
NSArchiveOrderByInfo[] sortOrder;
NSArchiveRestrictionInfo[] restriction;
String[] entities;
Integer page;
Integer pageSize;
String context;
NSArchiveListItem[] res = agent.GetArchiveListWithContext(guiName, providerName, sortOrder, restriction, entities, page, pageSize, context);

GetArchiveListWithContext2(String,String,String,String,String,Integer,Integer,String)

Gets a page of data for an archive using restrictions as strings, with context parameter.

NSArchiveListItem[] GetArchiveListWithContext2(String guiName, String providerName, String sortOrder, String restriction, String entities, Integer page, Integer pageSize, String context)

NSArchiveAgent agent;
String guiName;
String providerName;
String sortOrder;
String restriction;
String entities;
Integer page;
Integer pageSize;
String context;
NSArchiveListItem[] res = agent.GetArchiveListWithContext2(guiName, providerName, sortOrder, restriction, entities, page, pageSize, context);

GetAvailableColumns(String,String)

Returns list of all columns supported by an archive provider. See also <xref href=“CRMScript.NetServer.NSArchiveAgent.GetArchiveConfiguration(String,String)” data-throw-if-not-resolved=“false”></xref>.

NSArchiveColumnInfo[] GetAvailableColumns(String providerName, String context)

Returns: CRMScript.NetServer.NSArchiveColumnInfo[] Example:

NSArchiveAgent agent;
String providerName;
String context;
NSArchiveColumnInfo[] res = agent.GetAvailableColumns(providerName, context);

GetAvailableEntities(String,String)

Returns list of all entities supported by an archive provider. See also <xref href=“CRMScript.NetServer.NSArchiveAgent.GetArchiveConfiguration(String,String)” data-throw-if-not-resolved=“false”></xref>.

NSMDOListItem[] GetAvailableEntities(String providerName, String context)

Returns: CRMScript.NetServer.NSMDOListItem[] Example:

NSArchiveAgent agent;
String providerName;
String context;
NSMDOListItem[] res = agent.GetAvailableEntities(providerName, context);

GetGroupAssociateIds(Integer[])

Returns the associate IDs that belongs to the given groups.

Integer[] GetGroupAssociateIds(Integer[] groupIds)

Returns: CRMScript.Global.Integer[] - The associate IDs. Example:

NSArchiveAgent agent;
Integer[] groupIds;
Integer[] res = agent.GetGroupAssociateIds(groupIds);

GetProviderNames()

Returns list of all archive provider names.

String[] GetProviderNames()

Returns: CRMScript.Global.String[] - Array of all archive provider names. Example:

NSArchiveAgent agent;
String[] res = agent.GetProviderNames();

SetActivityFilter(NSActivityFilter)

Sets activity filter for the specified list.

Void SetActivityFilter(NSActivityFilter activityFilter)

Returns: CRMScript.Global.Void

SetChosenColumns(String,String,String[])

Sets the currently chosen columns for the given gui name/provider name combination.

Void SetChosenColumns(String guiName, String providerName, String[] chosenColumns)

Returns: CRMScript.Global.Void

This service corresponds to the SetSelected method of the SelectableMDOList service, for a list called archiveColumns: plus the archive provider name and gui name as its additionalInfo.

SetChosenColumnsV2(String,String,String,String,String[])

Sets the currently chosen columns for the given gui name/provider name combination.

Void SetChosenColumnsV2(String guiName, String providerName, String context, String ownerKeys, String[] chosenColumns)

Returns: CRMScript.Global.Void

This service corresponds to the SetSelected method of the SelectableMDOList service, for a list called archiveColumns: plus the archive provider name and gui name as its additionalInfo.

SetChosenEntities(String,String,String[])

Sets the currently chosen entities for the given gui name/provider name combination.

Void SetChosenEntities(String guiName, String providerName, String[] entities)

Returns: CRMScript.Global.Void

This service corresponds to the SetSelected method of the SelectableMDOList service, for a list called archiveEntities: plus the archive provider name and gui name as its additionalInfo.

SetChosenEntitiesV2(String,String,String,String,String[])

Sets the currently chosen entities for the given gui name/provider name combination.

Void SetChosenEntitiesV2(String guiName, String providerName, String context, String ownerKeys, String[] entities)

Returns: CRMScript.Global.Void

This service corresponds to the SetSelected method of the SelectableMDOList service, for a list called archiveEntities: plus the archive provider name and gui name as its additionalInfo.

SetColumnWidths(String,String[])

Sets the column widths for the given set of columns and GUI name.

Void SetColumnWidths(String guiName, String[] columnWidths)

Returns: CRMScript.Global.Void

SetColumnWidthsV2(String,String,String,String,String[])

Sets the column widths for the given set of columns and GUI name.

Void SetColumnWidthsV2(String guiName, String providerName, String context, String ownerKeys, String[] columnWidths)

Returns: CRMScript.Global.Void

​Constructors

​NSArchiveAgent()

​Methods

​CreateDefaultArchiveListResult()

​ExportArchive(String,String,String[],String[],String,String[],Integer)

​GetActivityFilter()

​GetArchiveConfiguration(String,String)

​GetArchiveConfigurationV2(String,String,String,String)

​GetArchiveConfigurationWithContext(String,String,String)

​GetArchiveList(String,String,String[],Integer,Integer)

​GetArchiveList2(String,String,String,String,String,Integer,Integer)

​GetArchiveListByColumns(String,String[],String[],Integer,Integer)

​GetArchiveListByColumns2(String,String,String,String,String,Integer,Integer)

​GetArchiveListByColumnsWithContext(String,String[],String[],Integer,Integer,String)

​GetArchiveListByColumnsWithContext2(String,String,String,String,String,Integer,Integer,String)

​GetArchiveListByColumnsWithHeader(String,String[],String[],Integer,Integer,String)

​GetArchiveListByColumnsWithHeader2(String,String,String,String,String,Integer,Integer,String)

​GetArchiveListByColumnsWithHeaderWithContext(String,String[],String[],Integer,Integer,String,String)

​GetArchiveListByColumnsWithHeaderWithContext2(String,String,String,String,String,Integer,Integer,String,String)

​GetArchiveListWithContext(String,String,String[],Integer,Integer,String)

​GetArchiveListWithContext2(String,String,String,String,String,Integer,Integer,String)

​GetAvailableColumns(String,String)

​GetAvailableEntities(String,String)

​GetGroupAssociateIds(Integer[])

​GetProviderNames()

​SetActivityFilter(NSActivityFilter)

​SetChosenColumns(String,String,String[])

​SetChosenColumnsV2(String,String,String,String,String[])

​SetChosenEntities(String,String,String[])

​SetChosenEntitiesV2(String,String,String,String,String[])

​SetColumnWidths(String,String[])

​SetColumnWidthsV2(String,String,String,String,String[])

Constructors

NSArchiveAgent()

Methods

CreateDefaultArchiveListResult()

ExportArchive(String,String,String[],String[],String,String[],Integer)

GetActivityFilter()

GetArchiveConfiguration(String,String)

GetArchiveConfigurationV2(String,String,String,String)

GetArchiveConfigurationWithContext(String,String,String)

GetArchiveList(String,String,String[],Integer,Integer)

GetArchiveList2(String,String,String,String,String,Integer,Integer)

GetArchiveListByColumns(String,String[],String[],Integer,Integer)

GetArchiveListByColumns2(String,String,String,String,String,Integer,Integer)

GetArchiveListByColumnsWithContext(String,String[],String[],Integer,Integer,String)

GetArchiveListByColumnsWithContext2(String,String,String,String,String,Integer,Integer,String)

GetArchiveListByColumnsWithHeader(String,String[],String[],Integer,Integer,String)

GetArchiveListByColumnsWithHeader2(String,String,String,String,String,Integer,Integer,String)

GetArchiveListByColumnsWithHeaderWithContext(String,String[],String[],Integer,Integer,String,String)

GetArchiveListByColumnsWithHeaderWithContext2(String,String,String,String,String,Integer,Integer,String,String)

GetArchiveListWithContext(String,String,String[],Integer,Integer,String)

GetArchiveListWithContext2(String,String,String,String,String,Integer,Integer,String)

GetAvailableColumns(String,String)

GetAvailableEntities(String,String)

GetGroupAssociateIds(Integer[])

GetProviderNames()

SetActivityFilter(NSActivityFilter)

SetChosenColumns(String,String,String[])

SetChosenColumnsV2(String,String,String,String,String[])

SetChosenEntities(String,String,String[])

SetChosenEntitiesV2(String,String,String,String,String[])

SetColumnWidths(String,String[])

SetColumnWidthsV2(String,String,String,String,String[])