Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction

JS7 offers to manage a number of options for managing file transfer configurations , see - see the JS7 - File Transfer article for more information.

  • Instead of managing the file transfer configuration from the JOC Cockpit GUI some users might prefer to:
    • to manage the XML configuration for file transfers externally, for example from a repository,
    • to generate the XML configuration based on input from sources such as a database,
    • to deploy the file transfer configuration within the scope of an automated CI/CD pipeline.
  • The JS7 offers provides the JS7 - REST Web Service API to perform for carrying out such operations.
    • A simplified wrapper for the REST Web Service is available from the JS7 - PowerShell Module.
    • Below The examples make below use of the JS7 PowerShell Module. Running the examples with the -debug switch logs the respective requests that which can easily be integrated with individual REST Clients.

...

The file transfer configuration format is XML For details about the format see see the YADE - Reference Documentation - XSD Schema Reference article.

Examples

Get list of available File Transfer configurations

...

The Get-JS7FileTransferItem cmdlet can be used with the -Name argument to return the respective associated file transfer configuration in XML format.

The resulting XML object can be used to navigate using respective DOM methods.

Code Block
languagepowershell
titleRead a file transfer configuration
linenumberstrue
[xml] $yadeConfig = Get-JS7FileTransferItem -Name primaryAgent

Write-Output $yadeConfig.Configurations.Fragments.ProtocolFragments

...

The Set-JS7FileTransferItem cmdlet can be used with the -Name and -Configuration arguments to add or to update a file transfer configuration with the JOC Cockpit inventory.

  • The -Name argument specifies the name of the file transfer configuration.
  • The -Configuration argument specifies an XML object that holds the respective file transfer configuration in XML format.
  • The example below example makes use of uses an empty configuration, for available XML elements see 

...