Enumerate Profiles

Generate XML report of all Profiles and optional generates a Profile summary report:

--enumprofiles [--format=format] [--cachefolder=cachefolder] [--relativepath] [--profilesummary=profilesummary] <profile (folder)> <report file>
Click to copy

Options

format XML, JSON, JSON_COMPACT (Default: XML)
cachefolder sets the cache folder path
relativepath writes the path in the XML as relative POSIX path
profilesummary create an additional PDF summary report, any of: 
PDF (PDF summary - default)
CSV (comma-separated file with all Fixups and Checks)
CSVVAR (comma-separated file with all Variables)

Arguments

profile (folder) pdfToolbox Profile or folder containing pdfToolbox Profiles
report file Destination path for profile summary report

JSON format example

For the attached Profile, the CLI execution call:

./pdfToolbox --enumprofiles --format=JSON ./"Enlarge page at edges.kfpx" ./"Enlarge page at edges.kfpx.json"
Click to copy
Enlarge_page_at_edges.kfpx

creates a JSON file like below:

{
	"information" : 
	{
		"computername" : "ws-osx-cso",
		"date_time" : "2021-06-01T16:33:22+02:00",
		"operating_system" : "macOS 10.15.7",
		"product_name" : "pdfToolbox",
		"product_version" : "12.3 (565)",
		"username" : "callas software"
	},
	"profiles" : 
	[
		
		{
			"comment" : "",
			"creation_date" : "2021-06-01T14:12:22+02:00",
			"modification_date" : "2021-06-01T14:12:22+02:00",
			"name" : "Enlarge page at edges",
			"path" : "/Users/callassoftware/Enlarge page at edges.kfpx",
			"size" : "6666",
			"variables" : 
			[
				
				{
					"key" : "Add_mm_bottom",
					"label" : "Add [mm] (bottom)",
					"type" : "Float",
					"value" : 0.0
				},
				
				{
					"key" : "Add_mm_left",
					"label" : "Add [mm] (left)",
					"type" : "Float",
					"value" : 0.0
				},
				
				{
					"key" : "Add_mm_right",
					"label" : "Add [mm] (right)",
					"type" : "Float",
					"value" : 0.0
				},
				
				{
					"key" : "Add_mm_top",
					"label" : "Add [mm] (top)",
					"type" : "Float",
					"value" : 0.0
				}
			],
			"vars" : 
			{
				"Add_mm_bottom" : 0.0,
				"Add_mm_left" : 0.0,
				"Add_mm_right" : 0.0,
				"Add_mm_top" : 0.0
			}
		}
	]
}
Click to copy
  • The "variables" object provides all information about a variable incl. a label name. This can be used for example, to build a generic UI. 
  • The "vars" object provides only key and value pairs and can directly be used in APIs.