STAR
Straatos Archive and Retrieval Services
Overview
STAR or 'Straatos Archive and Retrieval' Service tasks allows you to store the documents, index fields and comments into an Azure Storage account and an Azure Cognitive Search Index. This solution can be used for long term Archival and Retrieval.
Configuration
In a workflow, add a Service Task to the workflow and select 'Straatos Archive' in the Action setting.
.png?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9kemY4dnF2MjRlcWhnLmNsb3VkZnJvbnQubmV0L3VzZXJmaWxlcy8zMzg1LzUwNDYvY2tmaW5kZXIvaW1hZ2VzL3F1L2ltYWdlKDE4MCkucG5nIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoxNzY1ODYwMDAzfX19XX0_&Signature=busBXIELfsCwx68LqTqnS4yMm76DQFdkemki~aWBjfD4u7kaEJ7wCiNUOXncq8OTFaKRv91lRSHesMrrqvcihcHtDMM9t1JTBG-iuSoCU3ZrExegSj~yOAJ-4bwrxZfOoTO7S4XYEbueyjvBrk4HOegOSS5SxlzegLn2MxNadp8~obhUKcT071hWyOWXyIck~JjMwZ2O~BF37EO64mu2tDucOE0uP5htAa1iQT82HoqSGrklInEJRv6xQ5Tnc37yvsuq2PnTFufWV-M~vDsXVnzf4XUd5Ys0oWppUJqpj9lkLIES-ZIxRQLWA6xQVZqc8OHbRRA2Sq3r7c1lTvcZCA__&Key-Pair-Id=K2TK3EG287XSFC)
In the section 'Authentication'- 'Roles' create a new role that can be used by the Archive service.
Bring your own Azure Resources
By default, the Archive is stored in CumulusPro's Storage account and the content is made available through our TaskUI and a retrieval API.
Alternatively, you can use your own Azure Resources to store the content. The benefits are those are in your Azure environment and you have full control of the data, including configuring your backup and high availability.
Configure your Azure Storage Account
- Set 'Use your own Azure Resources'to 'On
.png?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9kemY4dnF2MjRlcWhnLmNsb3VkZnJvbnQubmV0L3VzZXJmaWxlcy8zMzg1LzUwNDYvY2tmaW5kZXIvaW1hZ2VzL3F1L2ltYWdlKDE4MSkucG5nIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoxNzY1ODYwMDAzfX19XX0_&Signature=MX0kSaELcb9SENQUpWcWoSZuOElwxjzF7EeR8-T8wrBmCgIPcGX5OPa6iMcL5GTMTve~9Sn4SWqEtEGUQtDHa2XC1JhPETHOrFIzk8YW8vzrR1y9G3xpxwVsszhHzTRTLMdVgMXsd--iMtn7uA8txyae7mEiTlkLq~N2eu7W0UHfexCuHEmUrnQd64XPzR2iob2IIAM7BAzQAo1C~h6cd3VYJgEA5e1YWbodXgQRH0WVZCtMSLq6EsQFp7GEC1yXYUbv-Yaxo9AtUsBAz7olojYfsL0goDI7ONwEKKdosPgonuZsaExwcVuJNRWh-hMMkTy65DQRiC65~w4OAdLzIg__&Key-Pair-Id=K2TK3EG287XSFC)
- Get your Azure Storage connection string and paste it into the field 'Azure Storage connection string'. Note, the connection string will not be displayed in the UI for security reasons. The connection string will be securely stored in Straatos. At any time you change your connection string (refresh key) you will need to copy/paste the connection string inside here. For more details on where to find the Storage string in Azure, see the section below 'Configuration of Storage Account'.
.png?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9kemY4dnF2MjRlcWhnLmNsb3VkZnJvbnQubmV0L3VzZXJmaWxlcy8zMzg1LzUwNDYvY2tmaW5kZXIvaW1hZ2VzL3F1L2ltYWdlKDE4MikucG5nIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoxNzY1ODYwMDAzfX19XX0_&Signature=TTjVWq3yPcuuxL9778X9zSu4kek68HsqD~52-xgGiZltk4DCUQvPeLTiwxP5OxGkHYVhAzKST3Utek62bVY7~czlKvPJzeUt0fCvNnCy87oYH9ouG9y2QmvBAsq-mEBWMZVcMz9dqctTesxxON-armLiLdgZ5amG0-FM1b7hOpn-ou3hx4TJmPRlkY7npKQTLpuIxk1sf6E9DPrOWhISj6n0tUZYROhiv7TtoNvRyIaDNCbzBmPme0eTzAc86GzwpEHJJ696uw1OD1ABNerWcNJ0JYXsFUa0HiJjKQK3KHPJcLBABv0C22tlWpAF1~qW3PvfT1y-VIGNDdV5nQ09SA__&Key-Pair-Id=K2TK3EG287XSFC)
- Data are stored in 4 different locations:
- Azure Blob Storage (folder 'search-archive-files'): The document files for the tasks. Both the original document and all additional data files will be stored.
- Azure Blob Storage (OPTIONAL): If the option 'Store as (JSON) BLOB'is set to 'On' a json file that contains the index field values, information about the task, the comments and links to the files are stored in the BLOB storage in folder 'search-archive-json'. This can be used to ingest into another backend system or can be used to (re)build an Azore Cognitive Search index.
- Table Storage (OPTIONAL): If the option 'Store in table storage' is set to 'On, then the index fields, comments and links to the files are stored in Azure Storage Table. This is ideal for some backends that need a SQL table to access the data, for example, BI tools such as PowerBI.
- Azure Cognitive Search (OPTIONAL): If the index URI, Index Name and Index Admin Key are saved, then the defined Azure Cognitive Search is populated with the index data giving a real-time search capability of the archived documents.
Configuration of Storage Account
- Go to your Azure Portal and open your Storage account.
- In the menu on the left, select 'Access Key'
- Click on 'Show keys' in the menu
- Copy the connection string (either from key1 or key 2)
.png?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9kemY4dnF2MjRlcWhnLmNsb3VkZnJvbnQubmV0L3VzZXJmaWxlcy8zMzg1LzUwNDYvY2tmaW5kZXIvaW1hZ2VzL3F1L2ltYWdlKDE3NykucG5nIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoxNzY1ODYwMDAzfX19XX0_&Signature=eHraTDs-5FHJhpPBUnOXS4E-KVoXRn0oWryI-szgjnetW8LHYW4wnzr2Qc4ewAs1rSNhtcJyTxYmZ7-eYxxlyQRw9a6ezyb-m3ByxQ0W1DGDUg15EXY9ro1pl-FV2tE476h9v1BGbLzD3Sx0~NfQqFvDnv5Ew6bUTeCZV9rrS8Pj47jsr1L71nOww0KsadT~z2oCExVCqZge4Mom3Gz-wtV6U~ZvyuriM5uq9ELcbyiI5y3U5HnZ3HM19Cawfjp4YM~kaXFZ3SCuSq~iT6T~pgBnG90w42dKQH96KZX0~DkkiqHP2-v7nLIQxne7fKDXv3Vxfs5BOlnqvBrdMJT5Lg__&Key-Pair-Id=K2TK3EG287XSFC)
- Copy this connection string into the field 'Azure Storage Connection String'
- Based on your requirements, the 'Store in table storage' and 'Store as (JSON) BLOB'can be set to On or Off.
- After saving the Connection String, closing the 'Straatos Archive' settings pop up in the Adminpanel and reopening the settings, the field 'Azure Storage Account Name (display only)' will contain the name of the Azure Storage Account. This is for your reference to know to which storage account this is linked.
Configuration of Azure Cognitive Search
- Login to Azure portal and select the Search service
- In the 'Overview'menu, copy the Url and paste it into the 'Azure Search Index URL' in the adminpanel
.png?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9kemY4dnF2MjRlcWhnLmNsb3VkZnJvbnQubmV0L3VzZXJmaWxlcy8zMzg1LzUwNDYvY2tmaW5kZXIvaW1hZ2VzL3F1L2ltYWdlKDE3OSkucG5nIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoxNzY1ODYwMDAzfX19XX0_&Signature=Ta9fcdRJUs19Qgrj~Kt8bjOftcbU6nubY5hx3MxScHD3JLacFFtN~ES4qBUgQxQUKdEXpja5-gM9r2nlGR84MqSkU-PoY23wDnJR5W~DI8cx3ZOsMYHPVXHLOKQyXYmkGmLt9d40cMOIbHiYSc~wsrk9Wc9tuxqiToz~ehjJ6GUUz3j~bYW1oLh-g42~yTSvjwyy4HDSESlDOnP732wAUmIjQtA0MkLr-w~13uPoB65sIbcn8oGTWNf0ohM7xrEhorP3UHxb6GnJbnPMgSiW5~mWNhtOIHNki828b2E~42reM8dEgISjxvwlLXRGeMGxobsngVKQMgDKIESmf1wpxw__&Key-Pair-Id=K2TK3EG287XSFC)
- in Azure Search service, select Keys and copy either the primary or secondary key admin key.
.png?Policy=eyJTdGF0ZW1lbnQiOlt7IlJlc291cmNlIjoiaHR0cHM6Ly9kemY4dnF2MjRlcWhnLmNsb3VkZnJvbnQubmV0L3VzZXJmaWxlcy8zMzg1LzUwNDYvY2tmaW5kZXIvaW1hZ2VzL3F1L2ltYWdlKDE3OCkucG5nIiwiQ29uZGl0aW9uIjp7IkRhdGVMZXNzVGhhbiI6eyJBV1M6RXBvY2hUaW1lIjoxNzY1ODYwMDAzfX19XX0_&Signature=geuuEb4Qfdgad3ND~z5jOMy1HgLFD0-i6QjqJeIscPFhNrivTpMGvIMg9ZnzoBTu9Qg2nED4I4nOMtv7iiqX3sGYHhOSMc6OoUCIDv7Xrcs4E7w~4xaEHIDxD2NMuwv33NAj4erCfEgAs-vFx3K9MlI8oOvyWzs-SvxuEjOMLLwh2QLoA1NdKTDdrRbfKPG~rXrJ2RgpdsjVZwLYIXF6N8QC9e~xF-NyZjAvwQwt9-qPwh6w-RPS6iNkwRrEd-ncstc5zbFsDPVAebLXUWrx9j59jtfWyo7h53WopWsdsltPWrLNrHYrsohWZ4aV7wLaM9cc7Lt4u8YeTzl5yZJK4Q__&Key-Pair-Id=K2TK3EG287XSFC)
- Add the key to the admin panel field 'Azure Search Index Admin Key'
- In the admin panel, enter a name for the Azure Search Index Name. If the name does not yet exist in Azure Cognitive Search, Straatos will automatically create the index.