Guides Utilities service settings

When you create a Guide, some resources, such as the Guide definition, are embedded in the Guide. Resources can also exist as references to application assets stored locally or on the LiveCycle server. The Guide does not contain data, and the values for the submit location and inputs are not suitable for all external environments.

In most cases, the default Guides render services is sufficient to prepare a Guide for use in Workspace or other external environments. (In the Services view, in Workbench, the default service is Guides (system)/Processes/Render Guide - 1.0.) The Guide Utilities service (GuidesUtility) allows you to create a customized process for rendering a Guide, if necessary.

The Guide Utilities operations allow you to add the following Guide rendering tasks to a process:

  • Determine whether data is available to populate the Guide with

  • Embed the Guide data or convert it to a link

  • Convert referenced content to URLs that are externally accessible

  • Substitute values in an HTML document or other wrapper, or convert them to URLs that are externally accessible

  • Set the submit location

  • Specify input values

  • Create a parameter to represent referenced content

  • If variations are available, set a variation

The default values for the Guide Utilities service support most use cases. However, if necessary, you can change the following values.

publicPaths:
This option has been deprecated. Do not use this option with LiveCycle ES3.

pathInfoExpiryInSeconds:
The interval after which a request for path information from a client expires. Default is 1.

collateralExpiryInSeconds:
The interval after which a request for collateral from a client expires. Default is 315576000.

mismatchExpiryInSeconds:
The interval after which a request for collateral from a client expires, when the eTag (entity tag) does not match. (An eTag is an HTTP response header.) Default is 1.

guideContext:
The context root of the Guides web application. Matches the value set using the Guides web application. Default is /guides/.

secureRandomAlgorithm:
The algorithm to use when generating keys and identifiers. This value is passed to the getInstance method of the SecureRandom Java class. Default is SHA1PRNG.

idBytes:
The number of random bytes to use for a key identifier. Default is 6.

macAlgorithm:
The MAC (message authentication code) algorithm to use for collateral URL verification. This method is passed to the getInstance method of the Mac class. Default is HmacSHA1.

macRefreshIntervalInMinutes:
The amount of time a key is active. When a key has been active for this interval, a new key is generated. The new key becomes the active key. The previously active key is kept for 10% of the refresh interval. This behavior allows URLs that are generated by using the old key to continue to work across the key switch. Default is 144000.

macOverlapIntervalInMinutes:
Length of time that the previous key will remain valid after a new one is generated. The default is 1440 minutes (1 day).

macKeySeed:
A seed value for generating the secure URL. When this is option, the key is never refreshed. Setting the same seed on different servers will result in those servers generating secure URLs that are compatible. This may be useful if multiple LiveCycle servers are in use behind a load balancer. Enter a random sequence of characters and numbers as the seed.

// Ethnio survey code removed