2018.7 Migration Guide

PSPDFKit Server will move away from generating numeric IDs for documents and move to randomized unique IDs (ULIDs). This will improve scalability for users with a very large number of documents.

As part of 2018.7, we have introduced the GENERATE_ULID_DOCUMENT_IDS environment variable, which determines whether new documents are assigned a (deprecated) numeric ID or a ULID. Enabling this setting will give you the opportunity to test this change before its deprecation.

Please be aware that when uploading a document, you can also supply your own document ID that will be used by PSPDFKit Server.

While the automatically assigned document ID has always been a string, up until now, it could always be converted to an integer.

We highly recommend you either migrate to ULIDs as document IDs or supply your own when creating documents.

Our next release (2019.1) will deprecate numeric IDs and default to using ULIDs as IDs.

Migration Instructions

• When configuring PSPDFKit Server set GENERATE_ULID_DOCUMENT_IDS=true.

Migrate PSPDFKit for Web

For more information, please take a look at the PSPDFKit for Web 2018.7 Migration Guide.

For a full list of changes, check out the changelog.