A complex data type that stores run-time options
that specify how the Forms service renders form guides.
FormGuideRenderSpec
variables
are used to the configure Form Guide Render Options property of
the renderFormGuide operation
in the
Forms
service.
In AEM forms version 8 and earlier, this data type was called
ActivityGuideRenderSpec.
This data type is useful only when you are using the renderFormGuide
operation with a form design and embedded guide created in Designer
8.2. Form designs created using Designer cannot be used with the
renderFormGuide operation.
For information about data that can be accessed using Xpath Expressions,
see
Data items
.
For information about configuring default properties, see
Datatype specific settings
.
Data items
The data items that
FormGuideRenderSpec
variables
contain.
CB
A
boolean
value
that determines whether the Forms service generates a form guide
with an HTML template. An HTML template is a HTML code that launches the
form guide. A value of
true
indicates to generate
an HTML template with the form guide and
false
indicates
not to generate the HTML template with the form guide.
guideAccessible
A
boolean
value
that indicates whether the form guide is accessible. A value of
true
indicates
the form guide is created to be accessible and
false
indicates that
it is not.
guideCBURL
A
string
value
that represents the URL for a custom override implementation of
the callback servlet.
guideName
A
string
value
that represents the name of the guide within the generated form
guide.
guidePDF
A
boolean
value
that determines whether the output is rendered in the form guide
and PDF form. A value of
true
indicates that both
the form guide and PDF form are rendered and
false
indicates
that only the form guide is rendered.
guideRSL
A
boolean
value
that determines whether to use run-time shared libraries when compiling
a form guide. A value of
true
indicates that shared
libraries are used and
false
indicates they are
not used.
guideStyle
A
string
value
that represents the name of the style sheet that the form guide uses.
The style sheet is also embedded in the form guide. The application container
contains the style sheet, or the style sheet can be referenced.
guideSubmitAll
A
boolean
value
that determines whether the form guide submits all data including
hidden panels. A value of
true
indicates that all
data is submitted and
false
indicates that all
data is submitted except for data from hidden panels.
ifModifiedSince
For
internal use only.
injectFormBridge
A
boolean
value
that determines whether the Forms service inserts special JavaScript™ code into a PDF form. The JavaScript code
performs operations on a PDF form when the form guide is rendered.
A value of
true
indicates that the Forms service
inserts the JavaScript code and
false
indicates
that it does not.
Datatype specific settings
Properties for configuring the form guide that the variable
represents.
If Modified Since
For internal use only.
Guide Name
Sets the name of the guide from the form design.
You can create more than one guide for each form design. The first
guide is used if no value is provided.
Guide RSL
Sets whether to use shared run-time libraries for
compiling a form guide. The default value is False. Select one of
these values:
-
False:
-
Do not use the shared run-time libraries.
-
True:
-
Use the shared run-time libraries.
Guide PDF
Sets whether the PDF form is rendered with the form
guide. The default value is True. Select one of these values:
-
True:
-
Render a PDF form with the form guide.
-
False:
-
Do not render a PDF form with the form guide.
Guide Accessible
Sets whether the form guide compilation is
accessible. The default value is False. Select one of these values:
-
False:
-
The form guide compilation is not accessible.
-
True:
-
The form guide compilation is accessible.
Guide CB Url
Sets the location for a custom override implementation
of the callback servlet. The value must be a valid URL expressed
as a string value.
Locale
Sets
the language used to send validation messages to client applications,
such as web browsers, when a form guide is rendered. The default
value is <Use Server Default>. Select a language from the
list or one of these values.
-
<Use Server
Default>:
-
Use the Locale setting configured on AEM forms Server. The
Locale setting is configured in administration console. (See
AEM forms administration help
.)
-
<Use Custom Value>:
-
Use a locale that is not available in the list. After selecting
this option, in the text box beside the list, type the Locale ID
of the locale code to use. For a complete list of supported locale
codes, see http://java.sun.com/j2se/1.5.0/docs/guide/intl/locale.doc.html.
Cb
Sets
whether the Forms service generates a form guide with an HTML template. An
HTML template is a HTML code that launches the form guide. The default value
is False. Select one of these values:
-
False:
-
The form guide is provided with an HTML template.
-
True:
-
Only the form guide is provided.
Guide Style
Sets the name of the cascading style sheet (CSS),
such as CobaltBar.css, that the form guide layout uses to provide
a customized appearance. For example, can use the following CSS
files that you can also export from Designer. (See
Designer Help
and the
Customizing Form Guides using CSS: Missing
in action
blog entry.)
Guide Submit All
For example, in your form guide, you can choose
to only expose a subset of fields to a user. For example, you can
choose to hide some of the values in a hidden panel. Regardless
of whether the user modifies the fields, you want all the data submitted,
including the data in the hidden panels. The default value is False. Select
one of these values:
-
False:
-
Does not submit all data. Only the data modified by the user
is submitted.
-
True:
-
Submits all data, including hidden panels.
Inject Form Bridge
Sets whether special JavaScript code is inserted
in the form design. The JavaScript code permits the rendered form
guide to be used in Workspace. The default value is False. Select
one of these values:
-
False:
-
Does not enable the PDF form for use in Workspace.
-
True:
-
Enables the PDF form for use in Workspace.
|
|
|