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.

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

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"

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.

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

Case1: Configuration

{
        "default": {
                "destinations": [
                        {
                                "S3": {
                                        "bucket": "pagehub-export-test",
                                        "awsRegion": "eu-west-1",
                                        "path": {
                                                "ePaperPath": "Test11/epaperFiles"
                                        }
                                }
                        },
                        {
                                "FTP": {
                                        "hostname": "ftp-mlb.newscyclesolutions.com",
                                        "username": "cct-pagehub-export",
                                        "password": "0A8rn1uc@Y6hNKI",
                                        "path": {
                                                "pdfPath": "test1/pdfFiles",
                                                "inddPath": "test1/inddFiles",
                                                "ePaperPath": "test1/ePaper"
                                        },
                                        "mergePdf": true,
                                        "ePaperRenaming": false,
                                        "exportRenameConfigEpaper": {
                                                "enable": true,
                                                "config": [
                                                        {
                                                                "PageNum": {
                                                                        "PageNum": 3,
                                                                        "Delimiter": "_"
                                                                }
                                                        }
                                                ]
                                        },
                                        "exportRenameConfig": {
                                                "enable": false,
                                                "config": [
                                                        {
                                                                "PageNum": {
                                                                        "PageNum": 1,
                                                                        "Delimiter": "-"
                                                                }
                                                        },
                                                        {
                                                                "PremadePageLiteral": {
                                                                        "PremadePageLiteral": false,
                                                                        "PremadePageLiteral:N": 2,
                                                                        "Delimiter": "-"
                                                                }
                                                        }
                                                ]
                                        }
                                }
                        }
                ],
                "fileFormats": [
                        "pdf",
                        "epaper",
                        "indd"
                ],
                "exportRenameConfig": {
                        "enable": true,
                        "config": [
                                {
                                        "PremadePageLiteral": {
                                                "PremadePageLiteral": true
                                        }
                                },
                                {
                                        "DateFormat": {
                                                "DateFormat": "DDMM",
                                                "Delimiter": "-"
                                        }
                                },
                                {
                                        "PageNum": {
                                                "PageNum": 2
                                        }
                                },
                                {
                                        "Section": {
                                                "Section": false,
                                                "Section:N": 5,
                                                "Delimiter": "-+"
                                        }
                                }
                        ]
                }
        }
}

Case2: Configuration

{
        "default": {
                "destinations": [
                        {
                                "S3": {
                                        "bucket": "pagehub-export-test",
                                        "awsRegion": "eu-west-1",
                                        "path": {
                                                "ePaperPath": "Test11/epaperFiles"
                                        },
                                        "ePaperRenaming": true
                                }
                        },
                        {
                                "FTP": {
                                        "hostname": "ftp-mlb.newscyclesolutions.com",
                                        "username": "cct-pagehub-export",
                                        "password": "0A8rn1uc@Y6hNKI",
                                        "path": {
                                                "pdfPath": "test1/pdfFiles",
                                                "inddPath": "test1/inddFiles",
                                                "ePaperPath": "test1/ePaper"
                                        },
                                        "mergePdf": true,
                                        "ePaperRenaming": false,
                                        "exportRenameConfigEpaper": {
                                                "enable": true,
                                                "config": [
                                                        {
                                                                "PageNum": {
                                                                        "PageNum": 3,
                                                                        "Delimiter": "_"
                                                                }
                                                        }
                                                ]
                                        },
                                        "exportRenameConfig": {
                                                "enable": false,
                                                "config": [
                                                        {
                                                                "PageNum": {
                                                                        "PageNum": 1,
                                                                        "Delimiter": "-"
                                                                }
                                                        },
                                                        {
                                                                "PremadePageLiteral": {
                                                                        "PremadePageLiteral": false,
                                                                        "PremadePageLiteral:N": 2,
                                                                        "Delimiter": "-"
                                                                }
                                                        }
                                                ]
                                        }
                                }
                        }
                ],
                "fileFormats": [
                        "pdf",
                        "epaper",
                        "indd"
                ],
                "exportRenameConfig": {
                        "enable": true,
                        "config": [
                                {
                                        "PremadePageLiteral": {
                                                "PremadePageLiteral": true
                                        }
                                },
                                {
                                        "UUID": {
                                                "UUID": true,
                                                "Delimiter": "_"
                                        }
                                },
                                {
                                        "DateFormat": {
                                                "DateFormat": "DDMM",
                                                "Delimiter": "-"
                                        }
                                },
                                {
"PageNum": {
                                                "PageNum": 2
                                        }
                                },
                                {
                                        "Section": {
                                                "Section": false,
                                                "Section:N": 5,
                                                "Delimiter": "-+"
                                        }
                                }
                        ]
                }
        }
}

Case3: Configuration

{
        "default": {
                "destinations": [
                        {
                                "S3": {
                                        "bucket": "pagehub-export-test",
                                        "awsRegion": "eu-west-1",
                                        "path": {
                                                "ePaperPath": "Test11/epaperFiles"
                                        },
                                        "ePaperRenaming": true,
                                        "exportRenameConfigEpaper": {
                                                "enable": true,
                                                "config": [
                                                        {
                                                                "PageNum": {
                                                                        "PageNum": 3,
                                                                        "Delimiter": "_"
                                                                       }               
                                                        },
                                                       {
                                                                "UUID": {
                                                                     "UUID": true,
                                                                     "Delimiter": "_"
                                        }
                                }  
                                                ]
                                        }
                                }
                        },
                        {
                                "FTP": {
                                        "hostname": "ftp-mlb.newscyclesolutions.com",
                                        "username": "cct-pagehub-export",
                                        "password": "0A8rn1uc@Y6hNKI",
                                        "path": {
                                                "pdfPath": "test1/pdfFiles",
                                                "inddPath": "test1/inddFiles",
                                                "ePaperPath": "test1/ePaper"
                                        },
                                        "mergePdf": true,
                                        "ePaperRenaming": true,
                                        "exportRenameConfigEpaper": {
                                                "enable": false,
                                                "config": [
                                                        {
                                                                "PageNum": {
                                                                        "PageNum": 3,
                                                                        "Delimiter": "_"
                                                                }
                                                        }
                                                ]
                                        },
                                        "exportRenameConfig": {
                                                "enable": true,
                                                "config": [
                                                        {
                                                                "PageNum": {
                                                                        "PageNum": 1,
                                                                        "Delimiter": "-"
                                                                }
                                                        },
                                                         {
                                                                 "UUID": {
                                                                       "UUID": true,
                                                                       "Delimiter": "_"
                                        }
                                },
                                                        {
                                                                "PremadePageLiteral": {
                                                                        "PremadePageLiteral": false,
                                                                        "PremadePageLiteral:N": 2,
                                                                        "Delimiter": "-"
                                                                }
                                                        }
                                                ]
                                        }
                                }
                        }
                ],
                "fileFormats": [
                        "pdf",
                        "epaper",
                        "indd"
                ],
                "exportRenameConfig": {
                        "enable": true,
                        "config": [
                                {
                                        "PremadePageLiteral": {
                                                "PremadePageLiteral": true
                                        }
                                },
                                {
                                        "UUID": {
                                                "UUID": true,
                                                "Delimiter": "_"
                                        }
                                },
                                {
                                        "DateFormat": {
                                                "DateFormat": "DDMM",
                                                "Delimiter": "-"
                                        }
                                },
                                {
"PageNum": {
                                                "PageNum": 2
                                        }
                                },
                                {
                                        "Section": {
                                                "Section": false,
                                                "Section:N": 5,
                                                "Delimiter": "-+"
                                        }
                                }
                        ]
                }
        }
}

Case4: Configuration

{
        "default": {
                "destinations": [
                        {
                                "S3": {
                                        "bucket": "pagehub-export-test",
                                        "awsRegion": "eu-west-1",
                                        "path": {
                                                "ePaperPath": "TestNov4/epaperFiles"
                                        },
                                        "ePaperRenaming": true,
                                        "exportRenameConfigEpaper": {
                                                "enable": true,
                                                "config": [
                                                        {
                                                                "PageNum": {
                                                                        "PageNum": 3,
                                                                        "Delimiter": "_"
                                                                       }               
                                                        },
                                                       {
                                                                "UUID": {
                                                                     "UUID": true,
                                                                     "Delimiter": "_"
                                        }
                                }  
                                                ]
                                        }
                                }
                        },
                        {
                                "FTP": {
                                        "hostname": "ftp-mlb.newscyclesolutions.com",
                                        "username": "cct-pagehub-export",
                                        "password": "0A8rn1uc@Y6hNKI",
                                        "path": {
                                                "pdfPath": "TestNov4/pdfFiles",
                                                "inddPath": "TestNov4/inddFiles",
                                                "ePaperPath": "TestNov4/ePaper"
                                        },
                                        "mergePdf": true,
                                        "ePaperRenaming": true,
                                        "exportRenameConfigEpaper": {
                                                "enable": false,
                                                "config": [
                                                        {
                                                                "PageNum": {
                                                                        "PageNum": 3,
                                                                        "Delimiter": "_"
                                                                }
                                                        }
                                                ]
                                        },
                                        "exportRenameConfig": {
                                                "enable": false,
                                                "config": [
                                                        {
                                                                "PageNum": {
                                                                        "PageNum": 1,
                                                                        "Delimiter": "-"
                                                                }
                                                        },
                                                        {
                                                                "PremadePageLiteral": {
                                                                        "PremadePageLiteral": false,
                                                                        "PremadePageLiteral:N": 2,
                                                                        "Delimiter": "-"
                                                                }
                                                        }
                                                ]
                                        }
                                
                        }},
                        {
                                "SFTP": {
                                         "hostname": "sftp.saas-dev.infomaker.io",
                                        "port": 22,
                                        "username": "pagehub-export-sftp",
                                        "privateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAopAaz9ho30h2+x0KArPNpteV7kYHSTEMHyg66JRjlc6ePcjAg3kGiPSU2qKQ\n8Vhn9ebI+5Hz/FFFvJwo5nqkRr8CVtKmk2FQoZzYi/t+h0j64/OqOFt/kNkN1qyqFRF2ymMPX+QW\nFeddJQcCHKVsqLde9I5tSGN3sF5ZOjesjT22yrqCqWFxdICbVyKgRMBlKRsvpd8h4rk10+YrKaaC\nP5xJZ3SJD6zQipdBpc81AXlbd60Nb0NgsDaIwh80ur0aXeG1j39zf3UBs+tVobKuh4t4HxzKxXA5\nUAxIljZ5Q+FyzppimiKhs3a2vIM83Kd1OaKTJgURn1998JhsGPm7ZwIDAQABAoIBAFd9x3BlwMur\nbJ3qGyEpNF2/WepLtlAmHagHNu1GL/LIqVIHYdVgpavANv0U0X2TXyBxfWooO3BpLWc9hKXHC/Mn\nilLAPPbFQWg5yjJMwOR+2skks1Bxrk5/A3uuojuEkrKKbhPl5h0T0IXFJ9XTEpAbYPeuUBLNtfUu\nUkeK/0tkM+1twdUGKvkrkOqm46F3X2Ud9HAt7GvRiF2Vf1sHQrTt8Y0xfgatmYaZVtdFHY3EvLc9\nTqnBsNn4xg+mPi2P7mZANlUarrgScKdF/3OROVxtJHFbet1uBoH81ROWxZm5pPnk77vO8zLx48nR\nWmhTBI5DO7MiBTyIQOFPNQUR4MECgYEA95QFz0EyixSXlsiJFWbwrBlDbTMyiBoBvNWkRFcKNjac\nT6cYQlYsGFIKcSHHYU+4AWv/pfMxpZlW6GcPtIwcNoaH6qsVyhmpVemz8p7hE3FPHkV1UBUHR3rH\nTQN4VEGYLTc6rSnwyV3aJiRHmtHNPe3ZSw75C+puGZY0ZJxIai0CgYEAqBe++7u8ZkrYDFm0q5yG\n2PbHX97UG7dtwp+hUkso03dBxaVlqLvbaaGQuSuDhjehzjNvlRIo4Qk3iJrXMgBsi+ON14Lq4d98\nwhLc7ww4V3XgX29mPmm9oUyuUN1iR7oei/8ApdBbTyz9EybMaVxVY+/umhZAKQUHtP3Hj7ri3GMC\ngYBnGrkUqAVBkJDU1azpQdaHBXpkFsc7kQEaQCrJ3ym8jB+quF7M+ZAhjMEWfkfHSejKhsyPsukB\nGwvre0g6G4OAXaRq4VcQtIEl607qgqofa7fUVn7Vm/xNE1++vew1wp96bR69kNLbOX+pFMDRRABi\ngxRUQucKxFWXyEsHf2JU/QKBgBdVHHyC5bbpQq4MMaj0lD8/mhMzsgua3ZB7agArUKJx1l5iBAd0\n9BLoi1c4tAwIYtxlhWKS37vE9MFwhNh6+JY+Yuz8TjBGPmIODj7cWmHBigCVTQLy2JCwPS4aXM8K\nBb13Cxb5IgOOgh6Lbypc17mEj4Ex/3vyJ8y2wWGxFlZzAoGBAO1Z0q7m0471MkyUJYUu/Kfz0ibr\nQYctwiv9mRS5f11/0h57jmYs2SvnJqZmPUwWPBhzA54nXlG0Clb5k9CcdylxGiePUxi35fS9B3ra\nysY6RrVigEpArxiO/cShfeGJA3tL2Rn/761GxU5uig0oOyjqtjrLAzQ6fwr+E/pNqreT\n-----END RSA PRIVATE KEY-----",
                                        "path": {
                                                "pdfPath": "testNov4/pdfFiles",
                                                "inddPath": "testNov4/inddFiles",
                                                "ePaperPath": "testNov4/ePaper"
                                        },
                                        "mergePdf": true,
                                        "ePaperRenaming": true,
                                        "exportRenameConfigEpaper": {
                                                "enable": true,
                                                "config": [
                                                        {
                                                                "PageNum": {
                                                                        "PageNum": 3,
                                                                        "Delimiter": "_"
                                                                }
                                                                }, 
                                                                {
                                        "UUID": {
                                                "UUID": true,
                                                "Delimiter": "_"
                                        }
                                                                
                                                        }
                                
                                                ]
                                        },
                                        "exportRenameConfig": {
                                                "enable": false,
                                                "config": [
                                                        {
                                                                "PageNum": {
                                                                        "PageNum": 1,
                                                                        "Delimiter": "-"
                                                                }
                                                        },
                                                        {
                                                                "PremadePageLiteral": {
                                                                        "PremadePageLiteral": false,
                                                                        "PremadePageLiteral:N": 2,
                                                                        "Delimiter": "-"
                                                                }
                                                        }
                                                ]
                                        }
                                }
                        }

                ],
                "fileFormats": [
                        "pdf",
                        "epaper",
                        "indd"
                ],
                "exportRenameConfig": {
                        "enable": true,
 "config": [
                                {
                                        "PremadePageLiteral": {
                                                "PremadePageLiteral": true
                                        }
                                },
                                {
                                        "UUID": {
                                                "UUID": true,
                                                "Delimiter": "_"
                                        }
                                },
                                {
                                        "DateFormat": {
                                                "DateFormat": "DDMM",
                                                "Delimiter": "-"
                                        }
                                },
                                {
"PageNum": {
                                                "PageNum": 2
                                        }
                                },
                                {
                                        "Section": {
                                                "Section": false,
                                                "Section:N": 5,
                                                "Delimiter": "-+"
                                        }
                                }
                        ]
                }
        }

Last updated