Primeur Online Docs
Data Mover 1.20
Data Mover 1.20
  • 🚀GETTING STARTED
    • What is Primeur Data Mover
    • Main features of Primeur Data Mover
    • Primeur Data Mover deployment
    • Navigate through Primeur Data Mover
  • 👥Actors
    • Who are the actors
    • Create your first actor
    • Configure an actor 🚀
      • Users Tab
      • Groups Tab
      • VFS Tab
      • File Resource Tab
      • Connection Contract Tab
      • Client Connections Tab
    • Search files by actor
    • Actor Lineage 🚀
      • Aggregation of flows by protocol 🚀
      • Lineage with connection contracts 🚀
      • Lineage with input, mediation and output contracts 🚀
      • Lineage with any contract type 🚀
  • 📝Contracts
    • What is a contract
    • Create your first contract
      • Create an Input Contract
        • Define the contract info
        • Associate the contract with the actor
        • Define the contract actions
        • Set the contract variables
      • Create a Mediation Contract
      • Create an Output Contract
      • Create a Connection Contract
        • Create a contract clause
        • Associate the VFS with file processing rules
        • File Processing Rules
    • Managing contracts 🚀
  • 🧱Workflows
    • What is a workflow
    • Create your first workflow template
    • Trigger types
      • Trigger types for input contracts
      • Trigger types for mediation and output contracts
    • Service tasks
      • Standard service tasks
      • Triggerable service tasks 🚀
      • Spazio selectors and filebox metadata management
      • Error management
    • Variables
      • Variables in workflows and contracts
      • Handling process variables
    • Workflow templates
      • System workflow templates
        • Workflow templates for input contracts
        • Workflow templates for mediation contracts
        • Workflow templates for output contracts
      • Custom workflow templates
        • Workflow template toolbar
        • Workflow template Shape repository panel
        • Workflow template working area
        • Workflow template BPMN-diagram panel
      • Error workflow templates
    • Editing workflow templates
    • DataFlow Instance Context (DFIC) 🚀
  • 🔓Security
    • Identity and Access Management
    • Users & Groups
      • Setting the password policy
      • Creating Internal Users 🚀
      • Creating Internal Groups
      • Creating External Users
      • Creating External Groups
    • Key Stores and Trust Stores
      • Key Store 🚀
        • Creating a Key 🚀
        • Creating a Certificate 🚀
        • Importing a Key or a Certificate
        • Creating a Symmetric key
        • Examples
      • Trust Store 🚀
        • Importing Keys 🚀
        • Importing Certificates
      • Untrusted Cache 🚀
      • Trusting an element
        • When do I use the Keys tab?
        • When do I use the Certificates tab?
      • PGP Key Store / PGP Trust Store
        • Configuring the PGP Key Store
        • Importing keys into the PGP Trust Store
  • 🛸TRANSPORT PROTOCOLS AND CONNECTORS
    • Data Mover client and server roles
    • Client Connections
      • Client Connection: FTP
      • Client Connection: FTPS
      • Client Connection: SFTP
      • Client Connection: HTTP
      • Client Connection: HTTPS
      • Client Connection: PESIT
      • Client Connection: SMB v3 or later versions
      • Client Connection: POP3 IMAP
      • Client Connection: SMTP
      • Client Connection: PR4/PR4S
      • Client Connection: PR5
      • Client Connection: PR5S
      • Client Connection: HDFS
      • Client Connection: HDFSS
      • Client Connection: Amazon S3 🚀
      • Client Connection: Google Cloud Storage
        • Credentials
      • Client Connection: Azure Blob Storage
      • Client Connection: IBM Sterling Connect:Direct
      • Appendix
    • Server Connections 🚀
      • Server Connection: FTP
      • Server Connection: FTPS
      • Server Connection: SFTP
      • Server Connection: HTTP
      • Server Connection: HTTPS
      • Server Connection: PeSIT
      • Server Connection: PR4
      • Server Connection: PR5
      • Server Connection: PR5S 🚀
      • Server Connection: IBM Sterling Connect:Direct
    • Stopping all servers in one go
  • 🛰️DMZ GATEWAYS
    • DMZ Gateways
    • DMZ Clusters
  • 🎧FILE EVENT LISTENER
    • What is the File Event Listener
    • Configuring File Event Listeners
      • Setting the File Event Listener Engine
      • Defining a contract for the File Event Listener
      • Setting events to be monitored
    • RegEx Rules 🚀
    • Monitoring File Event Listeners
  • 🔍ICAP
    • ICAP Engines
    • Configuring an ICAP Engine
    • Defining an ICAP rule
  • 📚CLUSTERING
    • STENG, Clusters and Servers
    • Adding a cluster and a STENG
    • Deleting a STENG
  • 🕒MONITORING
    • Jobs
      • Details about Jobs 🚀
      • jobman.sh CLI
    • Job Manager
    • Job Queues
      • Managing Job Queues
    • File Transfers
      • Ongoing
      • Finished
      • Reports
    • File Transfers Rules
      • Configuring Rules
  • 🤓ADMINISTRATION
    • Storage Classes 🚀
      • Storage Class: File System 🚀
      • Storage Class: SMB v3 or later versions 🚀
      • Storage Class: Amazon S3 🚀
      • Storage Class: Google Cloud Storage 🚀
      • Storage Class: Azure Blob Storage 🚀
    • Retention Classes
    • Virtual File Systems (VFS) 🚀
      • Creating a VFS 🚀
      • Configuring a VFS
      • Adding Virtual Paths
      • Modifying and Deleting a VFS
      • Searching files in all VFS
    • File Resources
      • Creating File Resources
      • Navigating File Resources
      • How to use File Resources
    • Advanced Settings
  • 👑FILE MANAGER
    • Getting started
    • Logging into File Manager
    • Managing the File Manager 🚀
      • The list of results
      • Creating new folders
      • Uploading files
      • Downloading files 🚀
      • Searching for files and folders
      • Deleting files 🚀
      • Bulk actions 🚀
    • File Manager and VFS
    • Customizing File Manager externals
      • The configuration-wui.json file 🚀
      • How to customize the Login window and the logo
      • How to customize the footer
      • How to configure the Upload with Metadata option
      • How to customize bulk actions 🚀
  • 🧑‍⚖️FILE ROUTING
    • What is File Routing 🚀
    • Routing Rules page
      • The Rules tab
      • The Categories tab
      • The Output tab
    • How to create a rule 🚀
      • Add metadata 🚀
      • Select ACTIONS
      • Select OUTPUTS
      • Policy for the selection of metadata rules
    • Configuration of the environment in Data One
      • Set up Storage Classes
      • Set up Retention Classes
      • Configure the Actor
      • Set up File Resources
    • Associate the Routing Rule with a Contract
    • Example
  • 💬LOGS & AUDIT
    • Logs 🚀
      • Logs options 🚀
      • Troubleshooting error analysis in Logs
    • Audit Options 🚀
      • Export audit logs 🚀
      • List of Audit entity types 🚀
      • Audit message codes 🚀
    • Log Notifiers 🚀
      • FEL message codes
  • 📩NOTIFICATION CHANNELS
    • What are Notification Channels
    • Configuring the default Email Notification Channel
    • Configuring a new Email Notification Channel
    • Trusting Certificates
    • Managing Templates
      • Data Watcher Macros
      • Contract Macros
      • ICAP Macros
      • Central Log Macros
      • Email Templates
      • Editing default templates
      • Loading a new template
  • 🟣DATA MOVER + DATA WATCHER
    • Data Mover in a bundle with Data Watcher
    • Attributes 🚀
    • Cut-off Board
      • Cut-off Calendars
    • Dataflow Inquiry
  • 🟠DATA MOVER + DATA SHAPER
    • Data Mover in a bundle with Data Shaper
    • Monitoring
    • Execution History
    • Sandboxes
  • 💻API
    • HTTP MFT Rest API
    • Job Manager APIs 🚀
    • SFTP Server sessions APIs 🚀
    • Audit Logs APIs 🚀
  • 🧐HOW TO...
    • ... use different DNS names - NEW! 🚀
    • ... configure a Cron Expression
    • ... configure an Application
    • ... customize a header
    • ... run searches in Data Watcher 🚀
    • ... use Data Shaper graphs in Data Mover contracts
    • ... modify DMCFG and deploy it
    • ... tune Data One data retention
  • 🗒️RELEASE NOTES
    • Data One 1.20.10
    • Data One 1.20.9
    • Data One 1.20.8
    • Data One 1.20.7
      • Data One 1.20.7.1
    • Data One 1.20.6
    • Data One 1.20.5
    • Data One 1.20.4
    • Data One 1.20.3
    • Data One 1.20.2
    • Data One 1.20.1
    • Data One 1.20.0
Powered by GitBook
On this page
  • File Service Registry - Get Metadata
  • File Service Registry - Set Generic Metadata
  • Spazio2 - Insert Selector
  • Spazio2 - Get Selector
  • Spazio2 - Update Selector
  • Example of how the value of a Spazio Selector is read into a variable
  1. Workflows
  2. Service tasks

Spazio selectors and filebox metadata management

There are many service tasks that operate on metadata classes and values. In Filebox, the pattern is usually that metadata classes are like groups. For each metadata class known and stored in a Fileset, there is one or more key/value pairs that contain the proper metadata name and value.

Metadata classes are stored in Filebox as database tables/views where every column is the name of the metadata belonging to that class, and the value as the database value itself.

This behavior is standard and is applied for the following known metadata classes:

  1. "Generic Metadata" [SPFB_FILE_GENERIC_MD]

  2. "eMail Metadata" [SPFB_MAIL_SYS_MD]

  3. "Ghibli System" [SPFB_FILES_SYS_METADATA]

  4. "Spazio2 file" [SPFB_SP2_FILE_SYS_MD]

But that is not the only existing behavior, so additional service tasks are needed. For example, the "Spazio2 selector" [SPFB_SP2_SEL_SYS_MD] metadata class contains all Spazio2 selectors that are written on a Fileset, if the trasport has occurred with Spazio2.

These selectors are not standard. They are stored in a database table or view. However, rather than having a column for each metadata item, the columns have a pattern, and each record contains metadata itself. Therefore, it is more than just a key/value pair.

File Service Registry - Get Metadata

This one operates in a way to let the user get a list of key/value pairs for all the elements stored in a Fileset once the desired metadata class is selected.

This task operates on the following metadata classes:

  1. "Generic Metadata" [SPFB_FILE_GENERIC_MD]

  2. "eMail Metadata" [SPFB_MAIL_SYS_MD]

  3. "Ghibli System" [SPFB_FILES_SYS_METADATA]

  4. "Spazio2 file" [SPFB_SP2_FILE_SYS_MD]

The operator in the flow designer will choose a class and a variable where results will be placed. If nothing more is specified, the resulting variable will be a list of MetaName/MetaValue pairs for all the elements present in that metadata class.

If the operator decides that the flow will return a single value, the "SingleValue" property will be configured with a MetadataName and doing so the resulting variable will only contain the MetaValue, null if not present, for that specific MetaName.

File Service Registry - Set Generic Metadata

This service task stores a Metadata Name and its specified value on a Fileset ONLY for the Generic Metadata Class [SPFB_FILE_GENERIC_MD].

Spazio2 - Insert Selector

This service task will be initialized with a FilesetID like the previous one and then with all the required fields to create a new selector. All the data must be filled in according to Sp2 standards for SEL_CODE possible known values (4100 - 500 - 2010) and so on.

  1. AREA_TYPE

  2. SEL_CODE

  3. SEL_TYPE

  4. SEL_LENGTH

  5. SEL_NAME

  6. SEL_VALUE

Refer to Sp2 official documentation for the possible values on real case scenarios.

Spazio2 - Get Selector

This service task will be initialized with a FilesetID. Since Sp2 selectors are not key/value pairs, the user must also provide the desired Selector Code to obtain its value in the desired output variable. The Selector Code is a mandatory field; the service task will not provide a list of all the selectors set on the Filesetin the output variable, only the value if it exists; otherwise, it will be null.

Spazio2 - Update Selector

This service task will be initialized with a FilesetID and selector code, as the previous one. Next, the Selector Value that needs to be updated is required.

This service task updates values; it will not insert anything if there are no selectors on the fileset with the specified selector code. Therefore, if no selector exists, use the "Insert Selector" instead of the "Update."

Example of how the value of a Spazio Selector is read into a variable

In this example, we are reading a spazio selector value into a variable named "selector" [ Output variable ]. We have to choose a selector code [ Spazio2 Selector code ]: 6200 in this example.

PreviousTriggerable service tasks 🚀NextError management

Last updated 1 day ago

🧱