EasyMorph Help

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
{{ transformations:AzureBlobStorageCommand.png}}
====== AZURE BLOB STORAGE COMMAND ======
Category: Workflow / App/Cloud\\

\\ 
=====Description=====
This action performs file and folder operations with Azure Blob Storage.  A configured [[connectors:azureblobstorage|Azure Blob Storage connector]] is required.

\\
=====Capabilities=====
  *List file
  *Download file
  *Download list of files
  *Download folder
  *Upload file
  *Upload list of files
  *Upload folder
  *Delete file
  *Delete list of files
  *List folders
  *Create folder
  *Copy folder
  *Delete folder

\\ 
=====Action settings=====
^ Setting  ^ Description  ^
|Connector<sup>*</sup>|Select the preconfigured Azure Blob Storage connector, or, build one by selecting //Add connector//.\\  See [[connectors:azureblobstorage|Azure Blob Storage connector]] for details.|
|Container|Select the container to operate within:  //Default// (for the default container), or //Other// and navigate to the desired container.|
|Command|Select the file operation this action will perform.  Options:  //List files//, //Download file//, //Download list of files//, //Upload file//, //Upload list of files//, //Delete file//, //Delete list of files//, //List folders//, //Create folder//, or //Delete folder//.  See below for details of each command type.|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].

\\ 
====List files settings====
**Description:**  Produce a list of files, with selected file properties, in a specified folder on Azure Blob Storage.
^ Setting  ^ Description  ^
|Folder<sup>*</sup>|Select a subfolder within the selected Container to access.|
|Columns|Select the details of the found files to be included in the dataset.  Each detail produces a column.  Options:  //File name with full path//, //File name only//, //File extension//, //Size//, //Date created//, //Date modified//, and //MIME type//.|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].

\\ 
====Download file settings====
**Description:** Downloads the specified file from Azure Blob Storage to the local location defined.
^ Setting  ^ Description  ^
|File path<sup>*</sup>|Enter or browse to the file in to be downloaded.|
|Local folder<sup>*</sup>|Enter or browse to the local folder to download the file to.|
|If a file with such name already exists|Select how EasyMorph will handle saving the file if a file with the same name exists in the destination folder.  Options:  //Overwrite//, //Do nothing//, or //Halt project execution//.  See the "File already exists" table below.|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].

\\ 
====Download list of files settings====
**Description:** Downloads multiple files specified in a column in the action's input dataset.
^ Setting  ^ Description  ^
|File list|Select the table column containing the list of fully qualified file names to be downloaded.|
|Local folder<sup>*</sup>|Enter or browse to the local folder to download the files to.  This action will //overwrite// files with the same names\\ that already exist in the destination folder.|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].

\\ 
====Download folder settings====
**Description:** Downloads the contents (all files and subfolders, recursively) of the specified folder from Azure Blob Storage to the defined local folder.
^ Setting  ^ Description  ^
|Folder path<sup>*</sup>|Select an Azure Blob Storage folder to download the contents of. |
|Local folder<sup>*</sup>|Select the local folder to download the contents into.|
|If the folder already exists|Select how EasyMorph will handle downloading the folder if a local folder with the same name exists in the selected\\ destination folder.  Options:  //Fail// (the workflow stops with a warning), //Overwrite// (replace existing files and folders\\ in the local directory with the latest versions from the Azure Blob Storage folder, and download any new files or folders that don't already exist locally), or //Copy missing files// (only download files and folders from the Azure Blob Storage folder that are not present in the local directory).|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].

\\ 
====Upload file settings====
**Description:** Uploads the specified local file to the defined Azure Blob Storage folder.
^ Setting  ^ Description  ^
|File path<sup>*</sup>|Enter or browse to the local file to upload.|
|Target folder<sup>*</sup>|Enter or browse to an Azure Blob Storage folder to upload the file to.|
|If a file with such name already exists|Select how EasyMorph will handle saving the file if a file with the same name exists in the destination folder.  Options:  //Overwrite//, //Do nothing//, or //Halt project execution//.  See the "File already exists" table below.|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].

\\ 
====Upload list of files settings====
**Description:** Uploads multiple files specified in a column in the action's input dataset.
^ Setting  ^ Description  ^
|File list|Select the table column containing the list of fully qualified local file names to be uploaded.|
|Target folder<sup>*</sup>|Enter or browse to an Azure Blob Storage folder to upload the files to.  This action will //overwrite// files with the same names\\ that already exist in the destination folder.|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].

\\ 
====Upload folder settings====
**Description:** Uploads the contents (all files and subfolders, recursively) of a chosen local folder to an Azure Blob Storage folder.
^ Setting  ^ Description  ^
|Local folder<sup>*</sup>|Select the local folder to upload the contents of.|
|Target folder<sup>*</sup>|Select a Azure Blob Storage folder to upload the contents to. |
|If the folder already exists|Select how EasyMorph will handle downloading the folder if a local folder with the same name exists in the selected\\ destination folder.  Options:  //Fail// (the workflow stops with a warning), //Overwrite// (replace existing files and folders in the\\ Azure Blob Storage folder with the latest versions from the local folder, and upload any new files or folders that don't already exist in the Azure Blob Storage folder), or //Copy missing files// (only upload files and folders from the local folder that are not present in the Azure Blob Storage folder).|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].

\\ 
====Delete file settings====
**Description:** Deletes the specified file from Azure Blob Storage.
^ Setting  ^ Description  ^
|File path<sup>*</sup>|Enter or browse to the remote file to delete.|
|If the file doesn't exist|Select how EasyMorph handles situations when the specified file does not exist.  Options:  //Do nothing// (nothing happens, the workflow continues, no error is displayed), or //Halt project execution// (workflow stops, an error is displayed).|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].

\\ 
====Delete list of files settings====
**Description:** Deletes multiple files specified in a column in the action's input dataset.
^ Setting  ^ Description  ^
|File list|Select the table column containing the list of fully qualified Google Drive file names to be deleted.|
|If a file from the list doesn't exist|Select how EasyMorph handles situations when a file in the list does not exist.  Options:  //Ignore// (nothing happens, the workflow continues, no error is displayed), or //Halt project execution// (workflow stops, an error is displayed).|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].

\\
====List folders settings====
**Description:**  Produce a list of subfolders under the selected folder.
^ Setting  ^ Description  ^
|Folder<sup>*</sup>|Select a folder on the remote resource to retrieve a list of subfolders from.|
|Columns|Select the details of the found subfolders to be included in the dataset.  Each detail produces a column.\\  Options:  //Folder name with full path// and //Folder name only//.|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\

\\
====Create folder settings====
**Description:**  Create a new Azure Blob Storage folder under the selected parent folder.
^ Setting  ^ Description  ^
|Parent folder<sup>*</sup>|Select a folder in Azure Blob Storage to create the new folder under.|
|Folder name<sup>*</sup>|Enter the name of the new folder.|
|If a folder with such name already exists|Choose how EasyMorph behaves if a folder with the //Folder name// already exists.  Options:  //Fail// (the workflow stops with a warning) or //Do nothing// (the workflow continues without creating the new folder).|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\

\\
====Copy folder settings====
**Description:**  Copy an existing Azure Blob Storage folder into another folder (as a subfolder).
^ Setting  ^ Description  ^
|Folder path<sup>*</sup>|Select the folder to be copied to the new folder.|
|Target folder<sup>*</sup>|Select the folder to copy into.|
|If a folder with such name already exists|Choose how EasyMorph behaves if a folder with the //Folder name// already exists.  Options:  //Fail// (the workflow stops with a warning), //Overwrite// (replace the Target folder with the copied folder), or //Copy missing files// (copy files from the copied folder that are missing in the Target folder) .|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\

\\
====Delete folder settings====
**Description:**  Delete the selected Azure Blob Storage folder.
^ Setting  ^ Description  ^
|Folder path<sup>*</sup>|Select the folder to delete.|
|If the folder doesn't exist|Choose how EasyMorph behaves if the selected folder does not exist.  Options: //Do nothing// (the workflow continues without creating the new folder) or //Fail// (the workflow stops with a warning).|
<sup>*</sup> Setting can be specified using a [[:parameters|parameter]].\\

\\ 
=====Remarks=====
The easiest way to build a list of remote files in Azure Blob Storage to be downloaded or deleted is to use this action in its //File list// configuration, including the "File name with full path" option.  This list can then be modified to generate the final list of files to be downloaded or deleted.

\\ 
=====See also=====
  * [[transformations:filecommand|File command]]
  * [[transformations:filelist|List of files]]
  * [[transformations:amazoncommand|Amazon S3 command]]
  * [[transformations:dropboxcommand|Dropbox command]]
  * [[transformations:googledrivecommand|Google Drive command]]
  * [[transformations:onedrivecommand|OneDrive command]]
  * [[transformations:sharepointcommand|SharePoint command]]