PrintPostExecutor

The PrintPostExecutor enables access to Print documents created in Lobster Data Platform / Orchestration from a profile. These Print documents are interpreted with the data provided for 'post-execution' in order to generate a specific output format.

Typically, the data to be interpreted is available as print XML, i.e. it represents a Print object that contains the data of one or more entities. Print documents usually expect content in this format to be 'read' using XPath expressions. The principle corresponds in this respect to the interactive 'printing' for overviews and entry forms selected entities via the ribbon macros of the main category 'Export' (see also Available commands, 'Print').

In the interactive process, Print documents applicable to each Print type are determined according to Association criteria and the all-matching principle and either automatically assigned or offered for interactive selection. In contrast, the PrintPostExecutor expects that the print document to be used is clearly identified by its ID (id). As further parameters the Print type and login data for Lobster Data Platform / Orchestration (as Integration login) are expected (see below).

The PrintPostExecutor can be configured within a profile in phase 5 (for the output data of an 'Integration Unit') and phase 6 (for the output data of a response path).

Suitable parameters must be provided either directly as a parameter list or in a properties file identified by the file path in the Configuration file field (see examples).

Parameter

Property

Parameter

Description

Note

Print Document ID

1

internal ID of the print document in Lobster Data Platform / Orchestration


Print Type

2

internal name for the Print type (PDF, RTF, DOCX, XLSX, TXT, HTML, ZPL)

The selected Print type must match the print document type of the print document specified by parameter 1.

Scm Login

3

Integration login in XML format (LobsterDataLoginRequest object)

The function Create Login Request (Integration function) can be used to create a suitable structure.

  • The company selected in the login data must have read access to the print document type specified by parameter 1.

  • The role selected in the login is only relevant with regard to the 'owner restrictions'.

  • Other role rights ('Print', 'Print documents') are not relevant.

NOTE◄ The interactive availability of print documents (based on Association criteria) is not crucial for direct access via PrintPostExecutor. 'Super user' role selection ensures access to all Print documents without having to adjust Company authorizations or owner assignments.

Example:

<base:LobsterDataLoginRequest xmlns:base="SCM.BASE" userName="admin" selectedRole="1" selectedCompany="1" />

Examples

The following examples show how to pass the same parameters as a parameter list and as a properties file:

  • Example 1: Parameter list in phase 5 (e.g. for an XMLNoTemplateUnit):

    images/download/attachments/201674689/image2020-11-2_19-12-36-version-1-modificationdate-1747113533958-api-v2.png



  • Example 2: Path to a properties file (with the same parameter values, see below) in phase 6:

    images/download/attachments/201674689/image2020-11-2_19-13-30-version-1-modificationdate-1747113533960-api-v2.png

    ./conf/demo/postPrint_101_TXT_varLOGIN.properties
    # PARAMETERS 'Print Document ID', 'Print Type', 'Scm Login'
    # ==========================================================
    # Blanks in parameter names MUST be escaped by backslash '\'
    # ==========================================================
    #
    Print\ Document\ ID=101
    Print\ Type=TXT
    Scm\ Login=@var__LOGIN_REQUEST@

As the examples illustrate, references to profile variables (in the format @VARIABLE_NAME@) can be used for parameterization in both cases


.