JS7 offers a number of options for managing file transfer configurations - see the JS7 - File Transfer article for more information.
- Instead of managing the file transfer configuration from the JOC Cockpit GUI users might prefer to:
- manage the XML configuration for file transfers externally, for example from a repository,
- generate the XML configuration based on input from sources such as a database,
- deploy the file transfer configuration within the scope of an automated CI/CD pipeline.
- JS7 provides the JS7 - REST Web Service API for carrying out such operations.
- A simplified wrapper for the REST Web Service is available from the JS7 - PowerShell Module.
- The examples below use the JS7 PowerShell Module. Running the examples with the
-debugswitch logs requests which can easily be integrated with individual REST Clients.
The file transfer configuration format is XML For details about the format see the YADE - Reference Documentation - XSD Schema Reference article.
Get list of available File Transfer configurations
The Get-JS7FileTransferItem cmdlet can be used without further arguments to return the list of available file transfer configurations.
The name of a file transfer configuration is used for the subtab in the JOC Cockpit Configuration view.
Read File Transfer configuration
The Get-JS7FileTransferItem cmdlet can be used with the
-Name argument to return the associated file transfer configuration in XML format.
The resulting XML object can be used to navigate using DOM methods.
Store File Transfer configuration
The Set-JS7FileTransferItem cmdlet can be used with the
-Configuration arguments to add or update a file transfer configuration with the JOC Cockpit inventory.
-Nameargument specifies the name of the file transfer configuration.
-Configurationargument specifies an XML object that holds the file transfer configuration in XML format.
- The example below uses an empty configuration, for available XML elements see YADE - Reference Documentation - XSD Schema Reference.
Remove File Transfer configuration
The Remove-JS7FileTransferItem cmdlet can be used with the
-Name argument to remove an individual file transfer configuration from the JOC Cockpit inventory.