Delete File/Directory/Container

Operation Name

Function Overview

Delete the specified file, directory, or container in Microsoft Azure BLOB Storage.

Data Model

XML type.

Properties

For details on use of 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. [Add]: Add a new global resource. [Edit list]: Global resource settings can be edited in “Edit resource list” screen.
Container name	Required	Available	Specify container.	For details on naming conventions of container name in Microsoft Azure, refer to ”Notes”. When specifying root container, create a new container named $root and select it.
Delete container	Optional	Not available	Select whether or not to delete container. [Checked]: Delete container. [Not checked]: (default) Delete file.
Virtual directory	Optional	Available	Select or enter a virtual directory.	When omitted, it will be root directory “/”.
File/Directory name	Required	Available	Select or enter a file/directory name.	Disabled when [Delete container] is checked. Wild cards ("*" and "?") can be used. Case-sensitive.
Set directory as target as well	Optional	Not available	Select whether or not to set the directory of [File/Directory name] as target as well. [Checked]: Files and directories of [File/Directory name] will be targets. [Not checked]: (default) Files of [File/Directory name] will be targets.

Property actions

Item name	Description	Remarks
Update container name list	Get container names from the specified destination and set them in [Container name].	When [Destination] is changed or the container in Microsoft Azure BLOB Storage is modified, those changes can be reflected with this property action. Disabled when [Destination] is not specified.
Update virtual directory list	Get virtual directories in the specified container and set them in [Virtual directory].	When [Container name] is changed or the virtual directory in Microsoft Azure BLOB Storage is modified, those changes can be reflected by this property action. Disabled when [Destination] or [Container name] is not specified.
Update file/directory name list	Get file/directory names in the specified virtual directory and set them in [File/Directory name].	When [Virtual directory] is changed or the file in Microsoft Azure BLOB Storage is modified, those changes can be reflected with this property action. When [Set directory as target as well] is checked, directory names will be got as well. Disabled when [Destination], [Container name], or [Virtual directory] is not specified.

Data processing method

Item name	Required/Optional	Use of variables	Description	Remarks
Data processing method	Required	Not available	Select a data processing method. [Apply script settings]: (default) Apply the mass data processing settings of the script property to the adapter. [Do not perform mass data processing]: Mass data processing will not be performed. [Perform mass data processing]: Mass data processing will be 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

When deleting file

<?xml version="1.0"?>
<server>
  <container name="" status="" >
    <file name="" status="" />
  </container>
</server>

Element name	Attribute name	Description
server	-
container	-
	name	Outputs the container name of the deleted file.
	status	Outputs the container status of the deleted file. [Exist]: Status that container exists. [ErrorContainerNotFound]: Status that the container does not exist. The specified [Container name] might be incorrect. Error: Status that the existence of container could not be confirmed due to an error.
file		Appears for each deleted file.
	name	Outputs the file name in Azure BLOB Storage.
	status	Outputs the status of the file. [Deleted]: Status that the file is deleted normally. [ErrorRemoteFileNotFound]: Status that the file does not exist. The specified [File name] might be incorrect. [Error]: Status that the file could not be deleted due to an error.

When deleting container

<?xml version="1.0"?>
<server>
  <container name="" status="" />
</server>

Element name	Attribute name	Description
server	-
container	-
	name	Outputs the name of the deleted container.
	status	Outputs the status of the deleted container. [Deleted]:Status that container is deleted normally. [ErrorContainerNotFound]: Status that the container does not exist. The specified container name might be incorrect. [Error]:Status that the container could not be deleted due to the error.

Loading schema in Mapper

Schema is loaded automatically.

For more details, refer to “Edit Schema”.

Mass Data Processing

Mass Data Processing is supported.

Transaction

Transaction is not supported.

PSP Usage

PSP is not supported.

Available Component Variables

Component variable name	Description	Remarks
count	The number of deleted files/containers is stored.	Default value is null.
message_category	When an error occurs, category of the corresponding message code is stored.	Default value is null.
message_code	When an error occurs, code of the corresponding message code is stored.	Default value is null.
message_level	When an error occurs, severity of the corresponding message code is stored.	Default value is null.
error_type	When an error occurs, the error type is stored.	Default value is null. The error type would be in the following format. Example: “java.io.FileNotFoundException” The contents that will be stored may vary depending on DataSpider Servista versions.
error_message	When an error occurs, the error message is stored.	Default value is null. The contents that will be stored may vary depending on DataSpider Servista versions.
error_trace	When an error occurs, trace information of the error is stored.	Default value is null. The contents that will be stored may vary depending on DataSpider Servista versions and client applications.

Specification Limits

None.

Major 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>]	The resource definition selected in [Destination] is not found.	Check the global resource specified in [Destination].
InvalidPropertyConfigurationException <property name> is not specified.	[<property name>] is not specified.	Specify [<property name>].
com.microsoft.azure.storage.StorageException	Status unavailable to connect due to the following causes. There is something wrong with [Account] or [Access key] of the global resource specified in [Destination]. 2 byte characters are included in [Account] of the global resource specified in [Destination].	Check the settings of the global resource specified in [Destination] and the connection.
java.security.InvalidKeyException Storage Key is not a valid base64 encoded string.	There is something wrong with [Access key] of the global resource specified in [Destination].	Check the settings of the global resource specified in [Destination].

Notes

HTTPS is used in communication between Microsoft Azure BLOB Storage and this adapter.

Naming conventions of container name in Microsoft Azure
- Containers should be named in compliance with the following 4 rules.
  1. A container name starts with alphabets or numerics. It should contain only alphabets, numerics, or hyphens (-).
  2. A hyphen (-) should be both just before and after alphabets or numerics.
  3. Alphabets should be in lower case letters.
  4. The length of a container name should be between 3 and 63 characters.
When an error other than connection related errors (an error that are not described in "Major Exceptions") occurs, sets "Error" in status attribute of file element of the file/container in which the error has occurred of the result data, outputs the result data, and continues to the subsequent process.

When executing this operation in multi-threads, an error may occur (status attribute of file element of the relevant file ends with "Error"). In that case, reduce the multiplicity of threads and execute it.