OpenCube: Operation

The OpenCube operation opens a repository cube and returns context for working with cube's structure.

Comments

The operation enables the user to access the structure and settings of various repository cubes. To execute the operation, in the tOb parameter specify moniker of the object that is a cube, and in the tArg parameter specify parameters of its opening. The object moniker can be obtained on executing the GetObjects operation. In the tArg.metaGet field specify the pattern, according to which cube metadata is extracted on opening. If the tArg.metaGet field is not determined, the operation results only in the opened cube instance moniker.

To further work with the cube, use the GetCube and SetCube operations. Use the CloseCube operation to close the cube instance.

Example

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

</tOb>

<args>

</args>

</tArg>

</OpenCube>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

</id>

</OpenCubeResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "OpenCube" : 
  {
   "tOb" : 
    {
     "id" : "S1!M!5857"
    },
   "tArg" : 
    {
     "args" : 
      {
       "bind" : "true",
       "openForEdit" : "true"
      }
    }
  }
}

JSON response:

{
 "OpenCubeResult" : 
  {
   "id" : 
    {
     "id" : "S1!M!S!C1"
    }
  }
}

The OpenCube function specified below opens a cube. The repository connection moniker and cube 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 OpenCubeResult OpenCube(MbId mb, string id)
    {
        var somClient = new SomPortTypeClient(); //Proxy object for operation execution
        //Operation execution parameters
        var tOpen = new OpenCube()
        {
            tArg = new OpenCubeArg()
            {
                args = new CubeOpenArgs() 
                { 
                    bind = true,
                    openForEdit = true
                }
            },
            tOb = new OdId() { id = mb.id + "!" + FindObjectById(mb, id).k }
        };
        //Open cube
        var tResult = somClient.OpenCube(tOpen);
        return tResult;
    }

OpenCube

Syntax