Manual for End User

Nodeum builds automatically a catalog of files and folders available across the different reachable storage systems.

The user can easily access any information or data in the storage spaces either if the storage technologies are NAS, S3 or Tape systems.

It allows a fast search and finds, using both embedded files and business metadata.

User Management

The catalog uses the end user access rights to provide an easy and secure self-service portal. Any end user is allowed to manage their data straight through the Nodeum Ecosystem.

Catalog

The catalog allows control and traceability of:

all files stored or managed by Nodeum into workflows orchestration
all files from Primary Storage which are set to inventory by Nodeum. This inventory is required to use the TCO Calculator before using the workflow management.

Through this interface, the user can easily access any information or data on the storage space :

in cache
near line archiving space (Data archiving on tapes)
cold archive (Data Protection on tapes)
cloud and S3 object storage.

It allows for a fast search and find, using both embedded file and business metadata.

Also, this provides an easy and secure way into the infrastructure for the external users or clients.

This can be achieved by utilizing the access rights or as an integration building block for a more elaborate access portal on the front-end.

This can either be setup as self-service or under stricter control, but in either case enables the client to facilitate their sharing of data straight from within the Nodeum infrastructure.

Search bar integration

The search bar is integrated in the catalog, some reports (Data Lifecycle and metadata).

It help you to find easily and faster data.

You have multiple filter to refine the search :

Filter to refine the search
Keywords
From File x size to x size
From Change Date xx to
From Modification Date xx to
From Access Date xx to
Container	Choose a Container from the list
Primary Storage and if needed apply some filters to affine the selection (type of storage, pool..)	Scanned represents the files inventoried but not used by workflow manager Workflow represents the files managed by workflow into Nodeum
Secondary Storage and if needed apply some filters to affine the selection (type of storage, pool..)
Path	complete the full path of the file
all levels	Only for the path, you see all files and folders

Filter to refine the search

Keywords

From File x size to x size

From Change Date xx to

From Modification Date xx to

From Access Date xx to

Container

Choose a Container from the list

Primary Storage and if needed apply some filters to affine the selection (type of storage, pool..)

Scanned represents the files inventoried but not used by workflow manager
Workflow represents the files managed by workflow into Nodeum

Secondary Storage and if needed apply some filters to affine the selection (type of storage, pool..)

Path

complete the full path of the file

all levels

Only for the path, you see all files and folders

But you can also search data with special command :

Property list	Definition
file_id_l	It is the internal file identifier
file_parent_id_l
file_name_s
file_parent_path_s
file_base_name_s
file_extension_s
file_size_l
file_type_i
file_change_dt
file_modification_dt
file_access_dt
file_extern_b
file_in_cache_b
file_in_cache_dt
file_out_cache_dt
user_owner_id_l
user_can_read_b
user_can_write_b
user_can_execute_b
group_owner_id_l
group_can_read_b
group_can_write_b
group_can_execute_b
other_can_read_b
other_can_write_b
other_can_execute_b
on_primary_pool_b
on_secondary_pool_b
prim_id_l
prim_name_s
prim_container_name_s
prim_container_id_l
prim_container_comment_t
prim_pool_name_s
prim_pool_id_l
prim_pool_comment_t
prim_pool_type_i
prim_pool_content_i
prim_nas_share_name_s
prim_nas_share_id_l
prim_nas_name_s
prim_nas_id_l
prim_nas_type_i
prim_nas_comment_t
prim_nas_price_d
prim_cloud_bucket_name_s
prim_cloud_bucket_id_l
prim_cloud_bucket_price_d
prim_cloud_connector_name_s
prim_cloud_connector_id_l
prim_cloud_connector_type_i

Property list

Definition

file_id_l

It is the internal file identifier

file_parent_id_l

file_name_s

file_parent_path_s

file_base_name_s

file_extension_s

file_size_l

file_type_i

file_change_dt

file_modification_dt

file_access_dt

file_extern_b

file_in_cache_b

file_in_cache_dt

file_out_cache_dt

user_owner_id_l

user_can_read_b

user_can_write_b

user_can_execute_b

group_owner_id_l

group_can_read_b

group_can_write_b

group_can_execute_b

other_can_read_b

other_can_write_b

other_can_execute_b

on_primary_pool_b

on_secondary_pool_b

prim_id_l

prim_name_s

prim_container_name_s

prim_container_id_l

prim_container_comment_t

prim_pool_name_s

prim_pool_id_l

prim_pool_comment_t

prim_pool_type_i

prim_pool_content_i

prim_nas_share_name_s

prim_nas_share_id_l

prim_nas_name_s

prim_nas_id_l

prim_nas_type_i

prim_nas_comment_t

prim_nas_price_d

prim_cloud_bucket_name_s

prim_cloud_bucket_id_l

prim_cloud_bucket_price_d

prim_cloud_connector_name_s

prim_cloud_connector_id_l

prim_cloud_connector_type_i

This information create command in the search that you can complete manually after choosing filter(s).

Example of Command to afine the keysearch :

* file_name:test

* to get only folder : file_type:0

* to get only files : file_type:1 to get only files

* Checking if file or folder are in cache : file_in_cache:1

* Checking if files or folder are not in cache : file_in_cache:0

Data Lifecycle Information

When opening a tile, all details about the file is available including its lifecycle. This display the different processed copies.

Information Description

Value	Description
Path	Path of the folder or file
Creation Date	Creation date of Files or Folder Place of Store (Primary Storage and its name)
Last Modification Date	Last modification date of files or folfer and its size
Type of Task (Offline , active Copy/move)	Ex. : it is the date of last offline copy done You can see the following details : Target where the data are stored for NAS/Cloud backup Volume if the file/Folder is store on Tape Pool Name Rule : name of task runned
In cache	The file or folder are save in Active archive workflows. The data is in cache save on a specfic container. The user can open the files/Folder directly and bring modification.

Value

Description

Path

Path of the folder or file

Creation Date

Creation date of Files or Folder
Place of Store (Primary Storage and its name)

Last Modification Date

Last modification date of files or folfer and its size

Type of Task (Offline , active Copy/move)

Ex. : it is the date of last offline copy done

You can see the following details :

Target where the data are stored for NAS/Cloud backup
Volume if the file/Folder is store on Tape
Pool Name
Rule : name of task runned

In cache

The file or folder are save in Active archive workflows.

The data is in cache save on a specfic container. The user can open the files/Folder directly and bring modification.

Task Filtering

Each workflow task allows for the configuration of various filtering options. There are two available modes for filter configuration:

Basic
Advanced

Basic Mode

This mode includes the capability to define expressions directly in the Console based on the following types:

Type of Filter	Operator	Description
Creation Date	Older Than Earlier Than Before After	Filter the selection on when the file has been created. It allows to select only files that have been created before or after a specific date.
File Name	Matches Doesn't Match	It allows to filter the selection based on the name of the file. Examples : '.' for any type of character '' from 0 to infinite Regex expressions are also supported.*
File extension	Equal Doesn't Match	It allows to filter your selection based on the file extension. File extension name has to be defined. Example: pdf
File Path	Matches Doesn't Match	It allows to filter your selection based on the folder(s) path. Regex expressions are also supported.
Last access date	Older Than Earlier Than Before After	Same but with a trigger on when the file has been accessed for the last time.
Last modification date	Older Than Earlier Than Before After	Filter the selection on when the file has been modified for the last time. It allows to select only files that have been modified before or after a specific date.
Size	More than Less than	Filter the file selection based on the files size

Type of Filter

Operator

Description

Creation Date

Older Than Earlier Than Before After

Filter the selection on when the file has been created.

It allows to select only files that have been created before or after a specific date.

File Name

Matches Doesn't Match

It allows to filter the selection based on the name of the file.

Examples : '.' for any type of character '*' from 0 to infinite

Regex expressions are also supported.

File extension

Equal Doesn't Match

It allows to filter your selection based on the file extension.

File extension name has to be defined. Example: pdf

File Path

Matches Doesn't Match

It allows to filter your selection based on the folder(s) path.

Regex expressions are also supported.

Last access date

Older Than Earlier Than Before After

Same but with a trigger on when the file has been accessed for the last time.

Last modification date

Older Than Earlier Than Before After

Filter the selection on when the file has been modified for the last time.

It allows to select only files that have been modified before or after a specific date.

Size

More than Less than

Filter the file selection based on the files size

Advanced Mode

This mode allows the usage of an online scripting editor to define advances filter which cannot be defined in using the simple graphical mode.

The scripting Language is "LUA" , which a known language , with online documentation available.

The scripting language supports :

Logical Operator such as 'and' , 'or'
Defined Functions

Example of a LUA script

--[[
This function is auto-generated.
By editing it, you might lose your filter configuration
when going back to "Basic" mode
--]]
function test ( file )
return
       filter_size(file, ">", 2344000)
       or
       filter_name(file, "\\b(\\w*archive\\w*)\\b")
       or
       filter_path(file, "\\b(\\w*archive\\w*)\\b")
       or
       filter_relative_date(file, "C", ">", 20, "D")
       or
       filter_relative_date(file, "M", ">", 20, "D")
       or
       filter_relative_date(file, "A", "<", 20, "D")
end

Standard filtering methods are available :

Filtering by the size of the file

Example of LUA code

...
filter_size(file, ">", 2344000)
..

Result	The workflow will only process files with a size which is bigger than 234000KB
file	Match the process file
">"	Comparison symbol
234000	File size

Result

The workflow will only process files with a size which is bigger than 234000KB

file

Match the process file

">"

Comparison symbol

234000

File size

Filtering by the name of the file

Example of LUA code

...
filter_path(file, "\\b(\\w*archive\\w*)\\b")
..

Results

The workflow will only process files which are located in folder with a name which contains "archive"

file

Match the process file

"\\b(\\w*archive\\w*)\\b"

Regex expression

Filtering by the creation date

Example of LUA code

...
filter_relative_date(file, "C", ">", 20, "D")
...

Result

The workflow will only process files with a creation date older or earlier than

file

Match the process file

"C"

Relative to the Creation Date

">"

">", "<" are available for (older than, earlier than)

Number of Year, Month, Day, Hour, Minute, Second

"D"

"Y", "M", "D", "H", "M", "S" are available for (Year, Month, Day, Hour, Minute, Second)

Filtering by the modification date

Example of LUA code

...
filter_relative_date(file, "C", ">", 20, "M")
...

Result

The workflow will only process files with an access date older or earlier than

file

Match the process file

"C"

Relative to the Last Access Date

">"

">", "<" are available for (older than, earlier than)

Number of Year, Month, Day, Hour, Minute, Second

"D"

"Y", "M", "D", "H", "M", "S" are available for (Year, Month, Day, Hour, Minute, Second)

Some addition information which can be helpful for using the feature :

LUA WebSite : https://www.lua.org/
LUA Online Script validation https://www.tutorialspoint.com/execute_lua_online.php
REGEX Online validation : https://regexr.com/

Last updated 3 months ago