SetUpdateSettings

Syntax

bool SetUpdateSettings(string mon, ViewerUpdateSettings tArg)

Parameters

mon. Moniker.

tArg. Operation execution parameters.

Description

The SetUpdateSettings operation changes parameters of regular report automatic update.

Comments

To execute the operation, in the mon field specify moniker of regular report instance with the !Options!UpdateSettings postfix. In the tArg field set automatic update parameters to be changed. The moniker can be obtained on executing the OpenPrxMeta operation.

The operation results in the logical True if parameters were changed successfully.

Example

Below is the example of changing regular report automatic update parameters. The request contains moniker to work with automatic update parameters and new parameters values. The response contains whether changes are applied successfully.

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SetUpdateSettings xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">S1!M!S!P1!Options!UpdateSettings</mon>
<tArg xmlns="">
  <updateByIntervalEnabled>true</updateByIntervalEnabled>
  <autoUpdateByData>true</autoUpdateByData>
  <AutoUpdateInterval>5</AutoUpdateInterval>
  <autoUpdateIntervalUnits>Seconds</autoUpdateIntervalUnits>
  </tArg>
  </SetUpdateSettings>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
  <SetUpdateSettingsResult xmlns="http://www.fsight.ru/PP.SOM.Som" xmlns:q1="http://www.fsight.ru/PP.SOM.Som" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1</SetUpdateSettingsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"SetUpdateSettings" :
{
"mon" : "S1!M!S!P1!Options!UpdateSettings",
"tArg" :
{
"updateByIntervalEnabled" : "true",
"autoUpdateByData" : "true",
"AutoUpdateInterval" : "5",
"autoUpdateIntervalUnits" : "Seconds"
}
}
}

JSON response:

{
"SetUpdateSettingsResult" : "1"
}
public static bool SetUpdateSettings(string moniker)
{
var somClient = new SomPortTypeClient(); //Proxy object for operation execution
//Operation execution parameters
var tSet = new SetUpdateSettings()
{
tArg = new ViewerUpdateSettings()
{
updateByIntervalEnabled = true,
autoUpdateByData = true,
AutoUpdateInterval = 5,
autoUpdateIntervalUnits = TimeUnits.Seconds
},
mon = moniker + "!Options!UpdateSettings"
};
//Change parameters of regular report automatic update
var result = somClient.SetUpdateSettings(tSet);
return result;
}

See also:

Working with Regular Reports