OpenDashboard

Syntax

DashboardMetaResult Operation(OdId tObject, OpenDashboardMetaArg tArg)

Parameters

tObject. Moniker of repository object that is information panel.

tArg. Operation execution parameters.

Description

The OpenDashboard operation opens information panel.

Comments

To execute the operation, in the tObject field specify moniker of the object that is information panel, and in the tArg field specify opening parameters. In the tArg.args field specify information panel opening mode. In the tArg.meta field specify empty values or default values for the fields with metadata, which values should be obtained. The operation results in the moniker of opened information panel instance and obtained metadata if corresponding fields were defined.

Further work with information panel is executed using the GetDashboardMeta, SetDashboardMeta operations and other specific operations used for executing specific actions. To close the opened information panel instance, use the CloseDashboard operation.

Example

Below is the example of opening information panel instance for edit. The request contains moniker of the repository object that is information panel. The response contains moniker of opened information panel instance. Any additional metadata is not obtained.

The C# example uses the FindObjectById function, which code is given in the Getting Object Description by Its Identifier article.

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">
<OpenDashboard xmlns="http://www.fsight.ru/PP.SOM.Som">
<tObject xmlns="">
  <id>NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!358093</id>
  </tObject>
<tArg xmlns="">
<args>
  <openForEdit>true</openForEdit>
  </args>
  </tArg>
  </OpenDashboard>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<OpenDashboardResult 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">
<id xmlns="">
  <id>NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI</id>
  </id>
  </OpenDashboardResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "OpenDashboard" : 
  {
   "tObject" : 
    {
     "id" : "NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!358093"
    },
   "tArg" : 
    {
     "args" : 
      {
       "openForEdit" : "true"
      }
    }
  }
}

JSON response:

{
 "OpenDashboardResult" : 
  {
   "id" : 
    {
     "id" : "NGDHDGCPEHADGOAENOBLDBIDDCDEGILEPLMLPCIIGMNMBLKH!M!S!PLHPAOLCPEHADGOAEAHKONCEDOLHDDIAEGIKMEIJNDDGMDEOI"
    }
  }
}
public static DashboardMetaResult OpenDashboard(MbId mb, string dashboardId)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tOpen = new OpenDashboard()
    {
        tArg = new OpenDashboardMetaArg()
        {
            args = new DashboardMetaOpenArgs()
            {
                openForEdit = true
            }
        },
        // Create object moniker
        tObject = new OdId() { id = mb.id + "!" + FindObjectById(mb, dashboardId).k }
    };
    // Open information panel
    var result = somClient.OpenDashboard(tOpen);
    return result;
}

See also:

Working with Information Panel