Output Report (From File)

Operation Name

Output Report (From File)

Function Overview

Outputs report based on the data file contents.
This operation cannot be used in Universal Connect/X 9.0 adapter.

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 more details on Global Resource settings, refer to "Global Resource Properties".
  • [Add]:
    Adds a new global resource.
  • [Edit list]:
    Enables to edit the global resource settings in the "Edit resource list".
 
JOB ID Required Available Input JOB ID set in Universal Connect/X server.  
Data file Required Available Input data file path to send Universal Connect/X server.

By clicking [Browse] button, file chooser launches and enables to select file.
Data file format Required Not available Select a data file format of file specified in [Data file].
  • [CSV format]:(default)
    Sends data file as CSV format.
  • [XML format]:
    Sends data file as XML format.
  • If [CSV format] is selected, [Data file encode] will be required.
  • If [XML format] is selected, [Data file encode] will be invalid.
Property action
Item name Description Remarks
Preview Launch previewer and display the file contents specified in [Data file].
  • Disabled, if the specified file does not exist, or variable is set to [Data file].
  • Displayed with the encode specified in [Encode].
  • Editing file contents are not available.
  • Maximum file size that previewer can show is 1MB. If the file size exceeds 1MB, contents up to 1MB will be shown from the beginning of the file.
Data file settings
Item name Required/Optional Use of variables Description Remarks
Data file encode Required Available Select or input [Data file] encode.
  • [Windows-31J]:
  • [Shift_JIS]:
  • [ISO-2022-JP]:
  • [EUC-JP]:
  • [US-ASCII]:
  • [ISO-8859-1]:
  • [UTF-8]:(default)
  • [UTF-16BE]:
  • [UTF-16LE]:
  • [UTF-16]:
 
Remain data file upon successful completion Optional Not available Select whether to delete file specified in [Data file] upon successful completion of report output operation.
  • [Checked]:
    Dose no delete data file.
  • [Not checked]:(default)
    Deletes data file.
 
Remain data file upon unsuccessful completion Optional Not available Select whether to delete file specified in [Data file] upon unsuccessful completion of report output operation.
  • [Checked]:
    Dose no delete data file.
  • [Not checked]:(default)
    Deletes data file.
  • If [Remain data file upon successful completion] is checked, becomes disabled and checked.
Compress data file Optional Not available Select whether to compress data file upon sending data file to Universal Connect/X server.  
File compression format Optional Not available Select the data file compression format upon sending data file to Universal Connect/X server.
  • [GZIP]:(default)
    Compresses data file in GZIP format.
  • [ZLIB]:
    Compresses data file in ZLIB format.
  • Enabled, if [Compress data file] is checked.
Image file settings
Item name Required/Optional Use of variables Description Remarks
Image file Optional - Specify image file to send to Universal Connect/X server.

Each image file can be operated with the following button.
  • [Add]:
    Adds an image file name.
  • [Up]:
    Moves up the order of selected image file name by one.
  • [Down]:
    Moves down the order of selected image file name by one.
  • [Delete]:
    Deletes an image file name.
 
Image file/File name Required Available Input file path of image file.

By clicking [Browse] button, file chooser launches and enables to select file.
  • Specify absolute path on the server OS local file system.
Print location settings
Item name Required/Optional Use of variables Description Remarks
Perform print location adjustment Optional Not available Select whether to perform print location adjustment.
  • [Checked]:
    Performs print location adjustment.
  • [Not checked]:(default)
    Does not perform print location adjustment.
 
Print location adjustment unit Optional Not available Select a unit to adjust print location.
  • [1/400 dot unit]:(default)
    Adjusts print location with 1/400 dot unit.
  • [1/10 milli unit]:
    Adjusts print location with 1/10 milli unit.
  • Enabled, if [Perform print location adjustment] is checked.
x coordinate Optional Available Set left and right adjustment value of print location.
  • Enabled, if [Perform print location adjustment] is checked.
  • Input whole number.
y coordinate Optional Available Set up and down adjustment value of print location.
  • Enabled, if [Perform print location adjustment] is checked.
  • Input whole number.
Output file settings
Item name Required/Optional Use of variables Description Remarks
Specify output destination Optional Not available Select whether to receive output file generated by SVF product.
  • [Checked]:
    Receives output file.
  • [Not checked]:(default)
    Does not receive output file.
  • Disabled, if [Delete generation file] is checked.
Output result file name Required Available Input file path of PDF file to receive as report output result.

By clicking [Browse] button, file chooser launches and enables to select file.
  • Specify the absolute path of the DataSpider file system as the file path.
  • Constrained characters of DataSpider File System except for path separator "/" cannot be used.
  • Enabled, if [Specify output destination] is checked.
  • Disabled, if [Delete generation file] is checked.
  • Overwrites, if file exists.
Receive total page number Optional Not available Select whether or not receive total page number of output file generated by SVF products.
  • [Checked]:
    Receive total page number.
  • [Not checked]:(default)
    Does not receive total page number.
  • If [Checked], stores total page number to component variable "total_page_count".
Delete generated file Optional Not available Select whether to delete output file generated by SVF products.
  • [Checked]:
    Deletes generated file.
  • [Not checked]:(default)
    Does not delete generated file.
  • Enabled, if [Receive total page number] is checked.
Log settings
Item name Required/Optional Use of variables Description Remarks
Log file encode Required Available Select or input the encode of UCXSingle execution result log.
  • [Windows-31J]:
  • [Shift_JIS]:
  • [ISO-2022-JP]:
  • [EUC-JP]:
  • [US-ASCII]:
  • [ISO-8859-1]:
  • [UTF-8]:(default)
  • [UTF-16BE]:
  • [UTF-16LE]:
  • [UTF-16]:
  • Displayed in case of Universal Connect/X 9.2 adapter.
Delete generated file Optional Not available If output report is successfully completed, select whether to output UCXSingle execution result log.

UCXSingle execution result log will be output under $DATASPIDER_HOME/server/logs/<date directory>/execution.
Log file name will be <GID(unique ID generated in DataSpiderServer)>.ucx.log.
  • If report operation is unsuccessfully completed, then execution result log of UCXSingle will always be output.
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" ?>
<fileNameList>
  <file>
    <path>Output file file name generated by SVF product</path>
  </file>
     :
</fileNameList>
Element name Attribute name Description Remarks
fileNameList - Element showing file name list of output file generated by SVF product.  
file - Element showing output file generated by SVF product.  
path - Element showing output file path generated by SVF product.  

Loading Schema on Mapper

Schema will be loaded automatically.
For more detail, refer to "Edit schema".

Mass data processing

Mass data processing is not supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name Description Remarks
manage_num Stores the document number allocated when spooled to RDE.
  • Default value is null.
  • If JOB output destination specified in [JOB ID] is not RDE, -1 will be stored.
total_page_count Stores the output file total page number generated by SVF product.
  • Default value is null.
  • If [Receive total page number] is checked, output file total page number generated by SVF product will be stored.
output_file_path Stores the value input in [Output result file name].
  • Default value is null.
output_file_local_path Path on server OS local file system of the value input to [Output result file name] will be output.
  • Default value is null.
  • If the type of DataSpider file system for path input to [Output result file name] is either local file system, or expansion local file system, then path on server OS local file system will be stored.
message_category Stores the category of message code corresponding to the occurred error.
  • Default value is null.
message_code Stores the code of message code corresponding to the occurred error.
  • Default value is null.
message_level Stores the severity of message code corresponding to the occurred error.
  • Default value is null.
error_type Stores the error type of occurred error.
  • Default value is null.
  • Error is represented in the format depicted below.
    Example:java.io.FileNotFoundException
  • The value may vary depending on the DataSpider Servista version.
error_message Stores the error message of occurred error.
  • Default value is null.
  • The value may vary depending on the DataSpider Servista version.
error_trace Stores the trace information of occurred error.
  • Default value is null.
  • The value may vary depending on the DataSpider Servista version or the client application used.

Specification Limits

Main Exceptions

Exception name Cause Solution
ResourceNotFoundException
Resource definition is not found. Name:[]
[Destination] is not specified. Specify [Destination].
ResourceNotFoundException
Resource definition is not found. Name:[<Global resource name>]
Resource definition selected in [Destination] is not found. Check 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.
InvalidPropertyConfigurationException
<Property name> is not specified.
[<Property name>] is not specified. Specify [<Property name>].
PathIsNotAbsoluteException Designated path is relative path. Input absolute path.
FileIsDirectoryException Path entered is directory. Input file path.
PrintFailureException
 ucxSingleResult:Error code
 uniConXResult:Error code
Error occurred during report output. Modify where applicable by checking error contents from error code.
java.io.FileNotFoundException Specified file does not exist. Specify the existing file.
java.io.FileNotFoundException
Other process is in use.
Specified file is used by other process. Check whether this is used in other process.
java.io.IOException
No response file.
Could not receive output result file of report form output. If output destination of the job specified in [JOB ID] is printer or RDSpool, take out the check from [Specify output result file].