OpenHie: Operation

The OpenHie operation builds a time series hierarchy of the time series database.

Comments

To execute the operation, set the time series database, for which you want to build a factors hierarchy. The database can be specified in two ways: if an opened instance of time series database is available, specify its moniker in the tRub parameter; if there is no opened instance of time series database, specify moniker of corresponding repository object in the tArg.args.rubObj field. The repository object moniker can be obtained on executing the GetObjects operation.

The tArg.metaGet field may also contain a pattern to be used to extract factors metadata, and the tArg.loadXml field may be used to define parameters of factors loading from XML structure.

The operation results in the factors hierarchy moniker, and also the metadata if the tArg.metaGet pattern was defined on executing the operation. Use the GetHieMd and SetHieMd operation for further work. The moniker obtained on opening is also used in the GetHieMembers operation.

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

</tRub>

</metaGet>

</tArg>

</OpenHie>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

</id>

<n>Time Series DB</n>

</obDesc>

</obInst>

<props>

</props>

<asXml>

</asXml>

</meta>

</OpenHieResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "OpenHie" : 
  {
   "tRub" : 
    {
     "id" : "S1!M!S!R1"
    },
   "tArg" : 
    {
     "args" : "",
     "metaGet" : 
      {
       "obInst" : "true",
       "props" : "true",
       "asXml" : "true"
      }
    }
  }
}

JSON response:

{
 "OpenHieResult" : 
  {
   "id" : 
    {
     "id" : "S1!M!S!H2"
    },
   "meta" : 
    {
     "obInst" : 
      {
       "obDesc" : 
        {
         "@isShortcut" : "0",
         "@isLink" : "0",
         "i" : "TS_DB",
         "n" : "Time series database",
         "k" : "1",
         "c" : "2829",
         "p" : "5472",
         "h" : "0"
        }
      },
     "dirty" : "0",
     "props" : 
      {
       "whereIsEmpty" : "0",
       "leafLoadExtent" : "0",
       "filterMode" : "All"
      },
     "asXml" : 
      {
       "data" : "<ITEMS VER="1" SEF="FALSE" EMPTY="0"><ITEM ATTR="4" INA="TRUE" NAMINGS=""><SELECTION NEW="" MULTISELECT="1" ALLOWCEG="TRUE" SELSCHONCE="0" ISA="FALSE"\/><\/ITEM><ITEM ATTR="9" INA="FALSE" NAMINGS=""><SELECTION NEW="" MULTISELECT="1" ALLOWCEG="TRUE" SELSCHONCE="0" ISA="FALSE"\/><\/ITEM><\/ITEMS>"
      }
    }
  }
}

The OpenHierarchy function specified below opens a hierarchy of time series database factors. Specified factors' metadata is also extracted on opening. Database moniker is sent an input parameter. The result of the operation is the result of the function.

    public static OpenHieResult OpenHierarchy(RubId rub)
    {
        var somClient = new SomPortTypeClient(); //Proxy object for operation execution
        //Operation execution parameters
        var tHie = new OpenHie()
        {
            tArg = new OpenHieArg()
            {
                args = new HieOpenArgs(),
                //Metadata that must be extracted on hierarchy open
                metaGet = new HieMdPattern()
                {
                    props = true,
                    asXml = true
                }
            },
            tRub = rub
        };
        //Open factors hierarchy
        var result = somClient.OpenHie(tHie);
        return result;
    }

OpenHie

Syntax