Skip to main content
Administrator Guide
Last Updated: 2023-06-23
Reference: FOP Step Properties

Reference: FOP Step Properties

Common Tab

Property
XML Attribute Name
Description
Step Id
id
The unique ID of the
fop
mediation step within the assembly.
Input
input
Specifies where the
fop
mediation step obtains data as input. There are 5 possible values:
  • message
    : the entire message, including
    rootpart
    and attachments.
  • soapbody
    : the content of the SOAP body from the
    rootpart
    of the message. Only applicable when the input contains a SOAP message.
  • attachment
    : a MIME attachment within the message. You must specify the attachment index.
  • rootpart
    : the content of the root part of a MIME message. If the message isn't MIME, the entire message is selected.
  • variable
    : use a named variable from the
    MediationContext
    .
Output
output
Specifies where the
fop
mediation step directs the output. There are 5 possible values:
  • message
    : the entire message, including
    rootpart
    and attachments. This value creates a new message, effectively removing any attachments.
  • soapbody
    : the content of the SOAP body from the
    rootpart
    of the message.
  • attachment
    : a MIME attachment to the message. You must specify the attachment index.
  • rootpart
    : the content of the root part of a MIME message, or if the message isn't MIME, the message itself. This value preserves any attachments on the original message.
  • variable
    : save the output as a named variable in the
    MediationContext
    .
Author
author
Specifies an
author
value in the metadata of the document.
Base Url
base-url
The base URL that's used to resolve relative URLs. This location is also used for relative font locations, if no
font-base-url
is specified. It can be a relative path to the project's
WSAR-INF
or an absolute URL. Example:
./fop
Creation Date
creation-date
Specifies a
creation date
value in the metadata of the document. Enter the value using the US date format. Example:
5/14/08 4:50 PM
.
Creator
creator
Specifies a
creator
value in the metadata of the document.
Keywords
keywords
Specifies a
keywords
value in the metadata of the document.
Title
title
Specifies a
title
value in the metadata of the document.
User Password
user-password
Enables you to set a user password for PDF and RTF documents. The password enables these document privileges:
  • allow-copy-content
  • allow-edit-annotations
  • allow-edit-content
  • allow-print

Advanced Tab

Property
XML Attribute Name
Description
Description
description
A description of the
fop
mediation step that displays in the consolidated log. You can use this feature to describe the step's function and the data on which it is operating.
Execute When
execute-when
A condition that determines whether the
fop
step executes.
Allow Copy Content
allow-copy-content
Specifies whether you can copy and paste content from the document when you access it using the
user-password
.
Allow Edit Annotations
allow-edit-annotations
Specifies whether you can edit annotations within the document when you access it using the
user-password
.
Allow Edit Content
allow-edit-content
Specifies whether you can edit content within the document when you access it using the
user-password
.
Allow Print
allow-print
Specifies whether you can print the document when you access it using the
user-password
.
Configuration Xml
configuration-xml
The path to the Apache FOP XML configuration file, which must be on your local disk and not a URL. This configuration file is the only way to register custom fonts.
Creation Date Format
creation-date-format
The date format used to parse the
creation-date
XML attribute. Supports these values:
  • full
  • long
  • medium
  • short
Creation Date Locale Country
creation-date-locale-country
The
country
value used to parse the
creation-date
XML attribute.
Creation Date Locale Language
creation-date-locale-language
The
language
value used to parse the
creation-date
XML attribute. The value must be a lowercase two-letter ISO-639 language code.
Creation Time Format
creation-time-format
The time format used to parse the
creation-date
XML attribute. Supports these values:
  • full
  • long
  • medium
  • short
Font Base Url
font-base-url
The base URL that's used to resolve relative font URLs. Example:
./fop/fonts
Hyphenation Base Url
hyphenation-base-url
The base URL that's used to resolve relative URLs to hyphenation-pattern files.
Owner Password
owner-password
Enables you to set an owner password for PDF and RTF documents. The password enables these document privileges:
  • allow-copy-content
  • allow-edit-annotations
  • allow-edit-content
  • allow-print
Producer
producer
Specifies a
producer
value in the metadata of the document.
Target Resolution
target-resolution
The output resolution in dots per inch (DPI) for bitmap images generated by bitmap renderers, such as the TIFF renderer and Apache Batik.