NSConfigurationAgent - SuperOffice

User interface configuration* XML and other elements such as inter-client URLs.

Constructors

NSConfigurationAgent()

NSConfigurationAgent

Initializes a new instance of the NSConfigurationAgent class.

Methods

ClearConfigurationCache(String,String,Bool)

Configuration XML may be expensive to build and parse, and are therefore cached to the database. Caching is per application/instance/associate, and can be turned off through the config file. If caching is on, and the configuration is changed, it is necessary to clear the cached configurations from the database, through this call.

Void ClearConfigurationCache(String application, String instance, Bool forAllAssociates)

Returns: CRMScript.Global.Void

Changes to the externalapplication table require cache invalidation. SoAdmin will do so automatically.

Example:

NSConfigurationAgent agent;
String application;
String instance;
Bool forAllAssociates;
agent.ClearConfigurationCache(application, instance, forAllAssociates);

CreateDefaultDiaryViewEntity()

Sets default values into a new NSDiaryViewEntity.

NSDiaryViewEntity CreateDefaultDiaryViewEntity()

Returns: CRMScript.NetServer.NSDiaryViewEntity - New entity with default values.

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

Example:

NSConfigurationAgent agent;
NSDiaryViewEntity thing = agent.CreateDefaultDiaryViewEntity();
thing = agent.SaveDiaryViewEntity(thing);

CreateDefaultSystemEventEntity()

Sets default values into a new NSSystemEventEntity.

NSSystemEventEntity CreateDefaultSystemEventEntity()

Returns: CRMScript.NetServer.NSSystemEventEntity - New entity with default values.

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

Example:

NSConfigurationAgent agent;
NSSystemEventEntity thing = agent.CreateDefaultSystemEventEntity();
thing = agent.SaveSystemEventEntity(thing);

DeleteDiaryViewEntity(Integer)

Deletes the NSDiaryViewEntity

Void DeleteDiaryViewEntity(Integer diaryViewEntity)

Returns: CRMScript.Global.Void Example:

NSConfigurationAgent agent;
agent.DeleteDiaryViewEntity(123);

DeleteSystemEventEntity(Integer)

Deletes the NSSystemEventEntity

Void DeleteSystemEventEntity(Integer systemEventEntity)

Returns: CRMScript.Global.Void Example:

NSConfigurationAgent agent;
agent.DeleteSystemEventEntity(123);

DeleteWindowPosSize(Integer)

Deletes a window and dialog position and size setting.

Void DeleteWindowPosSize(Integer windowPosSizeId)

Returns: CRMScript.Global.Void

ExistsSystemEvent(String)

Bool ExistsSystemEvent(String key)

Returns: CRMScript.Global.Bool - Is there a system event with the given key? Example:

NSConfigurationAgent agent;
String key;
Bool res = agent.ExistsSystemEvent(key);

GetAnyConfiguration(String,String,String,String)

Gets one defined configuration fragment, with full reference resolution and parsing applied.

String GetAnyConfiguration(String application, String instance, String item, String type)

Returns: CRMScript.Global.String - A configuration fragment, with full reference resolution and parsing applied.

This is essentially the same service as the GetPageConfiguration, except that this service is not locked to objects of type Page.

Example:

NSConfigurationAgent agent;
String application;
String instance;
String item;
String type;
String res = agent.GetAnyConfiguration(application, instance, item, type);

GetApplicationConfiguration(String,String)

Returns the application configuration.

String GetApplicationConfiguration(String application, String instance)

Returns: CRMScript.Global.String - XML structure containing the application configuration. A list of pages, with information about the name, main panel and preference mappings of each page. Example:

NSConfigurationAgent agent;
String application;
String instance;
String res = agent.GetApplicationConfiguration(application, instance);

GetCRMUrl(String,String,Bool)

Returns a valid URL based in the soprotocol provided

String GetCRMUrl(String soProtocol, String currents, Bool frameless)

Returns: CRMScript.Global.String - URl. Example:

NSConfigurationAgent agent;
String soProtocol;
String currents;
Bool frameless;
String res = agent.GetCRMUrl(soProtocol, currents, frameless);

GetCSAuthUrl(String,String,String,String)

Generates a URL to the emarketing module

String GetCSAuthUrl(String language, String programName, String action, String extraParameters)

Returns: CRMScript.Global.String - A valid Service URL composed of the give parameters. Example:

NSConfigurationAgent agent;
String language;
String programName;
String action;
String extraParameters;
String res = agent.GetCSAuthUrl(language, programName, action, extraParameters);

GetCsCgiUrlInternal()

Gets the host name for Service

String GetCsCgiUrlInternal()

Returns: CRMScript.Global.String - The host name for where Service is installed. Example:

NSConfigurationAgent agent;
String res = agent.GetCsCgiUrlInternal();

GetCsProgramUrl(String,String,String,String)

Converts a module name into a Service URL.

String GetCsProgramUrl(String language, String programName, String action, String extraParameters)

Returns: CRMScript.Global.String - A valid Service URL composed of the give parameters. Example:

NSConfigurationAgent agent;
String language;
String programName;
String action;
String extraParameters;
String res = agent.GetCsProgramUrl(language, programName, action, extraParameters);

GetCSRegistryValue(Integer)

Gets a value from the Registry table.

String GetCSRegistryValue(Integer entry)

Returns: CRMScript.Global.String - The value of the specified Registry entry. Example:

NSConfigurationAgent agent;
Integer entry;
String res = agent.GetCSRegistryValue(entry);

GetCSWwwFolder()

Gets the www folder for Service

String GetCSWwwFolder()

Returns: CRMScript.Global.String - The www folder for Service. Example:

NSConfigurationAgent agent;
String res = agent.GetCSWwwFolder();

GetCustomerUrl()

Gets the URL for the external access to the customer center

String GetCustomerUrl()

Returns: CRMScript.Global.String - The URL to the customer center, without any actions. Example:

NSConfigurationAgent agent;
String res = agent.GetCustomerUrl();

GetDiaryViewEntity(Integer)

Gets an NSDiaryViewEntity object.

NSDiaryViewEntity GetDiaryViewEntity(Integer diaryViewEntityId)

Returns: CRMScript.NetServer.NSDiaryViewEntity Example:

NSConfigurationAgent agent;
NSDiaryViewEntity thing = agent.GetDiaryViewEntity(123);

GetEmailNumberOfDays()

Integer GetEmailNumberOfDays()

Returns: CRMScript.Global.Integer - Number of days in the past for which we are fetching email. Example:

NSConfigurationAgent agent;
Integer res = agent.GetEmailNumberOfDays();

GetEMarketingUrl(String)

String GetEMarketingUrl(String language)

Returns: CRMScript.Global.String - URl.

GetFilterList(String,String)

Gets the list of filters to be used for processing the configuration data for this application.

String GetFilterList(String application, String instance)

Returns: CRMScript.Global.String - XML representing the list of filters and any configuration data they may need. Example:

NSConfigurationAgent agent;
String application;
String instance;
String res = agent.GetFilterList(application, instance);

GetHelpDispatcherUrl()

Gets the GetHelpDispatcherUrl used by the help system.

String GetHelpDispatcherUrl()

Returns: CRMScript.Global.String - URL to be used by the help system. Example:

NSConfigurationAgent agent;
String res = agent.GetHelpDispatcherUrl();

GetMyWindowPosSizes()

Gets the window and dialog position and size settings belonging to the currently logged-on user.

NSWindowPosSize[] GetMyWindowPosSizes()

Returns: CRMScript.NetServer.NSWindowPosSize[] - Array of window and dialog position and size settings. Example:

NSConfigurationAgent agent;
NSWindowPosSize[] res = agent.GetMyWindowPosSizes();

GetObjectMapping(String,String)

Gets the object mappings (what code objects should be instantiated to handle the entities of the client configuration?)

String GetObjectMapping(String application, String instance)

Returns: CRMScript.Global.String - XML containing the object mappings, including assembly and class names. Example:

NSConfigurationAgent agent;
String application;
String instance;
String res = agent.GetObjectMapping(application, instance);

GetPageConfiguration(String,String,String)

Gets the configuration for one whole web page, including all its panels etc.

String GetPageConfiguration(String application, String instance, String page)

Returns: CRMScript.Global.String - XML containing the configuration for the given page, from the page down to the control level.

Totally asynchronous items like menus are not included, but all references are resolved and all special processing is applied.

Example:

NSConfigurationAgent agent;
String application;
String instance;
String page;
String res = agent.GetPageConfiguration(application, instance, page);

GetRefreshedPageConfiguration(String,String,String)

Gets the configuration for one whole web page, including all its panels etc.

String GetRefreshedPageConfiguration(String application, String instance, String page)

Returns: CRMScript.Global.String - XML containing the configuration for the given page, from the page down to the control level.

Totally asynchronous items like menus are not included, but all references are resolved and all special processing is applied. Does not use cache for fetching, but updates the cache with refreshed configuration.

Example:

NSConfigurationAgent agent;
String application;
String instance;
String page;
String res = agent.GetRefreshedPageConfiguration(application, instance, page);

GetSystemEventEntity(Integer)

Gets an NSSystemEventEntity object.

NSSystemEventEntity GetSystemEventEntity(Integer systemEventEntityId)

Returns: CRMScript.NetServer.NSSystemEventEntity Example:

NSConfigurationAgent agent;
NSSystemEventEntity thing = agent.GetSystemEventEntity(123);

GetWindowPosSize(Integer)

Gets an NSWindowPosSize object.

NSWindowPosSize GetWindowPosSize(Integer windowPosSizeId)

Returns: CRMScript.NetServer.NSWindowPosSize Example:

NSConfigurationAgent agent;
NSWindowPosSize thing = agent.GetWindowPosSize(123);

GetWindowPosSizeList(Integer[])

Retrieves a list of NSWindowPosSize objects.

NSWindowPosSize[] GetWindowPosSizeList(Integer[])

Returns: CRMScript.NetServer.NSWindowPosSize[] - Array of window and dialog position and size settings. Example:

Integer[] ids;
NSConfigurationAgent agent;
agent.GetWindowPosSizeList(ids);

GetWindowPosSizesOnAssociateId(Integer)

Gets the window and dialog position and size settings belonging to the specified associate

NSWindowPosSize[] GetWindowPosSizesOnAssociateId(Integer associateId)

Returns: CRMScript.NetServer.NSWindowPosSize[] - Array of window and dialog position and size settings. Example:

NSConfigurationAgent agent;
Integer associateId;
NSWindowPosSize[] res = agent.GetWindowPosSizesOnAssociateId(associateId);

GetWindowPosSizesOnPersonId(Integer)

Gets the window and dialog position and size settings belonging to the specified person

NSWindowPosSize[] GetWindowPosSizesOnPersonId(Integer personId)

Returns: CRMScript.NetServer.NSWindowPosSize[] - Array of window and dialog position and size settings. Example:

NSConfigurationAgent agent;
Integer personId;
NSWindowPosSize[] res = agent.GetWindowPosSizesOnPersonId(personId);

GetWwwUrl(String)

Gets the default URL used for the logo, from the [NetServices] PageUrl preferencec, with tags substituted.

String GetWwwUrl(String client)

Returns: CRMScript.Global.String - URL to be used when clicking the logo. Example:

NSConfigurationAgent agent;
String client;
String res = agent.GetWwwUrl(client);

GetWwwUrlForSMWeb()

Returns the URL used for the logo by the SM.web client. Uses urldispatch.aspx.

String GetWwwUrlForSMWeb()

Returns: CRMScript.Global.String - Link to urldispatch.aspx tagged with [SOSITEURL] Example:

NSConfigurationAgent agent;
String res = agent.GetWwwUrlForSMWeb();

SaveDiaryViewEntity(NSDiaryViewEntity)

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

NSDiaryViewEntity SaveDiaryViewEntity(NSDiaryViewEntity diaryViewEntity)

Returns: CRMScript.NetServer.NSDiaryViewEntity - New or updated DiaryViewEntity. Example:

NSConfiguration agent;
NSDiaryViewEntity thing = agent.CreateDefaultDiaryViewEntity();
thing = agent.SaveDiaryViewEntity(thing);

SaveSystemEventEntity(NSSystemEventEntity)

Updates the existing NSSystemEventEntity or creates a new NSSystemEventEntity if the id parameter is 0

NSSystemEventEntity SaveSystemEventEntity(NSSystemEventEntity systemEventEntity)

Returns: CRMScript.NetServer.NSSystemEventEntity - New or updated SystemEventEntity. Example:

NSConfiguration  agent;
NSSystemEventEntity thing = agent.CreateDefaultSystemEventEntity();
thing = agent.SaveSystemEventEntity(thing);

SaveWindowPosSize(NSWindowPosSize)

Saves a window and dialog position and size setting.

NSWindowPosSize SaveWindowPosSize(NSWindowPosSize windowPosSize)

Returns: CRMScript.NetServer.NSWindowPosSize - The saved item. Example:

NSConfigurationAgent agent;
NSWindowPosSize windowPosSize;
NSWindowPosSize res = agent.SaveWindowPosSize(windowPosSize);

SaveWindowPosSizes(NSWindowPosSize[])

Saves a set of window and dialog position and size settings.

NSWindowPosSize[] SaveWindowPosSizes(NSWindowPosSize[] windowPosSizes)

Returns: CRMScript.NetServer.NSWindowPosSize[] - The saved items. Example:

NSConfigurationAgent agent;
NSWindowPosSize[] windowPosSizes;
NSWindowPosSize[] res = agent.SaveWindowPosSizes(windowPosSizes);

​Constructors

​NSConfigurationAgent()

​Methods

​ClearConfigurationCache(String,String,Bool)

​CreateDefaultDiaryViewEntity()

​CreateDefaultSystemEventEntity()

​DeleteDiaryViewEntity(Integer)

​DeleteSystemEventEntity(Integer)

​DeleteWindowPosSize(Integer)

​ExistsSystemEvent(String)

​GetAnyConfiguration(String,String,String,String)

​GetApplicationConfiguration(String,String)

​GetCRMUrl(String,String,Bool)

​GetCSAuthUrl(String,String,String,String)

​GetCsCgiUrlInternal()

​GetCsProgramUrl(String,String,String,String)

​GetCSRegistryValue(Integer)

​GetCSWwwFolder()

​GetCustomerUrl()

​GetDiaryViewEntity(Integer)

​GetEmailNumberOfDays()

​GetEMarketingUrl(String)

​GetFilterList(String,String)

​GetHelpDispatcherUrl()

​GetMyWindowPosSizes()

​GetObjectMapping(String,String)

​GetPageConfiguration(String,String,String)

​GetRefreshedPageConfiguration(String,String,String)

​GetSystemEventEntity(Integer)

​GetWindowPosSize(Integer)

​GetWindowPosSizeList(Integer[])

​GetWindowPosSizesOnAssociateId(Integer)

​GetWindowPosSizesOnPersonId(Integer)

​GetWwwUrl(String)

​GetWwwUrlForSMWeb()

​SaveDiaryViewEntity(NSDiaryViewEntity)

​SaveSystemEventEntity(NSSystemEventEntity)

​SaveWindowPosSize(NSWindowPosSize)

​SaveWindowPosSizes(NSWindowPosSize[])

Constructors

NSConfigurationAgent()

Methods

ClearConfigurationCache(String,String,Bool)

CreateDefaultDiaryViewEntity()

CreateDefaultSystemEventEntity()

DeleteDiaryViewEntity(Integer)

DeleteSystemEventEntity(Integer)

DeleteWindowPosSize(Integer)

ExistsSystemEvent(String)

GetAnyConfiguration(String,String,String,String)

GetApplicationConfiguration(String,String)

GetCRMUrl(String,String,Bool)

GetCSAuthUrl(String,String,String,String)

GetCsCgiUrlInternal()

GetCsProgramUrl(String,String,String,String)

GetCSRegistryValue(Integer)

GetCSWwwFolder()

GetCustomerUrl()

GetDiaryViewEntity(Integer)

GetEmailNumberOfDays()

GetEMarketingUrl(String)

GetFilterList(String,String)

GetHelpDispatcherUrl()

GetMyWindowPosSizes()

GetObjectMapping(String,String)

GetPageConfiguration(String,String,String)

GetRefreshedPageConfiguration(String,String,String)

GetSystemEventEntity(Integer)

GetWindowPosSize(Integer)

GetWindowPosSizeList(Integer[])

GetWindowPosSizesOnAssociateId(Integer)

GetWindowPosSizesOnPersonId(Integer)

GetWwwUrl(String)

GetWwwUrlForSMWeb()

SaveDiaryViewEntity(NSDiaryViewEntity)

SaveSystemEventEntity(NSSystemEventEntity)

SaveWindowPosSize(NSWindowPosSize)

SaveWindowPosSizes(NSWindowPosSize[])