dump

Home > Books > NetKernel API and Services Reference > Accessor Listing > Utility and System Accessors > dump

Module

The dump accessor is exported by the urn:org:ten60:netkernel:ext:sys module. Import this module to gain access to the accessor.

Syntax

URI

active:dump

Argument	Rules	Description
operand	Mandatory	the resource to be serialized
operator	Optional	a document specifying properties for the dump

Example Usage

DPML

<instr>
  <type>dump</type>
  <operand>var:result</operand>
  <operator>
    <path>/xtmp/log/xunit</path>
    <extension>xml</extension>
  </operator>
  <target>this:response</target>
</instr>

NetKernel Foundation API

req=context.createSubRequest("active:dump");
req.addArgument("operand", [resource representation, aspect, or URI] );
result=context.issueSubRequest(req);

Purpose

The dump accessor serializes the operand document to a uniquely named file located in a target directory specified in the operator properties document. The result is a document with a root element <filename> containing the full path filename of the dumped operand document.

Operator Syntax

The dump accessor may be passed a path property in order to choose a unique location to dump a document. It is passed in by the operator in a <path> element.

The dump accessor may be passed an extension property to determine the file extension of the saved file. It is passed in by the operator in a <extension> element.

<target>
  <dir>/xvar/log/xunit</dir>
  <extension>xml</extension>
</target>

<path> contains the directory path relative to the root scratch directory for ext-sys into which the xml documents will be dumped. If omitted the path will default to /xtmp/log.