Write File/Folder

Operation Name

Write File/Folder

Function Overview

Write file/folder on DataSpider file system to Google Drive.

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 Resources.
  • [Add]:
    Adds new global resource.
  • [Edit list]:
    Global resource settings can be managed from "Edit Resource list".
 
Local directory Required Available Specify a directory path of DataSpider filesystem.

If [Browse] button is pressed, directory Selectr will launch and the directory can be selected.
Local file/directory name Required Available Specify file/directory on DataSpider files system.
  • For file/folder name, wildcards ("*" and "?" are available.
  • "/" is not available.
Recursive processing Optional Not available For specified local directory, select whether to process file/directory recursively.
  • [Checked]:
    Processes file/directory recursively if a directory is contained in the specified local directory.
  • [Not Checked]: (default)
    Only process files in the specified local directory.
 
Convert file To Google format Optional Not available Select whether to convert the file to Google format.
  • [Checked]:
    Uploads the file after having it converted to a Google format.
  • [Not Checked]: (default)
    Uploads the file without converting.
Folder path Required Available Enter a folder path of Google Drive.
Create folder when it doesn't exist Optional Not available Select whether to create the folder when specified folder does not exist.
  • [Checked]: (default)
    Creates the folder when specified folder does not exist.
  • [Not Checked]:
    Raises an error without creating the folder when specified folder does not exist.
 
Overwrite Optional Not available Select whether to overwrite when a file with the same name exists in the specified folder.
  • [Checked]: (default)
    Overwrites when a file with the same name exists in the specified folder
  • [Not Checked]:
    Raises an error without overwriting when a file with the same name exists in the specified folder.
 
Property Action
Item name Description Remarks
Update folder path list Get folder path in the specified destination and set to [Folder path].
  • If [Destination] is specified/edited, or folder has been added/edited on Google Drive, it can be reflected using this property action.
Comment
Item name Required/Optional Usnore 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>
  <files>
    <file etag="" localpath="" name="" remotepath="" size="" status="" type="" updated="" />
  </files>
</server>
Element name Attribute name Description Remarks
server -    
files -    
file - Appear in each written file/folder.  
etag Outputs ETag of each written file/folder.
  • Outputs when file/folder is successfully written.
  • ETag values may be updated automatically.
localpath Output local path of written file/folder.
  • Outputs when status is not "ErrorRemoteFolderNotFound".
name Outputs name of written file/folder.
  • Outputs when status is not "ErrorRemoteFolderNotFound".
remotepath Outputs file path of written file/folder on Google Drive.  
size Outputs classification of written file/folder. The unit is byte.
  • Outputs when file/folder is written correctly.
  • Outputs "0" in case of a folder.
  • Always outputs "0" for Google format files (such as spreadsheets, presentations, documents, forms).
status Output status of written file/folder.
  • Exist: Status that the file/folder does exist.
  • ErrorLocalFileNotFound: Status that the specified [Local directory] does not exist, or the specified file/directory does not exist.
  • ErrorLocalFileSize0Byte: Status that cannot write due to size of specified [filename] is 0 byte.
  • ErrorLocalFileInvalidType:Status that file export has failed as the [File name] specified has a file extension that does not match any of the Google formats.
  • ErrorRemoteFolderNotFound: The status that on Google Drive, specified [Folder path] does not exist, or file is specified.
  • ErrorRemoteFileExist:Status a file with the same name exists in Google Drive [Folder path] specified and the [Overwrite] is [Not Checked].
  • ErrorRemoteFileUploadFailed: File export has failed.Export has failed due to any of the following reasons:
    • Failed to convert the file to Google format.
    • The file size exceeds the size limit for the Google format conversion.
  • Error: The status that because an error occurred file/folder could not be written.
 
type Output classification of written file/folder.
  • File: File
  • Folder: Folder
 
updated Output the latest update date of written file/folder.
  • Outputs when file/folder is written successfully.
  • Outputs 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 onExample :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 any details .

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
count Return the number which is the total number of the written folder number and file number
  • The value defaults to null.
  • The sum of' 'folder_count' and 'file_count'.
folder_count Return the number of written folder.
  • The value defaults to null.
file_count Return the number of written file.
  • The value defaults to null.
message_category Stroes the category to which corresponding message code belongs to, when an error occurs.
  • The value defaults to null.
message_code Stores its corresponding message code of 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 DataSpider Servista version.
error_message Stores the error message for the occured error.
  • The value defaults to null.
  • The message may vary depending on DataSpider Servista version.
error_trace Stores stack trace of the occurred error.
  • The value defaults to null.
  • The message may vary depending on DataSpider Servista version or the client application used.

About file conversion to Google format

Specification Limits

Main exceptions

Exception name Causes 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 Resources>]
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. Specify the [<Property name>].

Notes