Export-RegentRecordsByFind

NAME Export-RegentRecordsByFind



SYNOPSIS

Exports the results of all advanced finds listed in a config file, or from a single configuration object piped to

it.





SYNTAX

Export-RegentRecordsByFind [[-PathToConfig] <String>] [[-ParameterObject] <Object>] [[-JsonDepth] <Int32>]

[<CommonParameters>]





DESCRIPTION

This command reads a config file and exports the results all the Advanced Finds listed in that config file.

Alternatively, a single config object (such as that generated by Get-RegentExportConfig) can be piped to the

command





PARAMETERS

-PathToConfig <String>

The path to the config file. Defaults to a file in the current directory called AdvancedFindExport.config.json



Required? false

Position? 1

Default value .\\AdvancedFindExport.config.json

Accept pipeline input? false

Accept wildcard characters? false



-ParameterObject <Object>

Optional parameter for the an object to be used as the config. You can use Get-RegentConnection to generate

this object.



Required? false

Position? 2

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-JsonDepth <Int32>

The JSON returned from an Advanced Find is often several layers deep. This parameter indicates how deep to

extract the data from the returned JSON. The default value (4) should be adequate for most cases, but the

value can be adjusted down if more data than necessary is being returned, or up if not enough.



Required? false

Position? 3

Default value 4

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





General notes



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Find a job named "MyImportantJob" and export it.



Get-RegentExportConfig -JobName "MyImportantJob" | Export-RegentRecordsByFind









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



PS C:\\>Export all jobs in a specific config file, using a higher JSON depth.



Export-RegentRecordsByFind -PathToConfig C:\\Path\\To\\Config.json -JsonDepth 6











RELATED LINKS