com.veeva.vault.vapil.api.request.VaultRequest<ConfigurationMigrationRequest>

com.veeva.vault.vapil.api.request.ConfigurationMigrationRequest

public class ConfigurationMigrationRequest extends VaultRequest<ConfigurationMigrationRequest>

Configuration Migration

Vault API Coverage:: https://developer.veevavault.com/api/25.1/#configuration-migration

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

ConfigurationMigrationRequest.DetailsType

Optional: To show component level details only, set to none.

static enum

ConfigurationMigrationRequest.OutputFormat

Optional: Output report as either an Excel (XSLX) or Excel_Macro_Enabled (XLSM) file.

static enum

ConfigurationMigrationRequest.ResultsType

Optional: To include all configuration values, set this to complete.
Field Summary

Fields inherited from class com.veeva.vault.vapil.api.request.VaultRequest
HTTP_HEADER_AUTHORIZATION, HTTP_HEADER_REFERENCE_ID, HTTP_HEADER_VAULT_CLIENT_ID, referenceId, requestClientId, vaultClient
Method Summary

Modifier and Type

Method

Description

ComponentQueryResponse

componentDefinitionQuery(String vql)

Component Definition Query

ComponentQueryResponse

componentDefinitionQueryByPage(String pageUrl)

Component Definition Query

JobCreateResponse

deployPackage(String packageId)

Deploy Package

VaultResponse

disableConfigurationMode()

Disable Configuration Mode

VaultResponse

enableConfigurationMode()

Enable Configuration Mode

JobCreateResponse

exportPackage(String packageName)

Export Package

JobCreateResponse

importPackage()

Import Package

VaultResponse

retrieveConfigurationReportResults(String jobId)

Retrieve Configuration Report Results

OutboundPackageDependenciesResponse

retrieveOutboundPackageDependencies(String packageId)

Retrieve Outbound Package Dependencies

PackageDeploymentResultsResponse

retrievePackageDeployResults(String packageId)

Retrieve Package Deploy Results

PackageImportResultsResponse

retrievePackageImportResults(String packageId)

Retrieve Package Import Results

PackageImportResultsResponse

retrievePackageImportResultsByHref(String href)

Retrieve Package Import Results

ConfigurationMigrationRequest

setBinaryFile(String filename, byte[] binaryContent)

Specify source data in an input file

ConfigurationMigrationRequest

setComponentsType(List<String> componentTypes)

Set list of component types for compare or config report

ConfigurationMigrationRequest

setDetailsType(ConfigurationMigrationRequest.DetailsType detailsType)

Set details type for compare report

ConfigurationMigrationRequest

setGenerateOutboundPackages(Boolean generateOutboundPackages)

Set generate outbound packages baed on compare report differences

ConfigurationMigrationRequest

setIncludeComponentsModifiedSince(ZonedDateTime includeComponentsModifiedSince)

Set components modified since date in compare report

ConfigurationMigrationRequest

setIncludeDocBinderTemplates(Boolean includeDocBinderTemplates)

Set include binder doc templates in compare report

ConfigurationMigrationRequest

setIncludeInactiveComponents(Boolean includeInactiveComponents)

Set include inactive components in config report

ConfigurationMigrationRequest

setIncludeVaultSettings(Boolean includeVaultSettings)

Set include vault settings in compare or config report

ConfigurationMigrationRequest

setInputPath(String inputPath)

Specify source data in an input file

ConfigurationMigrationRequest

setOutputFormat(ConfigurationMigrationRequest.OutputFormat outputFormat)

Set output format for config report

ConfigurationMigrationRequest

setOutputPath(String outputPath)

Specify source data in an output file

ConfigurationMigrationRequest

setResultsType(ConfigurationMigrationRequest.ResultsType resultsType)

Set results type for compare report

ConfigurationMigrationRequest

setSuppressEmptyResults(Boolean suppressEmptyResults)

Set suppress empty results for config report

ValidatePackageResponse

validateInboundPackage(String packageId)

Validate Inbound Package

ValidatePackageResponse

validatePackage()

Validate Package

JobCreateResponse

vaultCompare(int targetVaultId)

Vault Compare

JobCreateResponse

vaultConfigurationReport()

Vault Configuration Report

Methods inherited from class com.veeva.vault.vapil.api.request.VaultRequest
getBaseObjectMapper, send, send, sendReturnBinary, sendReturnBinary, sendToFile, sendToFile, setHeaderClientId, setHeaderReferenceId, setVaultClient

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

exportPackage

public JobCreateResponse exportPackage(String packageName)

Export Package

Parameters:

packageName - name of package to export

Returns:

JobCreateResponse

Vault API Endpoint:

 POST /api/{version}/services/package

Vault API Help Link:

https://developer.veevavault.com/api/25.1/#export-package

Example Request:

 JobCreateResponse resp = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                                .exportPackage(packageName);

Example Response:

 System.out.println("Status = " + resp.getResponseStatus());
 if (resp.isSuccessful()) {
   System.out.println("JobId = " + resp.getJobId());
   System.out.println("Url = " + resp.getUrl());

   for (JobCreateResponse.Warning warning : resp.getWarnings()) {
     System.out.println("Type = " + warning.getMessage() + ", Message = " + warning.getMessage());
   }
 }

importPackage

public JobCreateResponse importPackage()

Import Package

Returns:

JobCreateResponse

Vault API Endpoint:

 PUT /api/{version}/services/package

Vault API Help Link:

https://developer.veevavault.com/api/25.1/#import-package

Example Request:

 Example 1 - File
 PackageResponse resp = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                                .setInputPath(filePath)
                                .importPackage();

,

 Example 2 - Binary
 PackageResponse resp = vaultClient.newRequest(ConfigurationMigrationRequest.class)
   .setBinaryFile("file", Files.readAllBytes(new File(filePath).toPath()))
   .importPackage();

Example Response:

 System.out.println("Status = " + resp.getResponseStatus());
 if (resp.isSuccessful()) {
   System.out.println("Id = " + resp.getJobId());
         System.out.println("Url = " + resp.getUrl());
 }

deployPackage

public JobCreateResponse deployPackage(String packageId)

Deploy Package

Parameters:

packageId - id of package to deploy

Returns:

JobCreateResponse

Vault API Endpoint:

 POST /api/{version}/vobject/vault_package__v/{package_id}/actions/deploy

Vault API Help Link:

https://developer.veevavault.com/api/25.1/#deploy-package

Example Request:

 JobCreateResponse resp = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                                .deployPackage(packageId);

Example Response:

 System.out.println("Status = " + resp.getResponseStatus());
 if (resp.isSuccessful()) {
   System.out.println("JobId = " + resp.getJobId());
   System.out.println("Url = " + resp.getUrl());

   for (JobCreateResponse.Warning warning : resp.getWarnings()) {
     System.out.println("Type = " + warning.getMessage() + ", Message = " + warning.getMessage());
   }
 }

retrievePackageDeployResults

public PackageDeploymentResultsResponse retrievePackageDeployResults(String packageId)

Retrieve Package Deploy Results

Parameters:

packageId - id of package to retrieve results

Returns:

PackageDeploymentResultsResponse

Vault API Endpoint:

 GET /api/{version}/vobject/vault_package__v/{package_id}/actions/deploy/results

Vault API Help Link:

https://developer.veevavault.com/api/25.1/#retrieve-package-deploy-results

Example Request:

 PackageDeploymentResultsResponse resp = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                                .retrievePackageDeployResults(packageId);

Example Response:

 System.out.println("Status = " + resp.getResponseStatus());
 if (resp.isSuccessful()) {
   System.out.println("Total Components = " + resp.getResponseDetails().getTotalComponents());
   System.out.println("Deployment Status = " + resp.getResponseDetails().getDeploymentStatus());
 }

retrievePackageImportResults

public PackageImportResultsResponse retrievePackageImportResults(String packageId)

Retrieve Package Import Results

Retrieve the results of an imported VPK given the package id

Parameters:

packageId - id of package to retrieve results

Returns:

PackageImportResultsResponse

Vault API Endpoint:

     GET /api/{version}/vobject/vault_package__v/{package_id}/actions/import/results

Example Request:

     PackageImportResultsResponse resp = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                        .retrievePackageImportResults(packageId);

Example Response:

     if (resp.isSuccessful) {
         System.out.println("Package Name = " + resp.getVaultPackage().getName());
     }

retrievePackageImportResultsByHref

public PackageImportResultsResponse retrievePackageImportResultsByHref(String href)

Retrieve Package Import Results
Retrieve the results of an imported VPK given the href provided in the artifacts section of the Job Status response.
Parameters:

href - url of the retrieve package import results endpoint

Returns:

PackageImportResultsResponse

Vault API Endpoint:
```
     GET /api/{version}/vobject/vault_package__v/{package_id}/actions/import/results
```
Example Request:
```
     PackageImportResultsResponse resp = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                        .retrievePackageImportResults(href);
 
```
Example Response:
```
     if (resp.isSuccessful) {
         System.out.println("Package Name = " + resp.getVaultPackage().getName());
     }
 
```
retrieveOutboundPackageDependencies

public OutboundPackageDependenciesResponse retrieveOutboundPackageDependencies(String packageId)

Retrieve Outbound Package Dependencies
Retrieve existing dependencies for an outbound package.
Parameters:

packageId - id of package to retrieve dependencies

Returns:

OutboundPackageDependenciesResponse

Vault API Endpoint:
```
     GET /api/{version}/vobject/outbound_package__v/{package_id}/dependencies
 
```
Vault API Help Link:

https://developer.veevavault.com/api/25.1/#retrieve-outbound-package-dependencies

Example Request:
```
     OutboundPackageDependenciesResponse resp = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                                        .retrieveOutboundPackageDependencies(packageId);
 
```
Example Response:
```
     if (resp.isSuccessful) {
        System.out.println("Total Dependencies = " + resp.getResponseDetails().getTotalDependencies());
     }
 
```

vaultCompare

public JobCreateResponse vaultCompare(int targetVaultId)

Vault Compare

Parameters:

targetVaultId - target vault id

Returns:

JobCreateResponse

Vault API Endpoint:

 POST /api/{version}/objects/vault/actions/compare

Vault API Help Link:

https://developer.veevavault.com/api/25.1/#vault-compare

Example Request:

 JobCreateResponse resp = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                                .setResultsType(ConfigurationMigrationRequest.ResultsType.COMPLETE)
                                .setDetailsType(ConfigurationMigrationRequest.DetailsType.COMPLEX)
                                .setIncludeDocBinderTemplates(true)
                                .setIncludeVaultSettings(true)
                                .setComponentsType(componentTypes)
                                .vaultCompare(targetVaultId);

Example Response:

 System.out.println("Status = " + resp.getResponseStatus());
 if (resp.isSuccessful()) {
   System.out.println("JobId = " + resp.getJobId());
   System.out.println("Url = " + resp.getUrl());

   for (JobCreateResponse.Warning warning : resp.getWarnings()) {
     System.out.println("Type = " + warning.getMessage() + ", Message = " + warning.getMessage());
   }
 }

vaultConfigurationReport

public JobCreateResponse vaultConfigurationReport()

Vault Configuration Report

Returns:

JobCreateResponse

Vault API Endpoint:

 POST /api/{version}/objects/vault/actions/configreport

Vault API Help Link:

https://developer.veevavault.com/api/25.1/#vault-configuration-report

Example Request:

 JobCreateResponse resp = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                                .setIncludeVaultSettings(true)
                                .setIncludeInactiveComponents(true)
                                .setIncludeComponentsModifiedSince(ZonedDateTime.now().minusDays(14))
                                .setSuppressEmptyResults(true)
                                .setComponentsType(componentTypes)
                                .setOutputFormat(ConfigurationMigrationRequest.OutputFormat.EXCEL)
                                .vaultConfigurationReport();

Example Response:

 System.out.println("Status = " + resp.getResponseStatus());
 if (resp.isSuccessful()) {
   System.out.println("JobId = " + resp.getJobId());
   System.out.println("Url = " + resp.getUrl());

   for (JobCreateResponse.Warning warning : resp.getWarnings()) {
     System.out.println("Type = " + warning.getMessage() + ", Message = " + warning.getMessage());
   }
 }

retrieveConfigurationReportResults

public VaultResponse retrieveConfigurationReportResults(String jobId)

Retrieve Configuration Report Results

Parameters:

jobId - The job id of the configuration report

Returns:

VaultResponse

Vault API Endpoint:

 GET /api/{version}/objects/vault/actions/configreport/{job_id}/report

Vault API Help Link:

TODO

Example Request:

 Example 1 - Binary
 VaultResponse response = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                .retrieveConfigurationReportResults(String.valueOf(jobId));

 Example 2 - File
 VaultResponse response = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                .setOutputPath(outputPath)
                .retrieveConfigurationReportResults(String.valueOf(jobId));

Example Response:

 Example 1 - Binary
 System.out.println("Response Status: " + response.getResponseStatus());
 byte[] fileContent = response.getBinaryContent();

 Example 2 - To File
 System.out.println("Response Status: " + response.getResponseStatus());
 System.out.println("Output Path: " + response.getOutputFilePath());

componentDefinitionQuery

public ComponentQueryResponse componentDefinitionQuery(String vql)

Component Definition Query

Perform a Vault query request. Subsequent queries and pagination are needed to retrieve the full result set if the total records returned exceed the "pagesize" parameter in the response. See componentDefinitionQueryByPage(String) (String)}.

Returned records can be retrieved via the "getData" method in the response.

Parameters:

vql - The fully formed query string

Returns:

ComponentQueryResponse

Vault API Endpoint:

 POST /api/{version}/query/components

Vault API Help Link:

TODO

Example Request:

 Example 1 - Vault Component
 String vql = "SELECT id,name__v,component_name__v FROM vault_component__v";
 ComponentQueryResponse response = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                .componentDefinitionQuery(vql);

 Example 2 - Vault Package Component
 String vql = "SELECT id,name__v,component_type__v FROM vault_package_component__v";
 ComponentQueryResponse response = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                .componentDefinitionQuery(vql);

Example Response:

 Example 1 - Vault Component
 for (ComponentQueryResponse.QueryResult queryResult : response.getData()) {
     System.out.println("----Vault Component----");
     System.out.println("ID: " + queryResult.get("id"));
     System.out.println("Name: " + queryResult.get("name__v"));
     System.out.println("Component Name: " + queryResult.get("component_name__v"));
 }

 Example 2 - Vault Package Component
 for (ComponentQueryResponse.QueryResult queryResult : response.getData()) {
                System.out.println("----Vault Package Component----");
                System.out.println("ID: " + queryResult.get("id"));
                System.out.println("Name: " + queryResult.get("name__v"));
                System.out.println("Component Type: " + queryResult.get("component_type__v"));
 }

componentDefinitionQueryByPage

public ComponentQueryResponse componentDefinitionQueryByPage(String pageUrl)

Component Definition Query

Perform a paginated component query based on the URL from a previous query (previous_page or next_page in the response details).

Parameters:

pageUrl - The URL from the previous_page or next_page parameter

Returns:

ComponentQueryResponse

Vault API Endpoint:

 Example component query url format
 POST /api/v25.1/query/components/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?pagesize=1000&pageoffset=1000

Vault API Help Link:

TODO

Example Request:

 ComponentQueryResponse componentQueryResponse = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                .componentDefinitionQuery("SELECT id,name__v,component_name__v FROM vault_component__v");

 ComponentQueryResponse nextPageResponse = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                .componentDefinitionQueryByPage(componentQueryResponse.getResponseDetails().getNextPage());

Example Response:

 System.out.println("Total Results: " + nextPageResponse.getResponseDetails().getTotal());
 System.out.println("Page Offset: " + nextPageResponse.getResponseDetails().getPageOffset());

 for (ComponentQueryResponse.QueryResult queryResult : nextPageResponse.getData()) {
                System.out.println("----Vault Component----");
                System.out.println("ID: " + queryResult.get("id"));
                System.out.println("Name: " + queryResult.get("name__v"));
                System.out.println("Component Name: " + queryResult.get("component_name__v"));
 }

validatePackage

public ValidatePackageResponse validatePackage()

Validate Package

Returns:

ValidatePackageResponse

Vault API Endpoint:

 POST /api/{version}/services/package/actions/validate

Vault API Help Link:

https://developer.veevavault.com/api/25.1/#validate-package

Example Request:

 Example 1 - File
 ValidatePackageResponse resp = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                                .setInputPath(filePath)
                                .validatePackage();

,

 Example 2 - Binary
 ValidatePackageResponse resp = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                                .setBinaryFile("file", Files.readAllBytes(new File(filePath).toPath()))
                                .validatePackage();

Example Response:

 System.out.println("Status = " + resp.getResponseStatus());
 if (resp.isSuccessful()) {
   System.out.println("Author = " + resp.getResponseDetails().getAuthor());
   System.out.println("Status = " + resp.getResponseDetails().getPackageStatus());
 }

validateInboundPackage

public ValidatePackageResponse validateInboundPackage(String packageId)

Validate Inbound Package

Parameters:

packageId - The id field value of the vault_package__v object record to validate.

Returns:

ValidatePackageResponse

Vault API Endpoint:

 POST /api/{version}/services/vobject/vault_package__v/{package_id}/actions/validate

Vault API Help Link:

https://developer.veevavault.com/api/25.1/#validate-inbound-package

Example Request:

 Example 1 - File
 ValidatePackageResponse resp = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                                .validateInboundPackage();

Example Response:

 System.out.println("Status = " + resp.getResponseStatus());
 if (resp.isSuccessful()) {
   System.out.println("Author = " + resp.getResponseDetails().getAuthor());
   System.out.println("Status = " + resp.getResponseDetails().getPackageStatus());
 }

enableConfigurationMode

public VaultResponse enableConfigurationMode()

Enable Configuration Mode

Returns:

VaultResponse

Vault API Endpoint:

 POST /api/{version}/services/configuration_mode/actions/enable

Vault API Help Link:

https://developer.veevavault.com/api/25.1/#enable-configuration-mode

Example Request:

 VaultResponse response = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                .enableConfigurationMode();

Example Response:

 System.out.println("Response Status = " + response.getResponseStatus());
 System.out.println("Response Message= " + response.getResponseMessage());

disableConfigurationMode

public VaultResponse disableConfigurationMode()

Disable Configuration Mode

Returns:

VaultResponse

Vault API Endpoint:

 POST /api/{version}/services/configuration_mode/actions/disable

Vault API Help Link:

https://developer.veevavault.com/api/25.1/#disable-configuration-mode

Example Request:

 VaultResponse response = vaultClient.newRequest(ConfigurationMigrationRequest.class)
                .disableConfigurationMode();

Example Response:

 System.out.println("Response Status = " + response.getResponseStatus());
 System.out.println("Response Message= " + response.getResponseMessage());

setBinaryFile

public ConfigurationMigrationRequest setBinaryFile(String filename, byte[] binaryContent)

Specify source data in an input file

Parameters:

filename - file name (no path)

binaryContent - byte array of the file content

Returns:

The Request
setComponentsType

public ConfigurationMigrationRequest setComponentsType(List<String> componentTypes)

Set list of component types for compare or config report

Parameters:

componentTypes - component types

Returns:

The Request
setGenerateOutboundPackages

public ConfigurationMigrationRequest setGenerateOutboundPackages(Boolean generateOutboundPackages)

Set generate outbound packages baed on compare report differences

Parameters:

generateOutboundPackages - boolean

Returns:

The Request
setDetailsType

public ConfigurationMigrationRequest setDetailsType(ConfigurationMigrationRequest.DetailsType detailsType)

Set details type for compare report

Parameters:

detailsType - details type

Returns:

The Request
setIncludeComponentsModifiedSince

public ConfigurationMigrationRequest setIncludeComponentsModifiedSince(ZonedDateTime includeComponentsModifiedSince)

Set components modified since date in compare report

Parameters:

includeComponentsModifiedSince - results type

Returns:

The Request
setIncludeDocBinderTemplates

public ConfigurationMigrationRequest setIncludeDocBinderTemplates(Boolean includeDocBinderTemplates)

Set include binder doc templates in compare report

Parameters:

includeDocBinderTemplates - boolean

Returns:

The Request
setIncludeInactiveComponents

public ConfigurationMigrationRequest setIncludeInactiveComponents(Boolean includeInactiveComponents)

Set include inactive components in config report

Parameters:

includeInactiveComponents - boolean

Returns:

The Request
setIncludeVaultSettings

public ConfigurationMigrationRequest setIncludeVaultSettings(Boolean includeVaultSettings)

Set include vault settings in compare or config report

Parameters:

includeVaultSettings - boolean

Returns:

The Request
setInputPath

public ConfigurationMigrationRequest setInputPath(String inputPath)

Specify source data in an input file

Parameters:

inputPath - Absolute path to the file for the request

Returns:

The Request
setOutputFormat

public ConfigurationMigrationRequest setOutputFormat(ConfigurationMigrationRequest.OutputFormat outputFormat)

Set output format for config report

Parameters:

outputFormat - boolean

Returns:

The Request
setResultsType

public ConfigurationMigrationRequest setResultsType(ConfigurationMigrationRequest.ResultsType resultsType)

Set results type for compare report

Parameters:

resultsType - results type

Returns:

The Request
setSuppressEmptyResults

public ConfigurationMigrationRequest setSuppressEmptyResults(Boolean suppressEmptyResults)

Set suppress empty results for config report

Parameters:

suppressEmptyResults - boolean

Returns:

The Request
setOutputPath

public ConfigurationMigrationRequest setOutputPath(String outputPath)

Specify source data in an output file

Parameters:

outputPath - Absolute path to the file for the response

Returns:

The Request

Class ConfigurationMigrationRequest

Nested Class Summary

Field Summary

Fields inherited from class com.veeva.vault.vapil.api.request.VaultRequest

Method Summary

Methods inherited from class com.veeva.vault.vapil.api.request.VaultRequest

Methods inherited from class java.lang.Object

Method Details

exportPackage

importPackage

deployPackage

retrievePackageDeployResults

retrievePackageImportResults

retrievePackageImportResultsByHref

retrieveOutboundPackageDependencies

vaultCompare

vaultConfigurationReport

retrieveConfigurationReportResults

componentDefinitionQuery

componentDefinitionQueryByPage

validatePackage

validateInboundPackage

enableConfigurationMode

disableConfigurationMode

setBinaryFile

setComponentsType

setGenerateOutboundPackages

setDetailsType

setIncludeComponentsModifiedSince

setIncludeDocBinderTemplates

setIncludeInactiveComponents

setIncludeVaultSettings

setInputPath

setOutputFormat

setResultsType

setSuppressEmptyResults

setOutputPath