orchestrator
2022.10
false
Orchestrator User Guide
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Oct 9, 2024

Managing Storage Buckets

Creating Storage Buckets

  1. From the Storage Buckets page, click the Add button. The Add Bucket window is displayed.
  2. Select the desired storage provider for this bucket.
  3. Complete the general details for the selected provider.

    Orchestrator storage buckets:

    Field

    Description

    Name

    Enter a descriptive name for the new bucket.

    Description

    Enter an optional description for the new bucket.

    Labels

    Enter a label to help users identify the new bucket.

    Properties

    Enter properties to help users identify the new bucket.

    Note: Orchestrator storage buckets do not support SSE-KMS encryption.

    Azure storage buckets:

    Field

    Description

    Name

    Enter a descriptive name for the new bucket.

    Description

    Enter an optional description for the new bucket.

    Azure Storage container name

    Enter the name of the Azure Storage container to be used for this bucket.

    Azure Storage endpoint suffix

    Enter the endpoint suffix of your Azure Storage environment. For example, the endpoint suffix for Azure Public is core.windows.net.

    Azure Storage account name

    Enter the Azure Storage account for this container.

    Azure Storage access password

    Enter the access key for the Azure Storage account being used.

    Credential Store

    Select which Orchestrator credential store is used to store the provided password.

    Labels

    Enter a label to help users identify the new bucket.

    Properties

    Enter properties to help users identify the new bucket.

    Amazon S3 storage buckets

    Field

    Description

    Name

    Enter a descriptive name for the new bucket.

    Description

    Enter an optional description for the new bucket.

    Amazon S3 bucket name

    Enter the name of the Amazon S3 bucket to be used.

    Amazon S3 region

    Enter the region of your Amazon S3 account. For example us-east-1.

    Amazon S3 access key

    Enter the access key for your Amazon S3 account.

    Amazon S3 access password

    Enter the password for the Amazon S3 account being used.

    Orchestrator Credential Store

    Select which Orchestrator credential store is used to store the provided password.

    Labels

    Enter a label to help users identify the new bucket.

    Properties

    Enter properties to help users identify the new bucket.

    S3 compatible storage buckets



    Field

    Descriptions

    Name

    Enter a descriptive name for the new bucket.

    Description

    Enter an optional description for the new bucket.

    Bucket name

    Enter the name of the S3 compatible bucket to be used.

    Service URL

    Enter the service HTTP URL without the bucket name in the subdomain. For example, https://storage.mycompany.example.com.

    Access key

    Enter the access key for your storage system.

    Force path style

    Enable to force the use of Path-Style requests. Disable to use Virtual Hosted-Style requests. See details about virtual hosting of buckets.

    Advanced signature options

    Enable this option to provide advanced signature authentication options. When enabled, the Signature version and the Signature method fields are displayed.

    Signature version

    Select the signing protocol. The following options are available: V2 and V4. The default is V4. Most storage systems use this.

    Signature method

    Select the type of hash algorithm used to encrypt the signature. The following options are available: HmacSHA1 and HmacSHA256. The default is HmacSHA256. Most storage systems use this.

    Secret key

    Enter the secret key for your storage system.

    Orchestrator credential store for safekeeping the provided password

    Select which Orchestrator credential store is used to store the provided password.

    Labels

    Enter labels to help users identify the new bucket.

    Properties

    Enter properties to help users identify the new bucket.

    4. Configure the Bucket Options:

    • Readonly - use the toggle to make this bucket read-only for users.
    • Audit read access - use the toggle to enable auditing of user read access.
  4. Click Add. Your bucket is created and available for use.

Editing Storage Buckets

  1. From the Storage Buckets page, click the Edit button corresponding to the desired bucket. The bucket is opened for editing.
  2. Change the desired fields. The editable fields vary depending upon the storage provider used. See field descriptions by expanding the sections above.
  3. Click Update. The bucket is updated and you are returned to the Storage Buckets page.

Adding Tags to Storage Buckets

You can apply tags to a storage bucket either when creating one or editing an existing one. To add tags to a storage bucket when editing it, follow these steps:

  1. From the Storage Buckets page, click the Edit button corresponding to the desired bucket. The bucket is opened for editing.
  2. On the Labels field, start typing the name of the label. You can choose an existing label or create a new one.
  3. On the Properties (key-value pairs) field, click Add new.
  4. Add new keys and values. You can choose existing keys and/or values or you can create new ones.
  5. When done, click Update. Your storage bucket is updated and the newly created tags, if any, become available for other objects.

Removing Tags From Storage Buckets

To remove tags from a storage bucket, follow these steps:

  1. From the Storage Buckets page, click the Edit button corresponding to the desired bucket. The bucket is opened for editing.
  2. On the Labels field, click the X adjacent to the name of the label to remove it. The label is removed.
  3. On the Properties (key-value pairs) field, click the X adjacent to the keys and/or values to remove them. The keys and/or values are removed.
  4. To delete a key/value pair click the Remove icon corresponding to that entry. The key/value pair is removed.
  5. When done, click Update. Your storage bucket is updated and tags are removed.

Deleting Storage Buckets

  1. From the Storage Buckets page, click the Delete button corresponding to the desired bucket.
  2. You are prompted Are you sure you want to delete the selected items?
  3. Select No to cancel or Yes to confirm and delete the selected bucket.

Uploading a File to a Storage Bucket

  1. From the Storage Buckets page, click the name of the desired bucket. The bucket is opened for viewing.
  2. Click the Upload button. The Upload new file window is displayed.


  3. Click the Browse button. Your file explorer is displayed, navigate to and select the desired file. Once selected, the File full path is automatically filled-in. The File full path can be edited, and the file uploaded to a virtual directory.
  4. Click Upload. The file is uploaded and available in the storage bucket.

Downloading a File From a Storage Bucket

  1. From the Storage Buckets page, click the name of the desired bucket. The bucket is opened for viewing.
  2. Click the Download button corresponding to the desired file. The download dialog is displayed prompting you to either open or save the selected file.

Managing Storage Bucket Links

Sharing storage buckets between folders enables launching jobs in multiple folders without redesigning your workflows in Studio when the underlying processes are targeting the same bucket. Linking a bucket to a folder makes the bucket available in that folder.

Note:

A bucket linked to multiple folders is marked using the icon. If the icon is not present, then the current folder is the only folder the bucket resides in. Deleting it here completely removes the bucket from Orchestrator.

You need the Storage Buckets - Create permission in the folders where you want to add the bucket (target folders) and Storage Buckets - View in the folder where the bucket currently resides (original folder). If you have Storage Buckets - Edit in the target folder, you also require Storage Buckets - Edit in the original folder.

Linking Multiple Buckets to the Current Folder

  1. In the Storage Buckets page, click Add. Three buttons are displayed allowing you to add a storage bucket, link one from other folders, or hide the options.
  2. Click Link from other folders. The Link Storage Buckets window is displayed showing a list of all buckets in the folders in which you have View permissions on Storage Buckets.
  3. On the Select Storage Buckets section, select one or multiple buckets from the list.


  4. Click Continue. You are directed to the Folder Validation section. Here you can see the folders the buckets are already linked to. If there are multiple folders, their names are displayed.


  5. Click Remove for the corresponding bucket to revert the change or click Exit to cancel the operation.
  6. Click Link if you want to make the link between the bucket you selected and the current folder. The buckets are displayed on the Storage Buckets page.


Linking a Bucket to Multiple Folders

  1. Navigate to a folder the bucket to be linked resides in or is linked to.
  2. Click More Actions > Manage Links for the desired bucket to open the Manage Links window. The Manage Bucket Links window is displayed.
    1 - Left-hand pane displaying all the folders you have been granted Viewpermissions on Storage Buckets. 2 - The current state of the bucket displaying the number of folders it currently resides in as well as their names. 3 - The folders the bucket is to be added in according to your selection in the left-hand pane. 4 - The folders the bucket will be removed from.

  3. Click Update. A confirmation window is displayed.
  4. Click Cancel if you want to abort the changes or Continue for the changes to take effect. The operations are now reflected in Orchestrator according to your changes.

Unlinking Buckets From Folders

Unlinking buckets from folders can be performed in a manner similar to the linking operation. Navigate to the link-management areas presented in the procedures above and remove the connections between a certain bucket and a certain folder.

Alternatively, you can remove a bucket using the Delete functionality. See Deleting a Bucket.

Important: Removing a bucket that exists in multiple folders only removes it from the folder where the removal operation takes place, it does not remove it from the other folders as well. In order to completely delete a bucket, you must remove all its existing links.

Searching for Files Within a Storage Bucket

The file search option within storage buckets is based on file globbing, which means that you need to use wildcards to find a desired file. This is detailed in the topic dedicated to the List Storage Files activity, but you can also check out the example below for some common use cases.

Example

Suppose you have a storage bucket containing the following files:



  • If you want to search for all files with a certain extension, such as .jpg files, you need to enter the following in the Search field: *.jpg.
    The search results will be doc1.jpg and doc2.jpg.
  • If you want to search for a file whose name contains a certain character or character sequence, such as voi, you need to enter the following in the Search field: *voi*.
    The search result will be invoice1.pdf.
  • If you want to search for a file whose name begins with a certain character or character sequence, such as u, you need to enter the following in the Search field: u*.
    The search result will be uipath.png.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.