XOG Services

Read Content Pack Objects

Like standard stock objects, the read ContentPack request service is also defined by the nikuxog_read.xsd schema as shown in the following example. However, for the ContentPack service, this schema is unique because it includes the <ViewQuery> element. This element allows you to read Studio components.

Example XML Read Request

The following example shows the ViewQuery for reading the property and list components of the custom object myObject_v1.

<obj:ReadContentPack xmlns:obj="http://www.niku.com/xog/Object">
  <NikuDataBus xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="../xsd/nikuxog_read.xsd">
      <Header version="12.0.0.5028" externalSource="NIKU"/>
      <ViewQuery>
        <Filter name="code" criteria="EQUALS">property</Filter>
        <Filter name="object_code" criteria="EQUALS">myObject_v1</Filter>
      </ViewQuery>
      <ViewQuery>
        <Filter name="code" criteria="EQUALS">list</Filter>
        <Filter name="object_code" criteria="EQUALS">myObject_v1</Filter>
      </ViewQuery>
  </NikuDataBus>
</obj:ReadContentPack>

More information:

Read Content Pack Objects with Partitioning

You can filter on partition views from a ContentPack read request by including the <ViewQuery> filter condition attribute.

To read specific partitioned views using the ContentPack XOG, you must explicitly request these partitions in a ViewQuery by including the partition_code.

In the file, specify the following:

object_code: Indicates the CA Clarity identifier for the object.
partition_code: Indicates the CA Clarity identifier for the partition. If the partition_code is not specified, views for all partitions are exported.

Example XML Read Request with Partitioning

The following read ContentPack request specifies the ABC partition for the custom object myObject_v1 as shown in bold.

<obj:ReadContentPack xmlns:obj="http://www.niku.com/xog/Object">
  <NikuDataBus xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="../xsd/nikuxog_read.xsd">
      <Header version="12.0.0.5028" externalSource="NIKU">
      <!-- the contentType is used to determine which filter goes where -->
        <args contentType="job_definition" name="order_by_1" value="code"/>
        <args contentType="menu" name="order_by_1" value="code"/>
        <args contentType="view" name="order_by_1" value="code"/>
        <args contentType="process" name="order_by_1" value="code"/>
        <args contentType="object" name="order_by_1" value="code"/>
      </Header>
      <ViewQuery>
        <Filter name="code" criteria="EQUALS">property</Filter>
        <Filter name="object_code" criteria="EQUALS">myObject_v1</Filter>
        <Filter name="partition_code" criteria="EQUALS">ABC</Filter>
      </ViewQuery>
      <ViewQuery>
        <Filter name="code" criteria="EQUALS">list</Filter>
        <Filter name="object_code" criteria="EQUALS">myObject_v1</Filter>
        <Filter name="partition_code" criteria="EQUALS">ABC</Filter>
      </ViewQuery>
      <ObjectQuery>
        <Filter name="object_code" criteria="EQUALS">myObject_v1</Filter>
      </ObjectQuery>
  </NikuDataBus>
</obj:ReadContentPack>

More information:

Export Content Types Without Dependencies

You can use two arguments, singleContentType and no_dependencies, to export individual content types and to limit the amount of data exported for each type. These arguments should be used only for small, incremental updates to content.

Important! Use care when applying these arguments. The user performing the export must have a thorough understanding of content data on the source and target systems.

singleContentType

Exports a specific content type. You must specify the singleContentType argument in the XML read file. The format for the argument in the XML read file is as follows:

where content type can be any of the following supported content types:

Job Definitions
Lookups
Menu Manager
Objects
Portlet Pages
Portlets
Processes
Queries

No_dependencies

Limits the amount of data exported for a specific content type. The format for the argument in the XML read file is as follows:

where true exports incremental changes for a content type without dependencies. By default, the no_dependencies flag is false, which means any dependencies that exist for the value specified in the singleContentType argument are exported if the value is not specified.

The following table shows the content types that are exported when the no_dependencies argument is set to true.

Content Type	Attributes
job_definition	active, executable, isHidden, jobDefinitionCode, jobType, logEnabled, outputEnabled, runConcurrent, source, description, name, attributes related to parameter like code, dataType, defaultValue, order, readOnly, required, widgetType., attributes related to OBSAssocs like completed, Security
lookup	code, hiddenAttributename, sortStype, source, status, description, name, sortorder, attributes related to partition
menu	code, source, description, name, link, section
object	code, source, description, name, displayMapping, parentObjectCode
page [portlet page]	tabbedPage, code, customizable, layout, linkable, objectypes, personalizable, source, space, template, description, name, tab, OBSAssocs, Parameter, dataref, dataSource, paramCode
portlet	allowConfigure, allowConfigureLabel, category, code, colorItem, dataProviderId, dataProvideerPartitionId, dataProviderType, datapointLabels, firstSliceAngle, forceFilter, link, mouseoverLbels, objectType, seriesDimension, showLegend, showTitle, size, source, type, name, decimalPlaces Note: Attributes can vary depending on type of portlet.
process	code, endStep, allowOneRunningInstance, source, startOption, startStep, description, name, rightCode, username, manualStart, objectType, partitionCode, partitionModeCode, type, isMileStone, sequenceNo, attributes related to Notifications, Operations, TransactionRestrictions
query	category, code, description, name, attributes related to nsql like dbId, dbVendor, attributes for link like action, code

Example: XML Read File for Exporting a Portlet Without Dependencies

The following example shows an XML read file where portlet data without any dependency data is requested. The arguments are shown in bold.

  <?xml version="1.0" encoding="UTF-8" ?> 
- <NikuDataBus xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
   xsi:noNamespaceSchemaLocation="../xsd/nikuxog_read.xsd">

- <Header version="12.0.0.5028" action="read" objectType="contentPack" externalSource="NIKU">

<!-- Provide following argument with singlecontenttype to retrieve only portlet. --> 
<args name="singleContentType" value="portlet" /> 
<!-- May specify following OPTIONAL argument no_dependencies to exclude dependent content. --> 
<args name="no_dependencies" value="true" />

  </Header>
- <PortletQuery>

<Filter name="code" criteria="EQUALS">balance</Filter>

  </PortletQuery>
</NikuDataBus>

More information:

To facilitate the export of portlets, you can export this content type from Studio. The Portlets list page has an Export button that lets you export basic data on the portlets as individual XML files. The output XML files, which are packaged into a zip file, contain basic information with no dependencies.

More information: