Get Document Information

Operation Name

Function Overview

Gets document information spooled in Report Director Enterprise.

Data Model

XML Type.

Properties

For information about using variables, refer to "variables".

Basic settings

Item name	Required/Optional	Use of variables	Description	Remarks
Name	Required	Not available	Enter the name to show on the script canvas.

Required settings

Item name	Required/Optional	Use of variables	Description	Remarks
Destination	Required	Not available	Select a global resource. For how to set global resource, refer to "Global Resource Properties". [Add]: Adds a new global resource. [Edit list]: Global resource settings can be edited in "Edit resource list".
Getting condition	Required	Not available	Select a condition of the getting document. [All]:(default) [Not printed]: [Printed]: [Trash]:

Target settings (Print available)

Item name	Required/Optional	Use of variables	Description	Remarks
Document status	Required	-	Specify a document status of print available condition to get.
Document status/Get target	Optional	-	Select whether to include each document status to get target. [Checked] Includes in get target. [Not checked] Does not include in get target.	Batch operation is available by clicking the check box displayed in header.
Document status/Status	-	-	Displays document status. [Spool completed] [Print completed] [Print discontinued] [Abnormal condition ended] [Print stopped]

Target settings (Print unavailable)

Item name	Required/Optional	Use of variables	Description	Remarks
Document status	Required	-	Specify a document status of print unavailable condition to get.
Document status/Get target	Optional	-	Select whether to include each document status to get target. [Checked] Includes in get target. [Not checked] Does not include in get target.	Batch operation is available by clicking the check box displayed in header.
Document status/Status	-	-	Displays document status. [Spooling]: [Spool failed]:(default) [Waiting print]: [Printing]: [Discontinuing]: [Creating print data]: [Completed creating print data]: [Preparing]: [Test-printing]: [Waiting printer preparation]: [Waiting paper change]: [Condition unclear]:(default)

Refinement condition settings

Item name	Required/Optional	Use of variables	Description	Remarks
Document name	Optional	Available	Enter document name.	Wild card ("") is available. To Specify the same condition, use [Standard column]* of [Other condition settings].
Spool starting time From	Optional	Available	Enter the range (From) of date and time that document is spooled.	To Specify the same condition, use [Standard column] of [Other condition settings]. For the available format, refer to "Available date format".
Spool starting time To	Optional	Available	Enter the range (To) of date and time that document is spooled.	To Specify the same condition, use [Standard column] of [Other condition settings]. For the available format, refer to "Available date format".

Other condition settings

Item name	Required/Optional	Use of variables	Description	Remarks
Logical operator used for condition combination	Required	Not available	Specify logical operator that integrates the conditions created in [Standard column] or [User definition column]. [AND]:(default) Combines the getting condition with "AND". [OR]: Combines the getting condition with "OR".
Standard column	Required	-	Specify the detailed condition in order to narrow down document information with the standard column. Each condition can be operated with the following buttons. [Add]: Adds a condition. [Up]: Moves the order of the selected condition upwards by one. [Down]: Moves the order of the selected condition downwards by one. [Delete]: Deletes a condition.
Standard column/Column name	Required	Not available	Select a standard column item to set the condition. [Document management number]:(default) [Document name]: [Computer name]: [User name]: [Printer name]: [Printer group name]: [Spool start time]: [Spool end time]: [Print start time]: [Print end time]: [Last updated time]: [Page number]: [Not printed page number]: [Status]: [Format file name]: [Page size]: [Page direction]: [Spelling page number]: [Number of copies]: [Paper code]: [Output file name]:
Standard column/relational operator	Required	Not available	Select the relational operator that combines items selected in [Column name] and values entered in [Value]. [=]:(default) [like]: [!=]: [>]: [<]: [>=]: [<=]:	If any of the following item is selected to [Column name], [Like] operator is available. [Document name] [Computer name] [User name] [Printer name] [Printer group name] [Format file name] [Paper code] [Output file name]
Standard column/Value	Optional	Available	Enter the value that becomes getting condition of item selected in [Column name].	If [like] is selected to [relational operator], underscore "_" (matches with one optional character) and percentage "%" (matches with optional character with more than 0 character) is available. Ex:"_order%" (Matches with "Purchase order", "Order form") For details on the available format, in case the following items are selected to [Column name], refer to "Available date format". [Spool start time] [Spool end time] [Print start time] [Print end time] [Last updated time]
User definition column	Optional	-	Specify the detail condition that narrows down the document information to user definition column. Each condition can be operated with the following button. [Add]: Adds a condition. [Up]: Moves the order of the selected condition upwards by one. [Down]: Moves the order of the selected condition downwards by one. [Delete]: Deletes a condition.
User definition column/Column name	Required	Available	Select or enter the user definition column item to set condition.
User definition column/relational operator	Required	Not available	Select the relational operator that combines items selected or entered in [Column name] and values entered in [Value]. [=]:(default) [like]: [!=]: [>]: [<]: [>=]: [<=]:
User definition column/Value	Optional	Available	Enter the value that becomes getting condition of item selected in [Column name].	If [like] is selected to [relational operator], underscore "_" (matches with one optional character) and percentage "%" (matches with optional character with more than 0 character) will be available. Ex:"_order%" (Matches with "Purchase order", "Order form")

Property action

Item name	Description	Remarks
Update user definition column list	To select in [User definition column/Column name], get the user definition column registered to Report Director Enterprise server specified in [Destination].	List of the user definition column shown in [User definition column] of [Sort setting] tab will be simultaneously updated.

Sort setting

Item name	Required/Optional	Use of variables	Description	Remarks
Column category	Required	Not available	Select the type of item to sort. [Select from standard column]:(default) Select standard column item from the list. [Select from user definition column]: Select user definition column item from the list.
Standard column	Required	Not available	Select the standard column item to sort. [Document management number]:(default) [Document name]: [Computer name]: [User name]: [Printer name]: [Printer group name]: [Spool start time]: [Spool end time]: [Print start time]: [Print end time]: [Last updated time]: [Page number]: [Not printed page number]: [Status]: [Format file name]: [Page size]: [Page direction]: [Spelling page number]: [Number of copies]: [Paper code]: [Output file name]:	Displayed, if [Select from standard column] is selected in [Column category].
User definition column	Required	Available	Select or enter the user definition column item to sort.	Displayed, if [Select from user definition column] is selected in [Column category].
Sorting order	Required	Not available	Select the sorting order. [Ascending sort]:(default) Sorts by ascending. [Descending sort]: Sorts by descending.

Property action

Item name	Description	Remarks
Update user definition column list	To select in [User definition column/Column name], get the user definition column registered to Report Director Enterprise server specified in [Destination].	User definition column list showed in [User definition column/Column name] of [Other condition settings] tab will be simultaneously updated.

Comment

Item name	Required/Optional	Use of variables	Description	Remarks
Comment	Optional	Not available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input Schema

None.

Output Schema

<?xml version="1.0" encoding="UTF-8" ?>
<documents>
  <document>
    <canAbort>whether stop is available</canAbort>
    <canChangePrinter>whether changing print destination is available</canChangePrinter>
    <canDelete>whether deleting is available</canDelete>
    <canCopy>whether copy is available</canCopy>
    <canFilePrint>whether printing file is available.</canFilePrint>
    <canMoveToTrash>whether transferring to trash is available.</canMoveToTrash>
    <canPrint>whether printing is available</canPrint>
    <canRestart>whether restarting is available</canRestart>
    <canRestore>whether undo is available</canRestore>
    <canStop>whether stopping is available</canStop>
    <canView>whether viewing is available</canView>
    <computerName>computer name</computerName>
    <docName>document name</docName>
    <docNum>document management number</docNum>
    <formCopyCount>number of copies specified in format file</formCopyCount>
    <formFileName>format file name</formFileName>
    <formPaperCode>paper code specified to format file</formPaperCode>
    <formPaperOrientation>page direction specified to format file</formPaperOrientation>
    <formPaperOrientationName>page direction name specified to format file</formPaperOrientationName>
    <formPaperSize>page size specified to format file</formPaperSize>
    <formPaperSizeName>page size name specified to format file</formPaperSizeName>
    <formPrintCount>spelling page number</formPrintCount>
    <outputFileName>file type output file name such as PDF</outputFileName>
    <pageCount>page number</pageCount>
    <paperChangeMessage>paper change message</paperChangeMessage>
    <printed>whether printed document</printed>
    <printedPageCount>printed page number</printedPageCount>
    <printerName>printer name</printerName>
    <spoolStartTime>spool start time</spoolStartTime>
    <spoolEndTime>spool. end time</spoolEndTime>
    <printStartTime>print start time</printStartTime>
    <printEndTime>print end time</printEndTime>
    <enablePrinterKinds>
      <enablePrinterKind>print available PDL</enablePrinterKind>
         :
    </enablePrinterKinds>
    <spoolPageCount>spool page number</spoolPageCount>
    <status>status</status>
    <statusString>status name</statusString>
    <stopping>whether stopping</stopping>
    <trash>whether trash document</trash>
    <unprintedPageCount>not printed page number</unprintedPageCount>
    <updateTime>last updated time</updateTime>
    <userColumns>
      <userColumn>
        <name>user definition column name</name>
        <value>user definition column value</value>
      </userColumn>
         :
    </userColumns>
    <userName>user name</userName>
    <canSpecifyPageRange>restriction of specifying page range when printing</canSpecifyPageRange>
    <srcDocNum>document management number of copied source</srcDocNum>
    <printerGroupName>printer group name</printerGroupName>
  </document>
</documents>

Element name	Attribute name	Description	Remarks
documents	-	Element showing document information list.
document	-	Element showing document information.
canAbort	-	Element showing whether discontinuing is available.
canChangePrinter	-	Element showing whether editing print destination is available.
canDelete	-	Element showing whether deleting is available.
canCopy	-	Element showing whether copying is available.	Outputs empty character, if Report Director Enterprise 8.2 server is selected in [Destination].
canFilePrint	-	Element showing whether printing file is available.
canMoveToTrash	-	Element showing whether transition to trash is available.
canPrint	-	Element showing whether printing is available.
canRestart	-	Element showing whether restarting is available.
canRestore	-	Element showing whether undoing is available.
canStop	-	Element showing whether stopping is available.
canView	-	Element showing whether viewing is available.
computerName	-	Element showing computer name.
docName	-	Element showing document name.
docNum	-	Element showing document number.
formCopyCount	-	Element showing numbers specified to format file.
formFileName	-	Element showing format file name.
formPaperCode	-	Element showing paper codes specified to format file.
formPaperOrientation	-	Element showing paper orientation specified to format file.
formPaperOrientationName	-	Element showing paper orientation name specified to format file.
formPaperSize	-	Element showing paper size specified to format file.
formPaperSizeName	-	Element showing paper size name specified to format file.
formPrintCount	-	Element showing spelling page numbers.
outputFileName	-	Element showing file name of file type output such as PDF.
pageCount	-	Element showing page number.
paperChangeMessage	-	Element showing paper change message.
printed	-	Element showing whether the document is printed or not.
printedPageCount	-	Element showing printed page number.
printerName	-	Element showing printer name.
spoolStartTime	-	Element showing spool start time.	Outputs as the date format set to DataSpider. For details on date format, refer to "Data format".
spoolEndTime	-	Element showing spool end time.	Outputs as the date format set to DataSpider. For details on date format, refer to "Data format".
printStartTime	-	Element showing print start time.	Outputs as the date format set to DataSpider. For details on date format, refer to "Data format".
printEndTime	-	Element showing print end time.	Outputs as the date format set to DataSpider. For details on date format, refer to "Data format".
enablePrinterKinds	-	Element showing print available PDL list.	Becomes empty, if Report Director Enterprise 8.2 server is selected in [Destination].
enablePrinterKind	-	Element showing print available PDL.	Does not output, if Report Director Enterprise 8.2 server is selected in [Destination].
spoolPageCount	-	Element showing spool page number.
status	-	Element showing status.
statusString	-	Element showing status name.
stopping	-	Element showing whether stopping or not.
trash	-	Element showing whether trash document or not.
unprintedPageCount	-	Element showing not printed page number.
updateTime	-	Element showing last updated time.	Outputs as the date format set to DataSpider. For details on date format, refer to "Data format".
userColumns	-	Element showing user definition column list.
userColumn	-	Element showing user definition column.
name	-	Element showing user definition column name.
value	-	Element showing user definition column value.
userName	-	Element showing user name.
canSpecifyPageRange	-	Element showing restriction of specifying page range when printing.
srcDocNum	-	Element showing document management number of copied source.	Outputs empty character, if Report Director Enterprise 8.2 server is selected in [Destination]. If not copied document, -1 is stored.
printerGroupName	-	Element showing printer group name.	Outputs empty character, if Report Director Enterprise 8.2 server is selected in [Destination].

Loading Schema on Mapper

Schema is loaded automatically.

For more details, refer to "Edit schema".

Mass Data Processing

Mass data processing is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
count	Stores the number of received data.	Default value is null.
message_category	Stores the category of message code corresponding to the occured error.	Default value is null.
message_code	Stores the code of message code corresponding to the occured error.	Default value is null.
message_level	Stores the severity of message code corresponding to the occured error.	Default value is null.
error_type	Returns the error type when error occurred.	Default value is null. Error is represented in the format depicted below. Ex: java.io.FileNotFoundException The message may vary depending on the DataSpider Servista version.
error_message	Returns the error message when error occurred.	Default value is null. The message may vary depending on the DataSpider Servista version.
error_trace	Returns the trace information when error occurred.	Default value is null. The message may vary depending on the DataSpider Servista version or the client application used.

About RDE UDK Log

RDE UDK log used in Report Director Enterprise adapter will be output as the name rde.log under $DATASPIDER_HOME/server/logs.
New log file is generated if RDE UDK log exceeds 2048KB, and 5 old files will be saved.

Available Date Format

Input value of each item that inputs date format data is required to follow any of the date format below.

Item to input date format data

[Spool start time From]
[Spool start time To]
[Standard column/Value] in case any of the following item is selected to [Standard column/Column name].
- [Spool start time]
- [Spool end time]
- [Print start time]
- [Print end time]
- [Last updated time]

Date format

Date format	Input example	Remarks
yyyy-MM-dd'T'HH:mm:ss.SSSZZ	2015-01-23T12:34:56.789+0900
yyyy/MM/dd HH:mm:ss.SSS	2015/01/23 12:34:56.789
yyyy/MM/dd HH:mm:ss	2015/01/23 12:34:56	Treat millisecond as ".000".
yyyy/MM/dd	2015/01/23	Treat time/minute/second/millisecond as "00:00:00.000".
yyyy-MM-dd HH:mm:ss.SSS	2015-01-23 12:34:56.789
yyyy-MM-dd HH:mm:ss	2015-01-23 12:34:56	Treat millisecond as ".000".
yyyy-MM-dd	2015-01-23	Treat time/minute/second/millisecond as "00:00:00.000".
MM/dd/yyyy HH:mm:ss.SSS	01/23/2015 12:34:56.789
MM/dd/yyyy HH:mm:ss	01/23/2015 12:34:56	Treat millisecond as ".000".
MM/dd/yyyy	01/23/2015	Treat time/minute/second/millisecond as "00:00:00.000".
MM-dd-yyyy HH:mm:ss.SSS	01-23-2015 12:34:56.789
MM-dd-yyyy HH:mm:ss	01-23-2015 12:34:56	Treat millisecond as ".000".
MM-dd-yyyy	01-23-2015	Treat time/minute/second/millisecond as "00:00:00.000".

Main Exceptions

Exception name	Cause	Solution
ResourceNotFoundException Resource definition could not be found.Name:[]	[Destination] is not specified.	Specify [Destination].
ResourceNotFoundException Resource definition could not be found. Name:[<Global resource name>]	Resource definition selected in [Destination] is not found.	Confirm the global resource specified in [Destination].
InvalidPropertyConfigurationException Resource required item is not set.:<Property name>	Resource required item selected in [Destination]is not set.	Set resource required item.
RdConnectException Failed to connect database.	Failed to connect to database used in Report Director Enterprise.	Setup in order to enable database connection by performing such as restart of database used in Report Director Enterprise, or changing maximum connection.