Get Server Printer Information

Operation Name

Function Overview

Gets server printer information registered 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".

Target settings (Normal)

Item name	Required/Optional	Use of variables	Description	Remarks
Printer status	Required	-	Specify printer status with normal condition to make as getting target.
Printer status/Get target	Optional	-	Select whether to include each printer status to getting target. [Checked]: Includes in get target. [Not checked]:(default) Does not include in get target.	Batch operation is available by clicking the check box displayed in header.
Printer status/Status	-	-	Displays printer status. [Idle] [Saving electricity] [Paper nearly empty] [Toner near empty] [Warming up]

Target settings (Abnormal)

Item name	Required/Optional	Use of variables	Description	Remarks
Printer status	Required	-	Specify printer status with abnormal condition to make as getting target.
Printer status/Get target	Optional	-	Select whether to include each printer status to getting target. [Checked]:(default) Includes in get target. [Not checked]: Does not include in get target.	Batch operation is available by clicking the check box displayed in header.
Printer status/Status	-	-	Displays printer status. [Off-line] [No paper] [Jam] [No toner] [Busy] [Cover option] [Service call] [PA down] [Unclear]

Target settings (Unclear)

Item name	Required/Optional	Use of variables	Description	Remarks
Printer status	Required	-	Specify printer status with unclear condition to make as getting target.
Printer status/Get target	Optional	-	Select whether to include each printer status to getting target. [Checked]: Includes in get target. [Not checked]:(default) Does not include in get target.	Batch operation is available by clicking the check box displayed in header.
Printer status/Status	-	-	Displays printer status. [No watch]

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" ?>
<serverPrinters>
  <serverPrinter>
    <name>printer name</name>
    <canGetStatus>whether getting status is available manually</canGetStatus>
    <comment>comment</comment>
    <language>language</language>
    <parallelJobCount>parallel processing number (document number)</parallelJobCount>
    <portName>port</portName>
    <printerKind>printer type name</printerKind>
    <pdl>PDL</pdl>
    <serverName>RD sever name</serverName>
    <realServerName>real server name</realServerName>
    <spoolDirectory>output directory</spoolDirectory>
    <spoolMethod>output category</spoolMethod>
    <spoolMethodName>output category name</spoolMethodName>
    <status>status</status>
    <statusName>status character string</statusName>
    <statusInterval>status watching interval (second)</statusInterval>
    <statusProtocol>status getting protocol</statusProtocol>
    <stopping>whether stopping</stopping>
    <properties>
      <property>
        <name>server printer setting item name</name>
        <value>server printer setting item value</value>
      </property>
         :
    </properties>
    <protocol>print protocol</protocol>
  </serverPrinter>
     :
</serverPrinters>

Element name	Attribute name	Description	Remarks
serverPrinters	-	Element showing server printer information list.
serverPrinter	-	Element showing server printer information.
name	-	Element showing printer name.
canGetStatus	-	Element showing whether getting status is available manually.
comment	-	Element showing comment.
language	-	Element showing language.
parallelJobCount	-	Element showing parallel processing number (document number).
portName	-	Element showing port.
printerKind	-	Element showing printer type name.
pdl	-	Element showing PDL.	Outputs empty character, if Report Director Enterprise 8.2 server is selected in [Destination].
serverName	-	Element showing RD sever name.
realServerName	-	Element showing real sever name.	Outputs empty character, if Report Director Enterprise 8.2 server is selected in [Destination].
spoolDirectory	-	Element showing output directory
spoolMethod	-	Element showing output category.
spoolMethodName	-	Element showing output category name.
status	-	Element showing status.
statusName	-	Element showing status character string.
statusInterval	-	Element showing status watching interval (second).
statusProtocol	-	Element showing status getting protocol.
stopping	-	Element showing whether stopping or not.
properties	-	Element showing server printer setting item list.
property	-	Element showing server printer setting item.
name	-	Element showing server printer setting item name.
value	-	Element showing server printer setting item value.
protocol	-	Element showing print protocol.

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.

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.