Product Knowledge Base

Space shortcuts

Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

Introduction

  • The Parameter Reference is used for configuring JADE file transfer settings. It explains the structure and meaning of configuration elements.
  • The Parameter Reference is generated from the JADE - Reference Documentation - XSD Schema Reference and includes additional explanations of configuration elements.
  • The JADE - User Manual provides an overview of features, explains use cases and includes references to this documentation.

Parameter Reference

  Diagram

Unable to render 'XSD Viewer' macro

Could not find the given XSD (xsd_macrod816df888b489578c261b3bfb1e966df.png) on page (JADE - Reference Documentation - Parameter Reference)

Elements

Configurations
References Notes

The root element of a YADE configuration.

  • JobScheduler releases before 1.13.1
    • A configuration file is assigned to the YADE jobs by use the parameter settings.
  • JobScheduler releases starting from 1.13.1
    • The use of the parameter settings for the jobs executed on a JobScheduler Master is deprecated.
    • The functionality to manage the YADE configuration is directly available from JOC Cockpit.
      • The YADE configuration is forwarded by the Joc Cockpit to the respective JobScheduler Master.
Element Type Required Description
JobResource
  • Occurrence: 0..1
Optional
References Notes


JobScheduler releases starting from JS7 2.2.2

This element specifies a JS7 Job Resource.

name

This element specifies the name of a JS7 Job Resource.

environment_variable

This element specifies the environment variable name of a JS7 Job Resource.

variable

This element specifies the variable name of a JS7 Job Resource.
Fragments
  • Occurrence: 1
Required
References Notes

The branch element for reusable transfer configuration.

Subsequent fragments are used e.g. for file transfer specifications, notifications, mail server settings, that can be used in a number of file transfer Profiles.

A fragment specifies how a file transfer is carried out whereas a Profile specifies what should be transferred. Therefore multiple profiles can use the same fragments, e.g. to transfer different files from the same source or to reuse the same transfer specification as the source and the target in different transfer operations.

Profiles
  • Occurrence: 1
Required
References Notes

A profile specifies the operation and the settings that are used for a file transfer. Multiple profiles can be included in a YADE configuration.

General
  • Occurrence: 0..1
Optional
References Notes

The General configuration options refer to central settings that are applied to all file transfer configuratons such as use of the YADE Background Service and logging.

Some settings from the General branch can be superseeded by Profile settings that apply to an individual file transfer configuration.

The specification of General configuration parameters is not mandatory.

Explanations

The JADE configuration is divided into three main areas:

Fragments configuration

  • The Fragments refer to that part of the configuration that describes how the transfer is to be carried out – i.e. per FTP proxy
  • At least a minimum set of Fragments parameters has to be provided.

Profiles configuration

  • The Profiles part of the configuration describes what is to be done – i.e. the operations involved, such as copy from source A to target B
  • At least a minimum set of Profiles parameters has to be provided.

General configuration

  • The General configuration options mainly refer to globally used transfer features, such as use of the JADE Background Service or Credential Store and logging.
  • The specification of General configuration parameters is not mandatory.

 

In addition JADE configuration items that can be used in multiple areas are available in the following section of the documentation:

Reusable Elements

  • x

 

  • No labels