< Back
Add-RegentExportConfig
Post
NAME Add-RegentExportConfig
SYNOPSIS
Add an Advanced Find Export configuration to a configuration file
SYNTAX
Add-RegentExportConfig [[-PathToConfig] <String>] [-JobName] <String> [-CrmInstance] <Object> [-ViewName] <String>
[-IsUserView] <Boolean> [-ExportPath] <String> [<CommonParameters>]
DESCRIPTION
This command generates the necessary JSON to configure an automated export from Export-RegentRecordsByFind, and
appends that JSON to the specified configuration file.
PARAMETERS
-PathToConfig <String>
The path to the config file. If the file doesn't exist, it will be created. 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
-JobName <String>
The title of the job to be added. This also serves as an ID for other utilities to use, and must be unique or
an error will be thrown
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CrmInstance <Object>
The name of the CRM Instance to use. E.g CRMADVISETEST
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ViewName <String>
The name of the advanced find to export. The name must be unique in the target CRM, otherwise the other
utilites may yeild unexpected results.
Required? true
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IsUserView <Boolean>
A boolean representing whether the view is a system or user view.
Required? true
Position? 5
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ExportPath <String>
The path that the results of the advanced find will be exported to. The user executing must have write
permissions to the location specified.
Required? true
Position? 6
Default value
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>To add a job named "Marketing Contact Export" to a config in the current directory for a user view in
CRMRECRUIT named "Regent | Marketing List View", and export it to M:\\Departments\\Marketing\\list.json
Add-RegentExportConfig `
-JobName "Marketing Contact Export" `
-CrmInstance "CRMRECRUIT" `
-ViewName "Regent | Marketing List View" `
-IsUserVeiw $true `
-ExportPath "M:\\Departments\\Marketing\\list.json"
RELATED LINKS
SYNOPSIS
Add an Advanced Find Export configuration to a configuration file
SYNTAX
Add-RegentExportConfig [[-PathToConfig] <String>] [-JobName] <String> [-CrmInstance] <Object> [-ViewName] <String>
[-IsUserView] <Boolean> [-ExportPath] <String> [<CommonParameters>]
DESCRIPTION
This command generates the necessary JSON to configure an automated export from Export-RegentRecordsByFind, and
appends that JSON to the specified configuration file.
PARAMETERS
-PathToConfig <String>
The path to the config file. If the file doesn't exist, it will be created. 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
-JobName <String>
The title of the job to be added. This also serves as an ID for other utilities to use, and must be unique or
an error will be thrown
Required? true
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CrmInstance <Object>
The name of the CRM Instance to use. E.g CRMADVISETEST
Required? true
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ViewName <String>
The name of the advanced find to export. The name must be unique in the target CRM, otherwise the other
utilites may yeild unexpected results.
Required? true
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-IsUserView <Boolean>
A boolean representing whether the view is a system or user view.
Required? true
Position? 5
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-ExportPath <String>
The path that the results of the advanced find will be exported to. The user executing must have write
permissions to the location specified.
Required? true
Position? 6
Default value
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>To add a job named "Marketing Contact Export" to a config in the current directory for a user view in
CRMRECRUIT named "Regent | Marketing List View", and export it to M:\\Departments\\Marketing\\list.json
Add-RegentExportConfig `
-JobName "Marketing Contact Export" `
-CrmInstance "CRMRECRUIT" `
-ViewName "Regent | Marketing List View" `
-IsUserVeiw $true `
-ExportPath "M:\\Departments\\Marketing\\list.json"
RELATED LINKS