Introduction
DEPRECATION NOTICE: The "v3" viewing package REST APIs have been deprecated and will be removed in a future release.
The PrizmDoc Server provides a "v3" Viewing Packages API that allows you to pre-convert documents of any supported format to PDF.
In order to enable the "v3" Viewing Packages API, you need to configure both of the following storage types for "v3" Viewing Packages.
Configure the "v3" Viewing Package Metadata Storage
PrizmDoc Server stores "v3" Viewing Package Metadata in the Central Database. In order to use the feature, you need to:
- Enable the use of the "v3" Viewing Package Metadata Storage using the
viewingPackagesMetadata.storagecentral configuration parameter.
Configure the "v3" Viewing Package Artifact Storage
PrizmDoc Server supports the use of Amazon S3 for storing "v3" Viewing Package Artifacts. In order to use the feature, you need to:
- Enable the use of the "v3" Viewing Package Artifacts Storage using the
viewingPackagesArtifacts.storagecentral configuration parameter. - Specify S3 bucket name and prefix to append to the name of all S3 objects created using
viewingPackagesArtifacts.pathandviewingPackagesArtifacts.s3BucketNamecentral configuration parameters.
Your S3 user must have READ and WRITE permissions on the specified bucket. Make sure that s3:PutObject and s3:DeleteObject permissions are granted.