Admin Guide
To access a bucket/Folder in the archival module, you'll need to use the roles mentioned below.
| Permissions | Roles | |||
|---|---|---|---|---|
| Archival Viewer | Archival User | Folder Admin | Archival Super User | |
| View Folder | ✔ | ✔ | ✔ | ✔ |
| View Files | ✔ | ✔ | ✔ | |
| View Metadata | ✔ | ✔ | ✔ | ✔ |
| Create Folder | ✔ | ✔ | ||
| Manage Metadata | ✔ | ✔ | ✔ | |
| Restore Folder | ✔ | |||
| Legal Hold | ✔ | |||
| Upload Files | ✔ | |||
| View Files Version History | ✔ | ✔ | ✔ | |
| View File Audit | ✔ | ✔ | ✔ | |
| View Folder Audit | ✔ | ✔ | ✔ | ✔ |
| Assign Archival Roles | ✔ | |||
Bucket Registration
This section provides details on registering a bucket in the LDAS archival system. To begin the bucket registration process, ensure that the bucket is created in Minio/S3
Users can register the bucket in the LDAS archival system using a session token. The authentication API will provide an access token, which will be used by the user to access the API.
Bucket Registration API
Below is the sample input to register the bucket:
| URL | <LDAS-DNS>/api/explorer/bucket/register |
| Method | POST |
| Authorization | <The bearer token from the authorization endpoint> |
| Request Parameters | |
|---|---|
| bucketName | The name for the bucket that is going to get registered in LDAS. |
| typeOfStorage | The value can be primary or secondary. |
| endpoint | The value is URL to access MinIO/S3 bucket. |
| accessKey | Access key to connect to the endpoint. Should be AES encoded. |
| secretKey | Secret key to connect to endpoint. Should be AES encoded. |
| metadataPrefix | It can be left as empty string. |
| port | The value is Port of the MinIO. It can be left empty string for S3. |
| isIAMAuth | The value is either true or false. It is true for the buckets created with S3 IAMAuth. |
| region | The value is region of the S3 IAMAuth buckets. |
NOTE
Multiple primary buckets can be created for a single secondary bucket. All folders from the primary buckets are archived to the secondary bucket, and folders from the secondary bucket are restored to their corresponding primary buckets.
The table below provides the different response codes, along with the reasons for failure and the expected messages associated with each code.
| Response code | Reason | Message |
|---|---|---|
| 200 | Bucket registered | Registered successfully |
| 400 | Required request params are not provided | Invalid input: Please enter valid input |
| 400 | Storage type value other than primary/secondary | Invalid type of storage. Enter valid storage type |
| 400 | Registering the bucket name which already exists | Bucket already registered |
| 404 | Bucket not created in MinIO/S3 | Bucket does not exist |
| 500 | Invalid endpoint / accessKey / secretKey / region | Error occurred while connecting to bucket |
| 500 | Internal server Error | "An unexpected error occurred. Please contact System Administrator " |
Access to File/Folders
Roles can be assigned to folders in primary storage by Folder Admin. When a role is assigned to a folder, the corresponding permissions apply to all child folders, regardless of their state or location (primary/secondary). Similarly, if a permission is removed from the parent folder, it will be removed from all child folders, regardless of their state or location.
File and Folder Configuration
Create Folder
- To create a folder, you must have 'Folder Admin' or 'Archival Super User' privileges.
- Navigate to the location in primary storage where you want to create a new folder. Then, use the menu option and select New Folder to create the folder.
NOTE
Once a folder is created, its name cannot be edited.
Creating a new folder in primary storage
NOTE
The folder path cannot exceed 1024 characters due to limitations set by Object Storage (S3/Minio). For example, if a folder path such as Folder1/Folder2/Folder3/.../Folder113/ reaches this limit, no additional folders can be created under Folder113, and files cannot be uploaded to Folder113.
- For the Folder Name, ensure that the name complies with the naming restrictions. Specify valid End Date, Archival Period, and Retention Period to determine the folder's phases.
NOTE
If no archival policy values are specified for a folder, it will inherit the archival policy from its parent folder. If no archival policy is defined for any of its parent folders, archival and retention actions will not be applied, allowing the folder to be retained indefinitely in primary storage.
- Define the metadata keys and their corresponding values for the folder in the User Defined section.
Entering folder properties during folder creation
- Click the Create button to complete the process. Upon successful folder creation, a confirmation message will be displayed.
NOTE
In the left navigation panel (folder tree), you can view the first 50 folders at each level. To see all files and folders within a folder, navigate to the file explorer page.
Naming Restrictions
- Folder names should be no longer than 246 characters.
- The characters ., /, :, , and % are not allowed in folder names.
Updated 5 days ago