Versions Compared

Key

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

...

Get-JS7FileTransferHistoryFile [[-ControllerId] <String>] [[-TransferId] <String[]>] [[-State] <String[]>] [[-SourceFile] <String[]>] [[-TargetFile] <String[]>] [[-Hash] <String>] [[-Limit] <Int32>] [<CommonParameters>]

...

Information is returned for individual files transferred with YADE from a JS7 workflow.
Files can be selected by file name, history status, transfer identification etc.

The history information returned includes source file name, target file name, hash value, status etc. for transfer of an indivdual file.
A file transfer can includes any number of files. For information about individual files
the Get-JS7FileTransferFile cmdlet can be used.

This cmdlet can be used for pipelining to pipeline the return of information about individual files like this:

$files = Get-JS7FileTransferHistory -RelativeDateFrom -1w -Successful | Get-JS7FileTransferHistoryFile

The following REST Web Service API resources are used:

* /yade/files

...

-TransferId <String[]>
Optionally specifies the identifier of a transfer operation as returned by the Get-JS7FileTransferHistory cmdlet like this:

$files = Get-JS7FileTransferHistory -RelativeDateFrom -1w -Successful | Get-JS7FileTransferHistoryFile

The Get-JS7FileTransferHistory is used to select file transfes transfers by date and execution result.
The result includes the transfer identifier and is pipelined to the Get-JS7FileTransferHistoryFile cmdlet to
return file items included with the specified file transfers.

...

-TargetFile <String[]>
Optionally specifies the name of a target file to limit the file items returned.

This parameter accepts any number of target file names separated by a comma.

Required?false
Position?5
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Hash

-Hash <String>
YADE can be configured to check the integrity of a file by a hash value.
The hash value is stored to the database and can be looked up by use of this parameter.

Required?false
Position?6
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-Limit <Int32>

Required?false
Position?67
Default value0
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

...

-------------------------- EXAMPLE 2 --------------------------

PS > $items = Get-JS7FileTransferHistoryFile -Hash 'd41d8cd98f00b204e9800998ecf8427e'

Returns the file item for the file that matches the indicated hash.

-------------------------- EXAMPLE 3 --------------------------

PS > $items = Get-JS7FileTransferHistoryFile -SourceFile accounting.csv

...

-------------------------- EXAMPLE 3 4 --------------------------

...

Returns the file item for the file transfer identified with the indicated key. The identifier for a file transfer can be retrieved by use of the Get-JS7FileTransferHistory cmdlet.

-------------------------- EXAMPLE 4 5 --------------------------

...