UNICORE Docs Logo
stable

UNICORE Documentation

  • Overview
    • UNICORE Features
      • Services and APIs
      • Security
      • Clients
      • Add-ons
  • Getting started
    • Using UNICORE
    • Evaluating UNICORE
    • Deploying UNICORE
  • Installing UNICORE for Testing
    • Overview
    • Prerequisites
    • Installation and Configuration
      • Starting UNICORE
    • Testing the installation
    • Reporting bugs
  • How to setup UNICORE for a single HPC cluster
    • Overview
    • Prerequisites
    • Installing the TSI
      • Preparations
      • Download and install the Slurm TSI
    • Installing the UNICORE Gateway and UNICORE/X
      • Preparations
      • Download and extract the UNICORE Server bundle
      • Installing UNICORE Gateway and UNICORE/X
      • Starting the Gateway
    • UNICORE/X configuration
      • Connecting UNICORE/X and TSI
      • Starting UNICORE/X
      • User authentication
      • User account mapping
      • Setting up batch queues
    • Testing
      • Authentication and user mapping
      • Batch queue setup
      • Test job
      • Further testing
    • Server certificate
      • Generating the self-signed certificate
      • Gateway config
      • UNICORE/X config
    • Getting support

User Documentation

  • Introduction
    • Why use UNICORE?
    • What client should you use?
    • Use case: job execution
      • Executing commands via UNICORE
      • Running batch jobs
      • Advanced batch jobs
  • UNICORE Commandline Client
    • UCC Manual
      • Overview
      • Installation and configuration
        • Prerequisites
        • Download
        • Installation and configuration
        • Preferences file
        • Logging
        • Installing UCC extensions
        • Testing the installation
      • Getting started with UCC
        • Getting help
        • Connecting
        • List available sites
        • Running your first job
        • Listing your jobs
        • Job Execution Example
      • Common options to UCC
        • User preferences
        • Configuration file
        • Username and password authentication
        • Support for token based authentication
        • Certificate-based authentication
        • Truststore options
        • Truststore examples
        • Client options
        • Other options
      • Running jobs
        • Introduction
        • Options Overview
        • Resource Selection
        • Processing Jobs Asynchronously
        • Executing a Command
      • Job Description Format
        • Specifying the Execution Site
        • Handling Local Files
      • Data Management Functions
        • Specifying Remote Locations
        • Data movement
        • General commands
        • Finding data
        • Using the StorageFactory service
      • Metadata management functions
        • Basics
        • Available commands
      • Workflows
        • Introduction
        • Command overview
        • Basic use
        • Workflow description format
        • Managing workflow data
        • Resuming a held workflow
      • Batch processing
        • Options
        • Performance tuning options
        • Resource selection in batch mode
      • The UCC shell
        • Changing property settings
        • Running an external command
        • Exiting the shell
      • Sharing resources via ACLs
        • Editing ACLs
        • Permission levels
      • Port forwarding / tunneling
        • Example
        • Level 2: connecting to a service running on a compute node
        • Final notes
      • UCC for site administrators
        • Security considerations
        • Admin commands
        • Listing jobs, sites, …
        • Low-level operations
      • Scripting
        • Script context
        • Examples
      • Frequently asked questions
        • Configuration
        • Usage
    • Building the UCC
      • Prerequisites
      • Building Java code
      • Creating distribution packages
        • tgz
        • deb
        • rpm redhat
  • REST API
    • Basics
      • Base URL
      • Authentication
      • User preferences
      • Security session handling
    • General API features
      • Media types
      • Error handling
      • Paging mechanism, using tags and controlling the output
      • Modifying resource properties
    • REST resources for jobs and data management
      • Synopsis
      • API Summary
      • Site factories
        • Synopsis
        • API Summary
        • Site properties
      • Sites
        • Synopsis
        • Creating a site
        • Site properties
        • Listing jobs
        • API Summary
      • Storages and files
        • Synopsis
        • Listing storages
        • Data upload and download
        • Creating directories
        • Copying and renaming data to the same storage
        • Copying data to another server
        • Files and metadata
        • API Summary
      • Storage factories
        • Synopsis
        • Creating storages
        • API Summary
      • Jobs
        • Synopsis
        • Job description format
        • Data management
        • Starting, aborting or restarting jobs
        • API Summary
        • Job properties
      • Transfers
        • Synopsis
        • API Summary
      • Workflow
        • Synopsis
        • API Summary
        • Workflow submission
        • Workflow description format
        • Workflow properties
        • Hold and resume
    • Utility endpoints
      • Getting the server certificate
      • Creating a token
    • Examples and HowTos
      • Rest API Examples
        • Basic job submission
        • Storages and data management
        • Workflow submission and management
  • Job description format
    • Overview
    • Job elements
      • Job types
      • Specifying the executable or application
      • Arguments and Environment settings
      • Argument sweeps
      • Application parameters
      • Parameter sweeps
      • Pre- and postprocessing
    • Job data management
      • Jobs without client-controlled stage in
      • Importing files into the job workspace
      • Using inline data to import a file into the job workspace
      • Staging in from git
      • Sweeping over a stage-in file
    • Exporting result files from the job workspace
      • Specifying credentials for data staging
    • Redirecting standard input
    • Resources
      • Specifying resources
      • Specifying an accounting project
    • Miscellaneous options
      • Umask
      • Job tags
      • Specifying a URL for receiving notifications
      • Advanced notification settings (UNICORE 9.2.0 and later)
      • Specifying the job name
      • Specifying the user email for batch system notifications
  • Workflow description
    • Introduction
    • Overview and simple constructs
    • Activities
    • Subworkflows
    • Job activities
    • Data handling
    • Transitions and conditions
    • Using workflow variables
    • Loop constructs
      • While and repeat-until loops
      • For-each loop
      • The values element
      • The variables element
      • The file_sets element
      • Indirection
      • Chunking
    • Examples of workflows
      • Simple two-step workflow with data dependency
      • Simple diamond graph
      • Conditional execution in an if-else construct
      • While loop example using workflow variables
      • For-each loop example
  • Data-triggered processing
    • What is data-triggered processing?
    • Setting up data-triggered processing
    • Controlling the scanning process
      • Rules
        • Variables
        • Job action
        • Batched job action
        • Metadata extraction
        • Sending notifications
      • Logging
    • Stopping the processing
    • Example
  • UFTP Client

Administrator Documentation

  • Gateway
    • Gateway Manual
      • Installation
        • Prerequisites
        • Installation from the Server bundle
        • Installation from a Linux package (rpm or deb)
      • Upgrading
      • Configuration
        • Java and environment settings: startup.properties
        • Configuring sites: connections.properties
        • Main server settings: gateway.properties
        • Require end-user certificates
      • Using Apache httpd as a frontend
        • Requirements
        • External references
      • Using the Gateway for failover and/or loadbalancing of UNICORE sites
        • Configuration
        • Available strategies
      • Gateway failover and migration
        • Gateway’s migration
        • Failover and loadbalancing of the Gateway
  • UNICORE/X
    • UNICORE/X Manual
      • Getting started
        • Prerequisites
        • Installation
      • Configuration of UNICORE/X
        • Overview of the main configuration options
        • Config file overview
        • Settings for the UNICORE/X process (e.g. memory)
        • Config file formats
        • UNICORE/X container configuration reference
        • Integration of UNICORE/X with other parts of a UNICORE infrastructure
        • Security
        • Configuring the execution backend (XNJS and TSI)
        • Configuring storage services
        • HTTP proxy, timeout and web server settings
        • Features provided by UNICORE/X
      • Registry feature
      • Administration
        • Controlling UNICORE/X memory usage
        • Logging
        • Administration and monitoring
        • Migration of a UNICORE/X server to another physical host
      • Security concepts in UNICORE/X
        • Security concepts
      • Authentication
        • Introduction
        • Username-password file
        • OAuth token authentication with an OIDC server
        • Assigning attributes based on authentication response
        • Unity (SAML) authentication using OAuth Bearer token
        • Unity (SAML) authentication using username/password
        • X.509 certificate
        • PAM
        • Customizing JWT Delegation
      • Attribute sources
        • UNICORE authorization attributes
        • Configuring Attribute Sources
        • Available attribute sources
      • Virtual Organisations (VO) Support
        • Overview
        • Configuration
        • VO (SAML) configuration HOWTOs
      • The UNICORE persistence layer
        • Configuring the persistence layer
      • Interfacing UNICORE/X to the TSI
        • The UNICORE TSI
        • Operation without a UNICORE TSI
      • The IDB
        • Defining the IDB location
        • IDB syntax description
        • IDB Application definitions
        • Application argument metadata
      • Data staging
        • SCP support
        • GridFTP
        • Configuration reference
      • UFTP setup
        • Configuring multiple UFTPD servers
      • Configuration of storages
        • Configuring storage services
        • Configuring storages attached to TargetSystem instances
        • Configuring the StorageFactory service
        • Configuring the job working directory storage services
      • The UNICORE metadata service
        • Configuring metadata support
        • Controlling metadata extraction
      • Data-triggered processing
      • Authorization back-end (PDP) guide
        • Basic configuration
        • Available PDP modules
      • Guide to XACML security policies
        • Policy sets and combining of results
        • Role-based access to services
        • Limiting access to services to the service instance owner
        • More details on XACML use in UNICORE/X
    • UNICORE/X Update
  • TSI
    • TSI Manual
      • Prerequisites
      • Installation
        • Batch system specific distribution
        • Generic distribution
        • File permissions
      • Configuring the TSI
        • Verifying
        • TSI networking configuration
        • UNICORE/X configuration
        • ACL support
        • Enabling SSL for the UNICORE/X - TSI communication
      • Adapting the TSI to your system
        • Environment and paths
        • Assigning groups to the current user
        • Batch system integration: BSS.py
        • Reporting free disk space
        • Reporting computing time budget
        • Filtering cluster working nodes
        • Resource reservation
      • Execution model
      • PAM, systemd and user slices
      • Directories used by the TSI
      • Running the TSI
        • Starting the TSI
        • Stopping the TSI
        • TSI logging
      • Porting the TSI to other batch systems
      • Securing and hardening the system
    • TSI API
      • Initialisation
      • Messages to the UNICORE/X server
      • User identity and environment setting
      • Method dispatch
      • Job execution and job control functions
        • Job submission (#TSI_SUBMIT)
        • Script execution (#TSI_EXECUTESCRIPT)
        • Job control
        • Detailed job info (#TSI_GETJOBDETAILS)
        • Status listing (#TSI_QSTAT)
        • Getting the user’s remaining compute budget (#TSI_GET_COMPUTE_BUDGET)
      • I/O functions
        • Reading a file (#TSI_GETFILECHUNK)
        • Writing files (#TSI_PUTFILECHUNK)
        • File ACL operations (#TSI_FILE_ACL)
        • Listing directories and getting file information (#TSI_LS)
        • Getting free disk space (#TSI_DF)
      • Resource reservation functions
        • Creating a reservation (#TSI_MAKE_RESERVATION)
        • Cancelling a reservation (#TSI_CANCEL_RESERVATION)
      • Miscellaneous functions
        • Getting TSI version information (#TSI_PING)
        • Getting user information (#TSI_GET_USER_INFO)
    • Building the TSI
      • Packaging
      • Generic binary TGZ
  • XUUDB
    • XUUDB Manual
      • Overview
        • The classic mapping
        • The dynamic mapping
      • Installation
        • Installation from Core Server Bundle
      • The XUUDB server
        • Security
        • Administrative access
        • Configuration
        • Configuring PKI trust settings
        • Dynamic mappings configuration
        • Starting the XUUDB server
        • Stopping the server
        • Logging
      • The admin client
        • Configuring advanced HTTP client settings
        • Commands
        • Adding entries using add or adddn
        • Checking the content
        • Removing entries
        • Exporting/importing
        • Updating entries
  • Workflow Service
    • Workflow Service Manual
      • Installing and setting up the UNICORE Workflow engine
        • Prerequisites
        • Updating from previous versions
        • Installation
        • Setup
        • Verifying the installation
        • API documentation
      • Configuration of the Workflow server
        • Workflow processing
        • XNJS settings
        • Property reference
      • Updating an existing UNICORE Workflow service
        • Stop the server
        • Backup
        • Update jar files
        • Update config files
        • Restart the servers
  • Registry
    • Installation
      • Prerequisites
      • A note on paths
    • Registry configuration
      • Registry configuration (CONF/main.config)
      • Starting and stopping
      • Access control
      • User / server authentication
      • Gateway configuration
      • UNICORE/X configuration
      • Client configuration
  • UFTPD

Getting Support

  • License
  • Links
  • Support
  • Glossary
UNICORE Docs
  • Search

© Copyright 2025 UNICORE. Last updated on Apr 28, 2026.