search

Export rename config

Multi destination and rename support in export rename config.

Pagehub version 4.5.0 along with Pagehub export API version 1.2.0 supports multi destination and rename files in export settings. It also supports to merge double truck/multitruck pdf into single pdf page during export.

This feature allows user to save the files at multiple destinations (S3, FTP, SFTP). It also allows to rename the files when exported at destination level and at file level.

eg: one indd/pdf file can be saved with two different names in two different locations, or One destination can have the same file with two different names for indd and pdf.

circle-info

Export rename config must have "Section" settings, to differentiate the name of the files in different swim lanes.

epaper rename is not supported in this export API.

Merge Pdf - User can configure double truck or multi truck page PDF as a single PDF page instead of exporting two individual PDF pages using this key in the configuration "mergePdf": true,

Configuration for export settings with multiple scenarios that support following:

  • To save the settings at Multiple Destinations (S3, FTP, SFTP)

  • Export with file Rename at Destination level and File level(indd and pdf)

  • Merge Multi truck/double truck PDF as single pdf.

Case1

  • 1 Product

  • One location

  • Same Rename logic for indd and pdf

Configuration

Case2

  • 1 Product

  • One location

  • Different Rename logic at file level for indd and pdf

Configuration

Case3

  • 1 Product

  • Two locations

  • Different Rename logic at Location level for different files indd and pdf

Configuration

Case4

  • 1 Product

  • Multiple locations (S3, FTP, SFTP)

  • Different Rename logic at Location level

  • Merged Pdf

Configuration

hashtag
Case 1 Sample configuration

{
        "default": {
                "destinations": [
                        {
                                "S3": {
                                        "bucket": "pagehub-export-test",
                                        "awsRegion": "eu-west-1",
                                        "path": {
                                              "ePaperPath": "MultiDestination1/epaperfiles",
                                                "inddPath": "MultiDestination1/inddfiles",
                                                "pdfPath": "MultiDestination1/pdffiles"
                                        }
                                }
                        }
                ],
                "fileFormats": [
                        "epaper"
                ],
                "exportRenameConfig": {
                        "enable": true,
                        "config": [
                                {
                                        "PageNum": {
                                                "PageNum": 3,
                                                "Delimiter": "-"
                                        }
                                },
                                {
                                        "PremadePageLiteral": {
                                                "PremadePageLiteral": false,
                                                "PremadePageLiteral:N": 2,
                                                "Delimiter": "-"
                                        }
                                },
                                {
                                        "Section": {
                                                "Section": false,
                                                "Section:N": 2,
                                                "Delimiter": "-+"
                                        }
                                },
                                {
                                        "PagePrefix": {
                                                "PagePrefix": false,
                                                "PagePrefix:P": "default/Prefix",
                                                "Delimiter": "-"
                                        }
                                },
                                {
                                        "Edition": {
                                                "Edition": false,
                                                "Edition:N": 5,
                                                "Delimiter": "++"
                                        }
                                },
                                {
                                        "DateFormat": {
                                                "Delimiter": "_-+_",
                                                "DateFormat": "YYYY-MM-DD"
                                        }
                                },
                                {
                                        "Part": {
                                                "Part": false,
                                                "Part:N": 3,
                                                "Delimiter": "--"
                                        }
                                },
                                {
                                        "Custom1": {
                                                "Custom1": "custom1",
                                                "Delimiter": "-"
                                        }
                                }
                        ]
                }
        },
        "PMS_AGP1": {
                "destinations": [
                        {
                                "S3": {
                                        "bucket": "pagehub-export-test",
                                        "awsRegion": "eu-west-1",
                                        "path": {
                                               "ePaperPath": "MultiDestination1/epaperfiles",
                                                "inddPath": "MultiDestination1/inddfiles",
                                                "pdfPath": "MultiDestination1/pdffiles"
                                        }
                                }
                        }
                ],
                "fileFormats": [
                        "epaper"
                ],
                "exportRenameConfig": {
                        "enable": true,
                        "config": [
                                {
                                        "PageNum": {
                                                "PageNum": 3,
                                                "Delimiter": "-"
                                        }
                                },
                                {
                                        "PremadePageLiteral": {
                                                "PremadePageLiteral": false,
                                                "PremadePageLiteral:N": 2,
                                                "Delimiter": "-"
                                        }
                                },
                                {
                                        "Section": {
                                                "Section": false,
                                                "Section:N": 2,
                                                "Delimiter": "-+"
                                        }
                                },
                                {
                                        "PagePrefix": {
                                                "PagePrefix": false,
                                                "PagePrefix:P": "default/Prefix",
                                                "Delimiter": "-"
                                        }
                                },
                                {
                                        "Edition": {
                                                "Edition": false,
                                                "Edition:N": 5,
                                                "Delimiter": "++"
                                        }
                                },
                                {
                                        "DateFormat": {
                                                "Delimiter": "_-+_",
                                                "DateFormat": "YYYY-MM-DD"
                                        }
                                },
                                {
                                        "Part": {
                                                "Part": false,
                                                "Part:N": 3,
                                                "Delimiter": "--"
                                        }
                                },
                                {
                                        "Custom1": {
                                                "Custom1": "custom1",
                                                "Delimiter": "-"
                                        }
                                }
                        ]
                }
        }
}

hashtag
Case 2 Sample configuration

hashtag
Case 3 Sample Configuration

hashtag
Case 4 Sample Configuration

S3: Export rename pdf

SFTP: Export rename pdf and Export rename indd

FTP: Export rename pdf and Export rename indd

"mergePdf": true in all three locations

hashtag
ePaper rename and export config

Pagehub version 4.6.0 along with Pagehub export API version 1.3.0 supports ePaper export and rename files in export settings.

A new configuration named exportRenameConfigEpaper has been introduced in the export configuration.

Additionally, two new parameters have been added:

  • UUID – mandatory for ePaper file renaming.

  • Product – can be used for renaming across all file types (ePaper, PDF, INDD).

With this enhancement, the ePaper export now supports a rename logic similar to PDF and INDD, allowing consistent and flexible file naming across all supported formats.

Sample configuration:

Sample configuration for epaper:

default and S3 destination

hashtag
Pagehub export API 1.3.1

In the latest API version,

  • Default filename on epaper export issue fixed

A new configuration key ePaperRenaming has been introduced at the destination level in the export configuration. When this key is set to true (Boolean), the ePaper renaming logic will be applied. If the key is not set or its value is false, the export will continue to follow the existing/default naming flow.

circle-info

When configuration key ePaperRenaming is set to true , then exportRenameConfigEpaper or exportRenameConfig must have the UUID parameter in the configuration.

When key ePaperRenaming is not available in configuration, epaper export and other settings will works as usual.

*ePaper rename logic will be applied as per the setting defined at destination level only, Example, If S3 has ePaperRenaming and exportRenameConfigEpaper defined in the configuration then rename logic will work for S3 only and for rest of the destinations default export rename will work.

Sample configuration as per use case

Case1 : No uuid validation

  • Default filename on epaper export

  • For S3 : without "ePaperRenaming" key

  • For FTP "ePaperRenaming": false

  • UUID not defined anywhere

Case1: Configuration

Case2 : UUID required for Default rename config

  • Default export rename config

  • For S3 "ePaperRenaming": true

  • For S3 : without "exportRenameConfigEpaper" key

  • UUID must be defined in default export rename config "exportRenameConfig"

Case2: Configuration

Case3 : UUID required for exportRenameConfigEpaper in S3 and default exportRenameConfig in FTP

  • ePaper export rename config

  • For S3: "ePaperRenaming": true

  • For S3 : "exportRenameConfigEpaper" key set to true, UUID is required.

  • For FTP: "ePaperRenaming": true, default "exportRenameConfig" must have UUID.

Case3: Configuration

Case4 : S3 and SFTP follows specific epaper export rename logic and FTP follows the Default export rename config.

  • For S3 and SFTP: Both setting are true "ePaperRenaming": true and "exportRenameConfigEpaper"

  • For FTP : only "ePaperRenaming": true

  • UUID must be defined in both default rename config "exportRenameConfig" and epaper rename exportRenameConfigEpaper

Case4: Configuration

hashtag
Case1: Configuration

hashtag
Case2: Configuration

hashtag
Case3: Configuration

hashtag
Case4: Configuration

PreviousDisplay Name Pages and Products ConfigurationNextTransformation

Last updated