› Workflow › Business processes › Design a basic process › Add an activity › Activity types › Microsoft activities › Azure blob storage export activity › Configure Azure blob storage export activity

Configure Azure blob storage export activity

Use the following procedure to configure a process, case, case fragment, business rule, or custom service to add an Azure blob storage export activity.
  1. Add an activity to the map.

    By default, the Configuration tab is open in the properties panel of the activity.

  2. Change the default Name of the activity to something meaningful.
  3. On the Type list, select Microsoft > Azure blob storage export.
  4. Configure the following properties.
    Azure storage

    The name of the Microsoft Azure storage that is configured for blobs in TotalAgility Integration.

    The Azure storage integration name must be the same in the importing and exporting machines; otherwise, an error occurs.

    Input source

    The location from where the files are exported. Select a process/server variable as an input source.

    The variable can be a String, Data object, Document, Folder, Nullable string, or XML. However, for the Document type variable, you must select a MIME type.

    If the input source is a Folder variable, the "Export as" and "Field data format" properties become available.

    Container name

    The name of the container to which the files are exported. The name can be a dynamic variable (process/server) or a static value.

    Export as

    Export the files as a Folder (default) or Individual documents when the input source is a folder variable.

    Field data format

    A blob to be created for the field data in either format:

    • CSV (default): Creates a CSV file with extracted fields.

    • JSON: Creates a JSON file with extracted fields and raw OCR results.

    File format

    Select the file format for the JSON field data:

    • Merged file containing all documents (default): Multiple individual documents are consolidated into one comprehensive file.

    • Separate file for each document: Each document is kept in its own individual file.

    The "File format" property is only available if the "Export as" property is set to "Folder" and "Field data format" is "JSON".

    Blob name

    Optional. A String variable that holds the name of the blob.

    If a folder variable is used as the input source and "Export as" property is set to individual documents, on the Blob name list, select Document ID or Filename (default).

    If blob already exists

    Select what must be done if a blob already exists (same file name) in the container.

    • Overwrite (default): Overwrites the existing blob.

    • Rename: Renames the latest blob by adding current timestamp to the end of the existing name.

    • Suspend job: Suspends the job.

    Metadata

    Metadata is a pair of key-value character strings. You can set metadata to store additional information for the blobs. The key and value fields support dynamic (process/server variables) or static types.

    To add a metadata, perform the following procedure.

    1. Click .

    2. In the Key box, enter a name for the key.

    3. In the Value box, enter a value for the value.

    4. Click Add.

    5. Add more metadata as needed.

    To edit a metadata, click and modify the required fields.

    To delete a metadata, click .

    Index tags

    Blob index tags categorize data in a storage account using key-value tag attributes.

    These tags are exposed as a searchable multi-dimensional index to find data within a single container or all containers in a storage account.

    The key and value fields within an index tag are case-sensitive character strings that support dynamic (process/server variables) or static values. If numbers, dates, times, or special characters are used, they are saved as strings.

    An index tag can include the following characters:

    • Lowercase letters (a-z)

    • Uppercase letters (A-Z)

    • Digits (0-9)

    • Space (" ")

    • Special characters ("+", "-", ".", "/", ":", "=", and "_")

    When exporting blobs to Azure blob storage, you can add index tags to the blobs, so that the blobs can be searched based on the tags.

    To add an index tag, perform the following procedure.

    1. Click .

    2. In the Key field, enter a name for the key.

      The maximum length of the key is 128 characters.

    3. In the Value field, enter a value for the key.

      The maximum length of the value is 256 characters.

    4. Click Add.

    5. Add more index tags as needed. You can add a maximum of 10 tags for a blob.

    To edit an index tag, click and modify the required fields.

    To delete an index tag, click .

    Blob URL

    A String variable used to store the path to the new blob that is returned.

  5. Click Save.

    At runtime, the following things happen when this activity is processed:

    • Separate blobs are created for different types of variables.

      Folder or Document variable String, Nullable string, Data object, or XML variable

      A new blob is created as a ZIP ​ with the exported contents that includes:

      • Documents folder: Contains the image file or PDF of each document. The file name is the ID of the document.

      • FieldData folder: Contains a CSV in which a row is maintained for each document type with the document ID and the field/value pairs.

      • Content_types.xml file: Contains a list of the file types available in the ZIP.

      • String or Nullable string: A new blob is created with the .txt extension and contains data Text format.
      • Data object: A new blob is created with the .json extension and contains data in JSON format.
      • XML: A new blob is created with the .xml extension and contains data in XML format.

      ZIP is exported as a blob to the configured container.

      The file is exported as a blob to the configured container.

      The blob name is based on the variable and defaults to Job_jobid.zip.

      The blob name is based on the variable and defaults to Job_jobid.txt (String/Nullable string), Job_jobid.json (Data object), or Job_jobid.xml (XML).

    • If a blob with the same name already exists, the file is overwritten or renamed, or the job is suspended depending on the design time setting.

    • Index tags and metadata specified are applied to every blob that is created.

    • The URL of the newly created blob is returned as a unique path to the container where the blobs are added.

    • A blob is created in the container for each document in the folder. A blob for field data is created in either JSON or CSV format.

    • The blob name for each document should be the filename or the document ID, as specified. The blob name for the field data should be the same but with a different extension.