(Deprecated) Include documents with a Guide

Including a document with a Guide allows for greater flexibility in data entry and review.

There are two types of documents that you can include with a Guide:

  • a read-only document of record

  • an interactive PDF document

    Only Guides based on an XDP form can include an interactive PDF document. Guides based on an data model (FML) cannot include an interactive PDF document.

Note: Guides that are rendered as a component cannot include a document.

    Display the document

    You can display the document from an icon or in a Guide panel.

    Display the document from an icon

    You can include a document that is displayed when the Guide filler clicks an icon. The icon appears in the upper right corner of the Guide at runtime. The Guide filler clicks the icon switch between the Guide and the document. For example, the Guide filler can view the results in the document, and return to the Guide to change the data.

    There is a different icon for a read-only document and for an interactive PDF document.

    Display the document in a panel

    The Guide can include a document that is displayed in a Guide panel. The document appears when the Guide filler navigates to the specified panel.

    When a panel displays a document, the icon does not appear in the upper-right corner of the Guide.

    A Guide can include multiple panels that display read-only documents.

    When you display a document in a panel, use one of the Cobalt Guide Layout options, such as Cobalt Bar, Cobalt Standard, or Cobalt Tree. The other Guide Layout options do not include Next or Previous navigation buttons on the panel that displays the document.

    Including a read-only document of record

    You can include a read-only document of record with a Guide. For example, you can include a read-only document to provide the option of printing the data in a convenient format. Including a read-only document with the Guide is also useful if your workflow is designed to archive user data. Alternatively, your process can create a portfolio or package using the Assembler service and return the result.

    Note: When a Guide is rendered through Workspace, the Guide filler is unable to complete the Guide when the read-only document of record is open. To complete the Guide, the Guide filler must return to the Guide, and then click the submit button.

    Display a read-only document from an icon

    You can include a document that is displayed when the Guide filler clicks an icon. The Guide filler clicks the icon switch between the Guide and the document.

    1. In Workbench, open your Guide in the Guide Design perspective.

    2. In the Guide Tree view, select the Guide container.

    3. If the Guide Properties view is not displayed, click Window > Show View > Guide Properties.

    4. In the Guide Properties view, select the Document-style Presentation option:

      • To generate the document using the default service, select Generate Document Using Default Service.

      • To generate the document using a custom service, select Generate Document Using Custom Service. Specify the Service URL and the Document Source.

    5. By default, the document displays anytime. To display the document only when the Guide data is validated, select Run Validations Before Requesting Document.

    Display a read-only document in a panel

    To display a read-only document in a panel, set the Document-style presentation properties for the Guide, and then set the panel Layout to Display Document.

    Use one of the Cobalt Guide Layout options, such as Cobalt Bar, Cobalt Standard, or Cobalt Tree. The other Guide Layout options do not include Next or Previous navigation buttons on the panel that displays the document.

    1. In Workbench, open your Guide in the Guide Design perspective.

    2. In the Guide Tree view, select the Guide container.

    3. If the Guide Properties view is not displayed, click Window > Show View > Guide Properties.

    4. From the Guide Layout options, select Cobalt Bar, Cobalt Standard, or Cobalt Tree.

    5. Select the Document-style Presentation option:

      • To generate the document using the default service, select Generate Document Using Default Service.

      • To generate the document using a custom service, select Generate Document Using Custom Service. Specify the Service URL and the Document Source.

    6. To validate the Guide data before displaying the document, select the Run Validations Before Requesting a Document option.

    7. In the Guide Tree view, add a panel where you want the document to appear.

    8. In the Guide Properties view for the panel, from the Layout options, select Display Document.

    Configure security for the RenderPDFDOR process

    When you include a read-only document with a Guide, configure the security settings for the RenderPDFDOR process. The RenderPDFDOR process is used to render a read-only document that is included with a Guide. The RenderPDFDOR process is installed with LiveCycle.

    1. Log in to the Administration Console.

    2. On the Home page, click Services.

    3. Click Applications And Services.

    4. Click Service Management.

    5. On the Service Management page, from the Category list, select Guides (System), and then click the Filter button.

    6. Click the service name:

      Guides (system)/Processes/RenderPDFDOR: 2.0

    7. Click the Security tab.

    8. From the Require Callers To Authenticate option, select No.

    9. From the Run As list, select System, and then click Save.

    Including an interactive PDF document

    If the Guide is based on an XDP form, you can include an interactive PDF document with the Guide. You cannot include an interactive PDF document with a Guide that is based on an data model (FML).

    The Guide can include both a read-only document and an interactive PDF document.

    Including an interactive PDF document enables you to provide an alternative data-entry method. The interactive PDF is generated from the same source XDP form and is embedded in the Guide. The Forms service must be installed on the server where the Guide is saved.

    If only Forms is installed on the server, the XDP form must include the Form Bridge object. The runtime Guide does not automatically inject the Form Bridge object in the XDP form. To add the Form Bridge object, edit the XDP form in Designer, and then add the Form Bridge object from the Custom library.

    For more information about using the Form Bridge object, see the Designer Help.

    By default, the interactive PDF document is loaded when the Guide is rendered. However, to control when the PDF document is loaded, use the advanced properties interactivePdfLoad and interactivePdfBackgroundLoadDelay. The interactivePdfLoad property controls the timing and sequence, and the interactivePdfBackgroundLoadDelay property controls the delay time when the PDF document is loaded in the background. (See Guide properties.)

    Display an interactive PDF document from an icon

    You can include a document that is displayed when the Guide filler clicks an icon. The Guide filler clicks the icon switch between the Guide and the document.

    1. In Workbench, open your Guide in the Guide Design perspective.

    2. In the Guide Tree view, select the Guide container.

    3. If the Guide Properties view is not displayed, click Window > Show View > Guide Properties.

    4. In the Guide Properties view, from the Interactive PDF options, specify how to generate the document.

    5. By default, the document displays anytime. To display the document only when the Guide data is validated, select Run Validations Before Switching to PDF.

    Display an interactive PDF document in a panel

    If the Guide is based on an XDP form, it can include one panel that displays an interactive PDF document. Only one panel can display an interactive PDF document. Do not set the first panel in a Guide to display an interactive PDF document.

    To display a document in a panel, set the Interactive PDF properties for the Guide, and then set the panel Layout to Display PDF.

    Use one of the Cobalt Guide Layout options, such as Cobalt Bar, Cobalt Standard, or Cobalt Tree. The other Guide Layout options do not include Next or Previous navigation buttons on the panel that displays the document.

    On the panel, add some text that appears while the Guide filler waits for the interactive PDF document to load.

    1. In Workbench, open your Guide in the Guide Design perspective.

    2. In the Guide Tree view, select the Guide container.

    3. If the Guide Properties view is not displayed, click Window > Show View > Guide Properties.

    4. From the Guide Layout options, select Cobalt Bar, Cobalt Standard, or Cobalt Tree.

    5. From the Interactive PDF options, select the Include Interactive PDF option.

    6. To validate the Guide data before displaying the PDF document, select the Run Validations Before Switching To PDF option.

    7. In the Guide Tree view, add a panel where you want the document to appear.

    8. In the Guide Properties view for the panel, from the Layout options, select Display PDF.

    9. In the editor, add a Text item.

    10. Type the text that appears on the panel while the Guide filler waits for the interactive PDF document to load.

    // Ethnio survey code removed