com.veeva.vault.vapil.api.request

Class ConfigurationMigrationRequest

java.lang.Object

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/24.1/#configuration-migration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfigurationMigrationRequest.DetailsType Optional: To show component level details only, set to none.
static class	ConfigurationMigrationRequest.OutputFormat Optional: Output report as either an Excel (XSLX) or Excel_Macro_Enabled (XLSM) file.
static class	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, vaultClient

Method Summary

Modifier and Type	Method and Description
JobCreateResponse	deployPackage(String packageId) Deploy Package
JobCreateResponse	exportPackage(String packageName) Export Package
JobCreateResponse	importPackage() Import Package
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	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, setHeaderReferenceId, setVaultClient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

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/24.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/24.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/24.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/24.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/24.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/24.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/24.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());
   }
 }

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/24.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/24.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());
 }

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