Read File/Folder

Operation Name

Read File/Folder

Function overview

Reads the files/folder on Niftycloud Storage, then writes to the directory on DataSpider file system.

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 on the script canvas.  
Required settings
Item name Required / Optional Use of Variables Description Remarks
Destination Required Not available Select global resource.
  • [Add]:
    Adds new global resource.
  • [Edit list]:
    Global resource settings can be edited with "Edit Resource list".
 
Bucket name Required Available Specify Bucket.
  • If specifying Bucket which large number of files exist in [Bucket name], it may takes time to update list of [Folder path].
    To avoid, refer to "Notes" section for more information.
Folder path Required Available Enter Niftycloud Storage folder path.
File/folder name Required Available Specify file /folder.
  • Wildcards("*" and "?") are available.
  • "/" Can not be included.
Local directory Required Available Specify a directory path of DataSpider filesystem.

Select a directory in the directory chooser that is launched, by pressing [Browse] button.
Overwrite Optional Not available Choose whether to overwrite when file with the same name exists on the specified local directory.
  • [Checked]:(default)
    Overwrites when file with the same name exists on the specified local directory.
  • [Not Checked]:
    Raises an error without overwriting when file with the same name exists on the specified local directory.
 
Recursive processing Optional Not available For a specified folder, select whether to get the file/folder recursively or not.
  • [Checked]:
    If the specified folder contains folders, then gets the file/folder recursively.
  • [Not Checked]:(default)
    Get only the files in the folder you specify.
 
With information of file access rights Optional Not available Choose whether to include file access right information in the results.
  • [Checked]:
    Includes file access right information in the results.
  • [Not Checked]:(default)
    Does not include file access right information in the results.
 
Data processing method
Item name Required / Optional Use of Variables Description Remarks
Mass data processing Required Not available Select a data processing method.
  • [Use script settings]: (default)
    Apply mass data processing settings of script property to adapter.
  • [Disable]:
    Mass data processing is not performed.
  • [Enable]:
    Mass data processing is performed.
 
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"?>
<server>
  <bucket errorcode="" name="" status="" >
    <file errorcode="" etag="" localpath="" name="" public="" remotepath="" size="" status="" type="" updated="" />
  </bucket>
</server>
Element Name Attribute Name Description Remarks
server -    
bucket - Appears in each Bucket which is gotten.  
errorcode When an error occur in Niftycloud Storage during getting a bucket, APT error code is output which is defined at Niftycloud Storage.
  • When an error does not occur in Niftycloud Storage, there is a blank.
  • For more details about API error code defined in Niftycloud Storage, refer to (http://cloud.nifty.com/api/storage/errorcode.htm).
name Outputs the name of the gotten file/folder.  
status Outputs status of the gotten file/folder.
  • Exist:Status that file/folder exists.
  • ErrorBucketNotFound:status that the specified [folder path] is not on the Niftycloud Storage, or file is specified.
  • Error:status that because an error occurred file/folder information could not be got.
 
file - Appears in each file/folder which is gotten.  
errorcode When an error occur in Niftycloud Storage during deleting a file/folder, APT error code is output which is defined at Niftycloud Storage.
  • When an error does not occur in Niftycloud Storage, there is a blank.
  • For more details about API error code defined in Niftycloud Storage, refer to (http://cloud.nifty.com/api/storage/errorcode.htm).
etag Outputs the ETag of the gotten file/folder.
  • When file/folder could not be gotten normally, there is a blank.
localpath Outputs the local path of the retrieved file/folder.
  • When status is "ErrorRemoteFolderNotFound", the value is a blank.
name Outputs the name of the gotten file/folder.
  • If status is "ErrorLocalFolderNotFound" then the value is blank.
  • If status is "ErrorRemoteFolderNotFound" then the value is blank.
public Outputs access right of retrieved files/folder.
  • true: Public
  • false: Private
  • If file/folder information could not be retrieved successfully, the value is blank.
  • Should the "READ" authority be granted to "AllUsers Group", the access authority becomes "Public".
  • If [With information of file access rights] is [Not Checked] then the value is blank.
remotepath Outputs file path on Niftycloud Storage of the retrieved file/folder.
  • If status is "ErrorRemoteFolderNotFound" then the value is blank.
size Outputs the size of the file/folder retrieved. The unit is byte.
  • If file/folder information could not be retrieved successfully, the value is blank.
  • In case of folder, "0" is output.
status Outputs status of the gotten file/folder.
  • Exist: Status that file/folder exists.
  • li>ErrorRemoteFolderNotFound: Status that the specified [folder path] is not on the Niftycloud Storage, or file is specified.
  • ErrorRemoteFileNotFound: status that on Niftycloud Storage, the specified file/folder does not exist in the specified [Folder path].
  • ErrorLocalFileNotFound: Status that the specified [Local directory] does not exist, or file is specified.
  • ErrorLocalFileExist: status that [Overwrite] is [Not checked] and files with the same name exist in the specified [Local directory].
  • Error: status that because an error occurred file/folder information could not be got.
 
type Outputs the classification of acquired file/folder.
  • File: File
  • Folder: Folder
 
updated Outputs the last updated date of the retrieved file/folder.
  • If file/folder information could not be retrieved successfully, the value is blank.
  • Output by the format of [xmlfw.daterenderingformat] inside system property.If it has not been set, the default format will be "yyyy-MM-dd'T'HH: mm: ss.SSSZZ "is printed on.
    Example :2007-10-16T13: 15:22.738 +0900
  • Time zone is the time zone of DataSpiderServer.

Loading schema in Mapper

Schema is loaded automatically.
See "Edit Schema" for details with regards to defining a schema.

Mass data processing

Mass data processing is supported.

PSP Usage

PSP is not supported.

Available component variables

Component variable name Description Remarks
count Returns the number which is the total number of the gotten folder number and file number.
  • The value defaults to null.
  • The sum of "folder_count" and "file_count".
folder_count Returns the number of retrieved folder.
  • The value defaults to null.
file_count Returns the number of retrieved file.
  • The value defaults to null.
message_category Stores the category to which corresponding message code belongs to of occured error.
  • The value defaults to null.
message_code Stores its corresponding message code of the occured error.
  • The value defaults to null.
message_level Stores the severity of the corresponding message code of the occured error.
  • The value defaults to null.
error_type Stores the type of the occured error.
  • The value defaults to null.
  • Error is represented in the format depicted below.
    Example:java.io.FileNotFoundException
  • The message may vary depending on the DataSpider Servista version.
error_message Stores the error message for the occured error.
  • The value defaults to null.
  • The message may vary depending on the DataSpider Servista version.
error_trace Stores the stack trace of the occured error.
  • The value defaults to null.
  • The message may vary depending on the DataSpider Servista version or the client application used.

Specification Limits

Main Exceptions

Exception name Cause Solution
ResourceNotFoundException
Resource definition could not be found.Name: []
[Destination] is not specified. Please specify [Destination].
ResourceNotFoundException
Resource definition could not be found.Name: [<name of global resource>]
Resource definition selected in [Destination] is not found. Please check the global resource specified in [Destination].
InvalidPropertyConfigurationException
<Property Name> is not specified.
[<Property Name>] is not specified. Please specify [<Property Name>].
InvalidPropertyConfigurationException
"/" is included in file/folder name.
"/" is included in [File/folder name]. In [File/folder name], please specify the file/folder name which do not include "/".
com.nifty.cloud.ncs.service.StorageException
The Access Key Id you provided does not exist in our records.
[AccessKey] of global resource specified in [Destination] is wrong. Confirm the settings of global resource specified in [Destination].
com.nifty.cloud.ncs.service.StorageException
The request signature we calculated does not match the signature you provided. Check your AWS Secret Access Key and signing method. For more information, see REST Authentication and SOAP Authentication for details.
[SecretAccessKey] of global resource specified in [Destination] is wrong. Confirm the settings of global resource specified in [Destination].
com.nifty.cloud.ncs.NiftyCloudClientException
Failed to execute HTTP request: Connect to ncss.nifty.com/ncss.nifty.com/xxx.xxx.xxx.xxx timed out
Connection with Niftycloud Storage could not be confirmed during [Timeout] of global resource specified in [Destination] . Confirm the settings of global resource specified in [Destination].
com.nifty.cloud.ncs.NiftyCloudClientException
Failed to execute HTTP request: peer not authenticated
Certification with Niftycloud Storage could not be confirmed during [Timeout] of global resource specified in [Destination] . Confirm the settings of global resource specified in [Destination].

Notes