Connecting document templates to a DocFusion repository via cached proxy allows you to work with external references and library element smart parts without a local instance of Workbench. It is an advanced Template Designer feature that establishes an authenticated session with a DocFusion repository from a document template, and grants access to document assets within assigned business units. Open sessions then allow external reference and library element smart parts within the template to function and preview correctly.
Changes made to the template still need to be checked-in to Workbench's version control to be made available for document automation.
To setup proxy connections refer to the guide: Establishing template repository connections via cached proxy...
Sessions
When establishing cached proxy connections, an authenticated session with the DocFusion repository is established. The access token refreshes automatically until the document is closed in Template Designer. Each session is unique, and its scope is as follows:
- Different templates opened in Template Designer do not share the same session, regardless of their origin. Each open template requires a unique session to be established.
- Sessions can be cleared, and reconnected to different business units if required.
- Clearing a session, however, invalidates the existing repository context. A new session with the repository needs to be established to work with, or preview, external references and library elements.
- Sessions can be re-used. Once instantiated, the same repository context will be used for the template's open session.
- Sessions are not saved or persisted. When closing Template Designer, the connection to the Docfusion repository (the context) is lost.
Previewing
When a logon session to your business unit has been established, it will be used to preview templates that contain external references. If no session has been established, you will be prompted to enter your login details before previewing the template. Note that changes to referenced content will not reflect during preview unless they have been checked-in.
If templates are checked-out and edited using Workbench, please ensure that you keep Workbench open to ensure changes to your templates save correctly.
Performance
The previewing speed of document templates is impacted when using proxy connections. This is because any external references made in the template are downloaded each time the preview is executed.
If previewing speed is an important factor during template design-time, initiate template editing through Workbench since it copies the template to the local repository and assists performance.
Error Conditions
You may experience error conditions when previewing templates that use external references but have no active logon sessions. This happens under the following conditions:
- A session to the repository was not established using the Template Settings window,
- Or, template editing was not initiated via Workbench.
In both these instances, no connection to the DocFusion repository is present so external references don't have the requisite access to function correctly.
When a session has not been established, you may experience the error: Could not evaluate External Reference Template Smart Value. If Workbench was closed prior to previewing or saving a template, then the error: An exception occurred saving to the repository, will be thrown.
Template Saving
The saving of document templates that use proxy connections continues to follow the execution path of all DocFusion templates. This is as follows:
- If the template was checked-out and edited using Workbench, then it is first saved to the local repository before being uploaded to the DocFusion server. The user will not be prompted to logon to the DocFusion repository.
- Templates are saved directly in the remote repository when an active proxy connection is found, i.e.: has been authenticated.
- If proxy information has been found in the template but the connection is not active (authenticated), then the user will be prompted to logon to the DocFusion repository and select a business unit.
- Saves template to file.
Changes to referenced content will not reflect when performing a preview, unless they have been checked-in.