Capture Information from Documentum ApplicationXtender in v5.0

Exchanging Information with Business Applications


This page provides information on how to capture documents from Documentum ApplicationXtender (AX). DocuNECT works with the following versions of AX:

v6.5 and v7.0.

Setting Up the Capture

The following screenshot shows an example of how the connection to AX is setup. It is recommended to set the Status After field in the Capture rules to be Indexed as shown below.

AX:\\<AX Datasource Name>\<AX Application Name>

captureAX.png

DocScript Tags

In the lifecycle editor this the configuration needs to be setup in the Capture section. The capture process uses a series of lifecycle tags to identify the different document to export in AX.

Capturing Annotations

By default this is set to false, but the text in annotation notes can be exported with its parent document.

<CaptureAnnotations>true</CaptureAnnotations>

Annotations are captured in an XML document stored in the {ofdocname2} system variable. By default this is captured into location2.

This can be disabled by setting {ofdocname2} = '' in the capture rules.

The XML can be parsed using DocScript in the capture rules.

The XML Format is :

<page>
<number>1</number>
<Annotation>
<number>1</number>
<Text>My Annotation</Text>
<CreateTime>MM/dd/yyyy hh:mm:ss t</CreateTime>
<Creator>username</Creator>
</Annotation>
…….
</page>
……..

To add the text based AX annotation to a DocuNECT comment:

Use the {doccoments} system variable in the capture or index rules. This variable is an array. Add each comment to the document in a different element of the doccomments array.

Single Field Search Options

You can perform a search by using a single index value.

  • AXIndexKeyField – Set to the AX field name that will be searched. If blank will be ignored. Default is blank (“”).
  • AXIndexValues – A list of AXIndexKeyField values that will be used in the search. Each value is on a new line.

Examples:

<AXIndexKeyField>Exported</AXIndexKeyField>
<AXIndexValues>
No
{Null}
</AXIndexValues>

<AXIndexKeyField>LOAN NUMBER</AXIndexKeyField>
<AXIndexValues>
5678234
4367023
8873409
</AXIndexValues>

Multi-Field Search Options

You can use up to 4 search criteria:

  • AXCriteria
  • AXCriteria2
  • AXCriteria3
  • AXCriteria4

The search criteria are OR’ed together and each criteria can contain a search on more than one field. Each line inside a criteria will specify a different Field search. A criteria line can have one of three formats:

FieldName=FieldValue
FieldName=List: ’FieldValue1’,’FieldValue2’,…,’FieldValueN’
FieldName=Expression: ExpressionValue

Examples:

<AXCriteria>
LOAN TYPE=List: 'CAR','YACHT'
YEAR=Expression: <> 2010
</AXCriteria>
<AXCriteria2>
YEAR=Expression: = 2011
</AXCriteria2>

Note: The List and Expression formats are passed directly to the AX SDK. The format is very important and correct case is required. Also there must be a space between “List:” (and “Expression:”) and the value.

Text file search Options

You can use a text file to store search field values for a single index field. Each line in the text file has a single index value.
The AXIndexKeyField tag is used to set the index field to search. The Index File property in the lifecycle editor is used to set the file:

DocScript System Variables

This section details the system variables that can be used for a AX capture.

Saved Query Search Options

You can capture documents from the search results returned from an AX saved query. Use the following tags:

  • AXQueryName - The name of the AXQuery. It can be an exact name or a regular expression.
  • AXResultSetSize - The maximum search result set size. Default is 1000000.

Update An AX Index Value After Document is Exported

This is recommended for large exports as it is helps to identify progress. Using this method, if the process stops for any reason it can simply be restarted and it will continue where it left off.

  • AXIndexKeyField – Set to the AX field name that will change value. If blank will be ignored. Default is blank (“”).
  • AXEndValue – The value AXIndexKeyField will be set to if the document was captured. If blank will be ignored. Default is blank ("").
  • AXErrorValue – The value AXIndexKeyField will be set to if the document was NOT captured. (ie. There was an error). If blank will be ignored. Default is blank (“”).

DocScript Functions

This section details the system variables that can be used for a AX capture.

Function Description
[AX.GetDocByID](axdocid)

Returns an AX document by the AX docid.

Parameter(s)

  • axdocid - The AX docid.
[AX.GetDocValues](axdocid)

Returns AX document values by AX docid.

Parameter(s)

  • axdocid - The AX docid.
[AX.SetLoginInfo](axdatasource, appname, username , password)

Sets the login information for the AX process.

Parameter(s)

  • axdatasource - The AX datasource.
  • appname - The AX application name.
  • username - The AX username.
  • password - The AX password.
[AX.Login](axdatasource, appname, username , password)

Logs in to AX.

Parameter(s)

  • axdatasource - The AX datasource.
  • appname - The AX application name.
  • username - The AX username.
  • password - The AX password.
[AX.Logout]() Logs out of AX.
[AX.GetDocBinFile]()

Returns the BIN file path of the AX docid.
Parameter(s)

  • axdocid - The AX docid.