SetAdHoc: Operation

This operation enables the user to change dashboard structure (set layout, determine block data sources), set up dimension synchronization parameters, determine slide parameters. To execute the operation, in the tAdHocId field specify the dashboard instance moniker, and in the tArg.pattern field specify the pattern, according to which metadata is changed, and in the tArg.meta field specify updated metadata. The moniker can be obtained on executing the OpenAdhoc operation. If the tArg.metaGet field is defined, the operation results in the updated metadata obtained after it has been changed. After changes have been made, use the SaveObject or SaveObjectAs operation to save the dashboard.

Example

The example of changing a dashboard active slide. The request contains identifier of the slide to be made active, and the pattern that indicates whether slide information must be changed. The response contains updated general information about dashboard slides.

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

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

</tAdHocId>

<meta>

<Md8>

<activeSlideId>SD7OZR42LYHXHA2V</activeSlideId>

</Md8>

</meta>

</layout>

</pattern>

<animation>false</animation>

<viewModeImages>false</viewModeImages>

<mainPanel>false</mainPanel>

</allSlidesPattern>

<animation>false</animation>

<viewModeImages>false</viewModeImages>

<mainPanel>false</mainPanel>

</activeSlidePattern>

</layout>

</metaGet>

</tArg>

</SetAdHoc>

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

<Md8>

<its>

<it>

<name>Slide1</name>

</it>

<it>

<id>SD7OZR42LYHXHA2V</id>

<name>Slide2</name>

</it>

</its>

</slides>

</Md8>

</meta>

</SetAdHocResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "SetAdHoc" : 
  {
   "tAdHocId" : 
    {
     "id" : "S1!M!S!AdHoc1"
    },
   "tArg" : 
    {
     "meta" : 
      {
       "Md8" : 
        {
         "activeSlideId" : "SD7OZR42LYHXHA2V"
        }
      },
     "pattern" : 
      {
       "obInst" : "true",
       "layout" : 
        {
         "activeSlideId" : "true",
         "slides" : "Set"
        }
      },
     "metaGet" : 
      {
       "obInst" : "true",
       "layout" : 
        {
         "slides" : "Get",
         "allSlidesPattern" : 
          {
           "animation" : "false",
           "viewModeImages" : "false",
           "mainPanel" : "false"
          },
         "activeSlidePattern" : 
          {
           "animation" : "false",
           "viewModeImages" : "false",
           "mainPanel" : "false"
          }
        }
      }
    }
  }
}

JSON response:

{
 "SetAdHocResult" : 
  {
   "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" : "1",
     "Md8" : 
      {
       "activeSlideKey" : "2",
       "slides" : 
        {
         "its" : 
          {
           "it" : 
            [
              {
               "key" : "1",
               "id" : "1C069D65-46D1-471D-A1ED-DAB36359DE9B",
               "visible" : "1",
               "name" : "Slide1",
               "index" : "0"
              },
              {
               "key" : "2",
               "id" : "SD7OZR42LYHXHA2V",
               "visible" : "1",
               "name" : "Slide2",
               "index" : "1"
              }
            ]
          }
        }
      },
     "autoUpdateSources" : "1",
     "calcOnChangedData" : "2"
    }
  }
}

public static SetAdHocResult SetActiveSlide(AdHocId moniker, AdhocSlides slides)
{
    var somClient = new SomPortTypeClient(); //Proxy object for operation execution
    //Operation execution parameters
    var tSet = new SetAdHoc()
    {
        tArg = new SetAdHocMdArg()
        {
            meta = new AdHocMd()
            {
                Md8 = new AdhocMd8()
                {
                    //Change active slide
                    activeSlideId = slides.its[slides.its.Length-1].id
                }
            },
            pattern = new AdHocMdPattern()
            {
                layout = new SlidesPattern()
                {
                    activeSlideId = true,
                    slides = ListOperation.Set
                }
            },
            metaGet = new AdHocMdPattern()
            {
                layout = new SlidesPattern()
                {
                    activeSlidePattern = new SlideContentPattern(),
                    allSlidesPattern = new SlideContentPattern(),
                    slides = ListOperation.Get
                }
            }
        },
        tAdHocId = moniker
    };
    //Change metadata
    var result = somClient.SetAdHoc(tSet);
    return result;
}

SetAdHoc

Syntax

Parameters

Description

Comments

Example

SOAP request:

SOAP response:

JSON request:

JSON response: