Export Config
The tab under configurations opens the export configuration which allows to determine the export page details and locations when artifacts are exported using the Publish button from PageHub.
The configuration contains three parts:
Destinations
File Formats
Export Rename Config
The function of each part is:
Destinations - This part of the configuration is used to determine the destination where the artifacts will be exported. The possible locations are: a. FTP
FTP the configuration details:
"destinations": [ { "FTP": { "hostname": "<host name goes here>", "username": "<FTP User Name goes here>", "password": "<FTP Password goes here>", "path": { "pdfPath": "<Folder path for pdf files>", "inddPath": "<Folder path for indd files>", "ePaperPath": "<Folder path for ePaper files>" } } } ],b. SFTP
SFTP the configuration details:
"destinations": [ { "SFTP": { "hostname": "<SFTP Hostname goes here>", "port": <SFTP Port number goes here>, "username": "<SFTP Username goes here>", "password": "<SFTP Password goes here>", "path": { "pdfPath": "<Folder path for pdf files>", "inddPath": "<Folder path for indd files>", "ePaperPath": "<Folder path for ePaper files>" } } } ],c. S3
S3 the configuration details:
"destinations": [ { "S3": { "bucket": "<S3 Bucket Name goes here>", "awsRegion": "<S3 Region goes here>", "path": { "pdfPath": "<S3 Path goes here for PDF Files>", "ePaperPath":"<S3 Path goes here for e-PaperFiles>", "inddPath": "<S3 Path goes here for indd Files>" } } } ],
*Note: In S3 if path is defines with forward slash and no folder with the name exists then the folder is created in S3
File Formats - This part of the configuration defines the file formats which need to be exported when the publish artifacts button is clicked. These artifacts are exported the destinations which are defined in destinations part of the configuration. Possible file formats are: a. PDF b. INDD c. e-Paper File format configuration details:
"fileFormats": [
"indd",
"pdf",
"epaper"
],Export Rename Config - This part of the configuration is used to define the names of the files when exported. The detail which can be configured are as follows:
Override for Publication: If there is a case when a user wants to override these configurations for particular publication to set it different than what is set they can specify in the configuration separate as shown in sample configuration below under 'PMS_AGP1' configuration part. Important Points & Exceptions: 1. Allowed delimiters for S3: (- _ + *) 2. Allowed delimiters for FTP: (- _ +) 3. Allowed delimiters for SFTP: (- _ +) 4. Duplicate objects are not allowed 5. Custom field is optional 6. No special character is allowed in Custom field 7. Path : At least one path should be provided for export 8. PageNum is compulsory in Export rename config 9. Only (1,2,3) values are allowed in the PageNum value 10. There should be positive integer value in the config under exportRenameConfig 11. No back slash is allowed 12. A maximum of three custom fields are allowed 13. There should be at least one destination Sample Configuration:
{
"default": {
"destinations": [
{
"S3": {
"bucket": "pagehub-export-test",
"awsRegion": "eu-west-1",
"path": {
"ePaperPath": "DA11nmm-Test/epaperfiles",
"inddPath": "DA11nmm-Test/inddfiles"
}
}
}
],
"fileFormats": [
"indd",
"epaper"
],
"exportRenameConfig": {
"enable": true,
"config": [
{
"PageNum": {
"PageNum": 2,
"Delimiter": "-"
}
},
{
"PremadePageLiteral": {
"PremadePageLiteral": false,
"PremadePageLiteral:N": 2,
"Delimiter": "-"
}
},
{
"Section": {
"Section": false,
"Section:N": 5,
"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": [
{
"FTP": {
"hostname": "<some host name>",
"username": "<some user name>",
"password": "<some passwrod>",
"pageInfoXML": false,
"path": {
"pdfPath": "testPdf11nnp-dash",
"inddPath": "testIndd11nnp-dash",
"ePaperPath": "testEPaper11nnp-dash"
}
}
}
],
"fileFormats": [
"indd",
"pdf",
"epaper"
],
"exportRenameConfig": {
"enable": true,
"config": [
{
"PageNum": {
"PageNum": 2,
"Delimiter": "-"
}
},
{
"PremadePageLiteral": {
"PremadePageLiteral": true,
"PremadePageLiteral:N": 2,
"Delimiter": "-"
}
},
{
"Section": {
"Section": true,
"Section:N": 5,
"Delimiter": "-+"
}
},
{
"PagePrefix": {
"PagePrefix": true,
"PagePrefix:P": "default/Prefix",
"Delimiter": "-"
}
},
{
"Edition": {
"Edition": false,
"Edition:N": 5,
"Delimiter": "+"
}
},
{
"DateFormat": {
"Delimiter": "_-+_",
"DateFormat": "DD-MM-YY"
}
},
{
"Part": {
"Part": true,
"Part:N": 3,
"Delimiter": "--"
}
},
{
"Custom1": {
"Custom1": "custom11",
"Delimiter": "-"
}
},
{
"Custom2": {
"Delimiter": "-_",
"Custom2": "custom22"
}
}
]
}
},
"STF_PST1": {
"destinations": [
{
"SFTP": {
"hostname": "<some hostname>",
"port": 22,
"username": "<some user name>",
"privateKey": "<some key like this> -----BEGIN RSA PRIVATE KEY-----\nMIthyu7746HHAgfPNpteV7kYHSTEMHyg66JRjlc6ePcjAg3kGiPSU2pUtc\l5NghtyTRE/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-----",
"pageInfoXML": true,
"path": {
"ePaperPath": "dash-epaper",
"inddPath": "dash-indd",
"pdfPath": "dash-pdf"
}
}
}
],
"fileFormats": [
"pdf",
"indd",
"epaper"
],
"exportRenameConfig": {
"enable": true,
"config": [
{
"PremadePageLiteral": {
"PremadePageLiteral": false,
"PremadePageLiteral:N": 4,
"Delimiter": "-"
}
},
{
"PagePrefix": {
"PagePrefix": false,
"PagePrefix:P": "agp/Prefix",
"Delimiter": "-"
}
},
{
"PageNum": {
"PageNum": 3,
"Delimiter": "-"
}
},
{
"Part": {
"Part": true,
"Delimiter": "-"
}
},
{
"Section": {
"Section": true,
"Delimiter": "-"
}
},
{
"Edition": {
"Edition": true,
"Delimiter": "-"
}
},
{
"DateFormat": {
"DateFormat": "MM-DD-YYYY",
"Delimiter": "-"
}
},
{
"Custom1": {
"Custom1": "custom"
}
}
]
}
}
}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 inexport settings.
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 fille 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.
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.
Case3
1 Product
Two locations
Different Rename logic at Location level for different files indd and pdf
Case4
1 Product
Multiple locations (S3, FTP, SFTP)
Different Rename logic at Location level
Merged Pdf
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": "-"
}
}
]
}
}
}Case 2 Sample configuration:
{
"default": {
"destinations": [
{
"S3": {
"bucket": "pagehub-export-test",
"awsRegion": "eu-west-1",
"path": {
"ePaperPath": "MultiDestination1/epaperfiles",
"inddPath": "MultiDestination1/inddfiles",
"pdfPath": "MultiDestination1/pdffiles"
},
"mergePdf": true,
"exportRenameConfigPdf": {
"enable": true,
"config": [
{
"PageNum": {
"PageNum": 3,
"Delimiter": "_"
}
}
]
},
"exportRenameConfigIndd": {
"enable": true,
"config": [
{
"PageNum": {
"PageNum": 3,
"Delimiter": "_"
}
},
{
"DateFormat": {
"Delimiter": "+--_",
"DateFormat": "MM-DD-YY"
}
}
]
},
"exportRenameConfig": {
"enable": true,
"config": [
{
"PageNum": {
"PageNum": 3,
"Delimiter": "_"
}
},
{
"PremadePageLiteral": {
"PremadePageLiteral": false,
"PremadePageLiteral:N": 3,
"Delimiter": "_+"
}
},
{
"Section": {
"Section": false,
"Section:N": 5,
"Delimiter": "+-_"
}
}
]
}
}
}
],
"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_AGP": {
"destinations": [
{
"S3": {
"bucket": "pagehub-export-test",
"awsRegion": "eu-west-1",
"path": {
"ePaperPath": "MultiDestination1/epaperfiles",
"inddPath": "MultiDestination1/inddfiles",
"pdfPath": "MultiDestination1/pdffiles"
},
"mergePdf": true,
"exportRenameConfigPdf": {
"enable": true,
"config": [
{
"PageNum": {
"PageNum": 3,
"Delimiter": "_"
}
}
]
},
"exportRenameConfigIndd": {
"enable": true,
"config": [
{
"PageNum": {
"PageNum": 3,
"Delimiter": "_"
}
},
{
"DateFormat": {
"Delimiter": "+--_",
"DateFormat": "MM-DD-YY"
}
}
]
},
"exportRenameConfig": {
"enable": true,
"config": [
{
"PageNum": {
"PageNum": 3,
"Delimiter": "_"
}
},
{
"PremadePageLiteral": {
"PremadePageLiteral": false,
"PremadePageLiteral:N": 3,
"Delimiter": "_+"
}
},
{
"Section": {
"Section": false,
"Section:N": 5,
"Delimiter": "+-_"
}
}
]
}
}
}
],
"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": "-"
}
}
]
}
}
}Last updated