OpenAdHoc: Operation

The OpenAdHoc operation opens a dashboard and returns the context to work with dashboard contents.

Comments

The operation enables the user to access dashboard data and metadata. To execute the operation, in the tObject field specify dashboard moniker, and in the tOpenArg field specify opening parameters. The moniker can be obtained on executing the GetObjects operation. The tOpenArg opening parameters enable the user to determine the opening mode (tOpenArg.openForEdit), the template to get data and metadata (tOpenArg.getMd), and also send values of the parameters that will be used to open parametric objects used in the dashboard. The operation results in the moniker of opened dashboard instance and metadata if the tOpenArg.GetMd field is determined. Use the GetAdHoc, SetAdHoc operations to further work with the dashboard. Use the CloseAdHoc operation to close the opened dashboard instance and check in resources.

Example

The example of opening a dashboard for edit. The request contains a dashboard moniker and a common metadata extraction pattern. The response contains the opened dashboard instance moniker and the requested metadata.

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">

</tObject>

<getMd>

</getMd>

</tOpenArg>

</OpenAdHoc>

</s:Body>

</s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

<id>S1!M!S!AdHoc1</id>

</id>

<i>ADHOC_SAMPLE</i>

<n>Dashboard</n>

</obDesc>

</obInst>

<Md>

</prop>

</prop>

</prop>

</block>

</kap>

</Md>

</meta>

</OpenAdHocResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "OpenAdHoc" : 
  {
   "tObject" : 
    {
     "id" : "S1!M!87502"
    },
   "tOpenArg" : 
    {
     "openForEdit" : "true",
     "getMd" : 
      {
       "obInst" : "true",
       "md" : "true"
      }
    }
  }
}

JSON response:

{
 "OpenAdHocResult" : 
  {
   "id" : 
    {
     "id" : "S1!M!S!AdHoc1"
    },
   "meta" : 
    {
     "obInst" : 
      {
       "obDesc" : 
        {
         "@fullUrl" : "\/",
         "@isShortcut" : "0",
         "@isLink" : "0",
         "@ver" : "1",
         "@hf" : "0",
         "i" : "ADHOC_SAMPLE",
         "n" : "Dashboard",
         "k" : "87502",
         "c" : "8448",
         "p" : "6714",
         "h" : "0",
         "hasPrv" : "0",
         "ic" : "0",
         "isPermanent" : "1",
         "isTemp" : "0"
        }
      },
     "dirty" : "0",
     "Md" : 
      {
       "kap" : 
        {
         "@version" : "8.0",
         "block" : 
          {
           "@type" : "Dashboard",
           "@key" : "SVXNUNJURC6H2FA9",
           "prop" : 
            [
              {
               "@val" : "Dashboard",
               "@isArrFlg" : "1",
               "@tag" : "name"
              },
              {
               "@tag" : "background",
               "prop" : 
                [
                  {
                   "@val" : "#ffffff",
                   "@isArrFlg" : "1",
                   "@tag" : "backgroundColor"
                  },
                  {
                   "@val" : "#c9c9c9",
                   "@tag" : "gradientColor"
                  },
                  {
                   "@val" : "270",
                   "@tag" : "gradientAngle"
                  }
                ]
              },
              {
               "@tag" : "decor",
               "prop" : 
                {
                 "@tag" : "paddings",
                 "prop" : 
                  [
                    {
                     "@val" : "1",
                     "@isArrFlg" : "1",
                     "@tag" : "usePaddings"
                    },
                    {
                     "@val" : "10",
                     "@tag" : "left"
                    },
                    {
                     "@val" : "10",
                     "@tag" : "right"
                    },
                    {
                     "@val" : "10",
                     "@tag" : "top"
                    },
                    {
                     "@val" : "10",
                     "@tag" : "bottom"
                    }
                  ]
                }
              },
              {
               "@val" : "1",
               "@tag" : "autoLayout"
              },
              {
               "@tag" : "pageLayout",
               "prop" : 
                {
                 "@val" : "stretch",
                 "@tag" : "sizeMode"
                }
              }
            ]
          }
        }
      },
     "autoUpdateSources" : "1",
     "calcOnChangedData" : "2"
    }
  }
}

The OpenAdhoc function specified below opens a dashboard. The repository connection moniker and dashboard identifier are sent as input parameters. The example uses the FindObjectById function, which code is given in the Getting Object Description by Its Identifier example. The result of the operation is the result of the function.

public static OpenAdHocResult OpenAdhoc(MbId mb, string adhocId)
{
    var somClient = new SomPortTypeClient(); //Proxy object for operation execution
    //Operation execution parameters
    var tOpen = new OpenAdHoc()
    {
        tOpenArg = new AdHocOpenArg()
        {
            openForEdit = true,
            getMd = new AdHocMdPattern()
            {
                md = true
            }
        },
        //Generate object moniker
        tObject = new OdId() { id = mb.id + "!" + FindObjectById(mb, adhocId).k }
    };
    //Open dashboard
    var result = somClient.OpenAdHoc(tOpen);
    return result;
}

OpenAdHoc

Syntax

Parameters

Description

Comments

Example

SOAP request:

SOAP response:

JSON request:

JSON response: