README.md

Azure Blob Storage

Azure Blob Storage is a cloud-based object storage service provided by Microsoft Azure. It allows you to store large amounts of unstructured data, such as images, videos, and documents, in a scalable and cost-effective manner. Data is stored in containers within a storage account, and it can be accessed via HTTP/HTTPS, making it ideal for the integration in your Axon Ivy Business processes.

This connector:

• Supports you in implementing access to Azure Blob Storage.
• Supports you in uploading content to your Azure Blob Storage - directly from an Axon Ivy business process.
• Creates a download link with an expiry date.

Demo

Run local with Azurite Docker image

Start docker to test Azure Blob Storage locally.

Pull Azurite V3 docker image and run it

Note. Find more docker images tags in https://mcr.microsoft.com/v2/azure-storage/azurite/tags/list

docker pull mcr.microsoft.com/azure-storage/azurite

docker run -p 10000:10000 -p 10001:10001 -p 10002:10002 mcr.microsoft.com/azure-storage/azurite

-p 10000:10000 will expose blob service's default listening port.
-p 10001:10001 will expose queue service's default listening port.
-p 10002:10002 will expose table service's default listening port.

Installation with docker compose

Run at root folder of the project:

make app_local_compose_up

For other ways, check DockerHub

How to explorer the data?

• Install https://azure.microsoft.com/en-us/products/storage/storage-explorer
• Setup to access it

Further information can also be found at the Storage Explorer

Provide an account name and account key in variables.yaml with Well Known Storage Account And Key

StorageAccountAndKey

Setup

In the project, you only add the dependency in your pom.xml and call public APIs

1. Add dependency

	<dependency>
		<groupId>com.axonivy.connector</groupId>
		<artifactId>azure-blob-connector</artifactId>
		<version>${process.analyzer.version}</version>
	</dependency>

2. Azure Blob connection in variables

You need to provide Azure Blob connection in variables.yaml. Below is an example for connect by client secret

Variables:
  AzureBlob:
    # The application ID that's assigned to your app.
    ClientId: ''
    # The client secret that you generated for your app in the app registration portal.
    ClientSecret: ''
    # The directory tenant the application plans to operate against, in GUID or domain-name format.
    TenantId: ''
    # https://<storage-account>.blob.core.windows.net/
    EndPoint: ''
    # Your container name.
    ContainterName: ''

For Process GUI

1. What is supported in BlobStorage Callable Sub Process?

2. How to call an event from BlobStorage Callable Sub Process?

• From the "Extensions"-Menue in the Tool Bar, we can now see a BlobStorage element

• We can draw a process with uploadFromUrl selection and field some information like: external url, blob name, the directory on Azure Blob Container, ..

For Java Developer

1. Call the constructor to set some basic information. Each instance of the advanced process analyzer should care about one specific process model. This way we can store some private information (e.g. simplified model) in the instance and reuse it for different calculations on this object.

	/** 
	 * @param process - The process that should be analyzed.	 
	 */
	public AzureBlobStorageService(BlobServiceClient blobServiceClient, String container)

2. Application requests to Azure Blob Storage must be authorized. You must to create a BlobServiceClient.

• This credential authenticates the created service principal through its client secret

	/**
	 *  Create client to a storage account. 
	 * @param clientId - the client ID of the application
	 * @param clientSecret - the secret value of the Microsoft Entra application.
	 * @param tenantId - the tenant ID of the application.
	 * @param endpoint - URL of the service
	 * @return a {@link BlobServiceClient} created from the configurations in this builder
	 */
	public static BlobServiceClient getBlobServiceClient(String clientId, String clientSecret, String tenantId, String endpoint) {}

• This credential authenticates the created service principal through its connection string

	/**
	 * Create client to a storage account. 
	 * @param connectionString - connection string of the storage account
	 * @param endpoint - URL of the service
	 * @return  a {@link BlobServiceClient} created from the configurations in this builder
	 */
	public static BlobServiceClient getBlobServiceClient(String connectionString, String endpoint) {

• This credential authenticates the created service principal through its account and key.

	/**
	 * * Create client to a storage account. 
	 * @param accountName The account name associated with the request.
     * @param accountKey The account access key used to authenticate the request.
	 * @param endpoint - URL of the service
	 * @return  a {@link BlobServiceClient} created from the configurations in this builder
	 */
	public static BlobServiceClient getBlobServiceClient(String accountName, String accountKey, String endpoint) {}

3. You can call uploadFromUrl to upload a file from url, getDownloadLink to get download link of a blob.

	/**
	 * The API to copy operation from a source object URL
	 * @param url - The source URL to upload from
	 * @return - The blob name
	 */
	public String uploadFromUrl(String url);
	
	/**
	 * The API to create a temporary download link with expired time 
	 * @param url - The blob name
	 * @return - The url for download
	 */
	public String getDownloadLink(String blobName);

Example

Below is a simple example for upload a file from url and get temporary download link.

	BlobServiceClient blobServiceClient = BlobServiceClientHelper.getBlobServiceClient(CLIENT_ID, SECRET_VALUE,TENANT_ID, END_POINT);
	StorageService storageService = new AzureBlobStorageService(blobServiceClient, TEST_CONTAINTER);

	// Upload file from url
	String blobName = storageService.uploadFromUrl("https://sample.com/video.mp4");
	// Get temporary download link
	String downloadLink = storageService.getDownloadLink(blobName);