Template-basierte HTML Reports – Benutzerdefinierte Parameter mit JavaScript steuern

Das JS-Objekt app.context.report.manifest ermöglicht die Anpassung der manifest.xml für einen benutzerdefinierten PDF-Bericht innerhalb eines Prozessplans oder Profils. Sie können dieses JS-Objekt innerhalb einer Variable in der pdfToolbox verwenden, um bestimmte Abschnitte/Bereiche der manifest.xml zu aktivieren/deaktivieren und neue Werte für Parameter mittels JavaScript zu setzen.

Sobald ein app.context.report.manifest JS-Objekt angegeben ist, überschreiben die in diesem Objekt festgelegten Parameter die Werte in der manifest.xml. Für jeden Parameter, für den kein benutzerdefinierter Wert in app.context.report.manifest festgelegt wurde, werden die Werte aus dem manifest.xml verwendet.

Deaktivieren eines bestimmten Bereichs im manifest.xml über das JavaScript-Objekt app.context.report.manifest

Um einen bestimmten Bereich in der manifest.xml zu deaktivieren, gibt es zwei verschiedene Möglichkeiten:

//Option 1 (null)

app.context.report.manifest = {
	"resources" : {
		"results": {
			"pageinfo": null
		}
	}
};


//Option 2 (false)


app.context.report.manifest = {
	"resources" : {
		"results": {
			"pageinfo": false
		}
	}
};
Click to copy

Aktivierung eines bestimmten Bereichs im manifest.xml über das JavaScript-Objekt app.context.report.manifest

Um einen bestimmten Bereich in der manifest.xml zu aktivieren, gibt es drei verschiedene Möglichkeiten:

//Option 1 (leeres Object)


app.context.report.manifest = {
	"resources" : {
		"results": {
			"pageinfo": {}
		}
	}
};


//Option 2 (true)


app.context.report.manifest = {
	"resources" : {
		"results": {
			"pageinfo": true
		}
	}
};


//Option 3 (mindestens ein Parameter für diesen Bereich ist definiert)


app.context.report.manifest = {
	"resources" : {
		"results": {
			"pageinfo": {
				"resolution": 72
			}
	}
};
Click to copy

app.context.report.manifest ist als JavaScript Codeschnipsel verfügbar

Um die Anwendung zu vereinfachen, steht das JS-Objekt app.context.report.manifest als Code-Schnipsel in pdfToolbox zur Verfügung. Nach dem Einfügen des JavaScript-Snippets erhält man das JS-Objekt mit allen manifest.xml-Abschnitten und Standardwerten. Dieses kann dann leicht an die eigenen Bedürfnisse angepasst werden.

  1. Klicken Sie auf das blaue Info-Symbol neben dem Skript-Editor in pdfToolbox
  2. Klicken Sie auf „JavaScript Codesnippets einfügen...“.
  3. Es öffnet sich ein neues Fenster, in dem Sie das JS-Objekt app.context.report.manifest auswählen und einfügen können
Vollständiges app.context.report.manifest JavaScript-Objekt mit allen Report-Parametern 
  app.context.report.manifest = {
  "settings": {
    "keeptemp": false,
    "defaults": {
      "resolution": 20
    }
  },
  "resources": {
    "dict": {
      "overview": true
    },
    "results": {
      "xmlreport": {
        "path": "xml/report.xml",
        "inkcovres": 10,
        "inkcovbox": "CropBox"
      },
      "jsonreport": {
        "path": "json/report.json",
        "quickcheck": "default"
      },
      "jsonv2report": {
        "path": "jsonv2/report.json",
        "inkcovres": 10,
        "inkcovbox": "CropBox",
        "quickcheck": "none"
      },
      "preview": {
        "resolution": 20,
        "pageselector": "1"
      },
      "inkamountheatmaps": {
        "resolution": 20,
        "threshold": 300,
        "onlyproblems": true,
        "pageselector": "all",
        "show": true
      },
      "inkcoverage": {
        "resolution": 10,
        "pagebox": "CropBox",
        "pageselector": "all",
        "show": true
      },
      "spotcolors": {
        "pageselector": "all",
        "show": true
      },
      "separations": {
        "resolution": 20,
        "type": "spotifpresent",
        "pageselector": "all",
        "show": true
      },
      "pageinfo": {
        "pageselector": "1",
        "resolution": 20,
        "safetyzoneinside": "3mm",
        "safetyzoneoutside": "3mm",
        "usebleedbox": false,
        "unit": "mm",
        "show": true
      },
      "imageresolution": {
        "resolution": 20,
        "type": "img",
        "imgthreshold": 150,
        "bmpthreshold": 550,
        "onlyproblems": true,
        "pageselector": "all",
        "show": true
      },
      "smallobjects": {
        "resolution": 20,
        "type": "all",
        "threshold": "medium",
        "onlyproblems": true,
        "pageselector": "all",
        "show": true
      }
    }
  }
};
Click to copy