DocPop Vars - DocPop - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

DocPop

Platform
OnBase
Product
DocPop
Release
Foundation 22.1
License
Standard
Essential
Premier

DocPop-specific settings are located in the Hyland.Web.DocPop element of the Web Server's Web.config file. The only required setting is a data source. You can either configure one in the Web Server's Web.config or pass it along the query string.

The following settings are located in the Hyland.Web.DocPop element of the Web Server's Web.config file.

username- Enter the user name to use with default login for DocPop, if you want to use a single user account for When enableDefaultLogin is set to true, users can automatically log on to DocPop using the credentials provided in the username and password settings.

password - Enter the password to use with default login for DocPop, if you want to use a single user account for access. When enableDefaultLogin is set to true, users can automatically log on to DocPop using the credentials provided in the username and password settings.

datasource- Enter the name of the data source to use with DocPop. This is a required value.

domain- Enter the domain to log on to if you are using Active Directory authentication.

embedded - Set this to true when you are embedding DocPop results in a custom Web page and you want the DocPop results to be displayed in a frame or iframe within the same browser window. When set to false, DocPop results are opened in a new window.

  • If embedded is set to true and results are not embedded in another Web page, then the address bar and browser toolbars will be displayed when a user accesses the DocPop URL.

  • If DocPop results will not be embedded in Web pages, set embedded to false. The address bar and toolbars will be hidden when DocPop results are displayed.

enableDefaultLogin- Set this to true to have DocPop use the username and password credentials specified in the Hyland.Web.DocPop element. Set this to false to have DocPop either attempt other authentication methods (if they are configured) or prompt the user for credentials.

enableHTTPLogin- Set this to true to pass login credentials to the server on the query string or to post them through an HTML form. Set this to false if DocPop should either attempt other authentication methods (if they are configured) or prompt the user for credentials.

Note:

For information about passing values using the query string, see the topic Modifying a DocPop URL in the DocPop help files or module reference guide.

enableAutoLogin- Set this to true to use domain credentials to log on to DocPop automatically. When this is set to false, DocPop either attempts other authentication methods (if they are configured) or prompts the user for credentials. If you enable this setting, ensure that the Web Server is configured for Active Directory authentication. See the Legacy Authentication Methods module reference guide for more information about Active Directory authentication.

Set enableAutoLogin to true if you are using Integration for Single Sign-On. If OnBase is configured for Active Directory or LDAP authentication, but you want to use Single Sign-On with DocPop, set both forceSSOAutoLoginOverDomain and DocPop's enableAutoLogin setting to true. For more information about Integration for Single Sign-On, see the Legacy Authentication Methods module reference guide.

enableHTTPDataSource- Set this to true to pass the data source on the query string. Set to false to use the DocPop data source in the Web Server's Web.config.

enableChecksum- If set to true, a checksum value will be added to the URL query string. To enable checksums, you are also required to enter a checksum key value in the DocPop checksum setting, which is used to create the checksum value in the URL. When a user attempts to retrieve a document using the URL, DocPop compares the checksum in the query string to the expected checksum. If the values match, the document is displayed. If the values do not match, the user is presented with an error. This is to prevent users from modifying query strings and accessing documents they should not access. Additionally, remote users accessing the DocPop URL Creator require the Web Server administrative privilege. If set to false, no checksum is created.

checksum- Enter the unique string value used as a key for external, dynamic checksum creation. This string value should not be well known. The checksum setting applies only when enableChecksum is set to true and an external automated process is being used to dynamically generate DocPop links.

Note:

Configuration of this setting is required for checksum creation and validation.

  • The Application Server web.config file also contains a Pop integration checksum setting: ChecksumKey. This setting is used for checksum generation when the docID is used from outside of the Web Client solution (for example, in Workflow notifications). If you use this feature, the ChecksumKey value in the Application Server web.config file must match the checksum value in the Hyland.Web.DocPop element of the Web Server web.config file. For more information about checksum generation, please refer to the Hyland SDK.

  • If you are using the Workflow action Med - Send HL7 Message, the Hyland.Web.DocPop checksum value should be empty. If an external process will generate the DocPop URLs and you want to use checksums, then a separate virtual directory for DocPop should be configured.

enableCoreQueryAPILicense- This setting requires OnBase to be licensed for Core Query API (Retrievals Per Hour). Set this setting to true if you want users to consume Core Query API licenses when using DocPop. Core Query API licenses help prevent the unnecessary consumption of Concurrent Client licenses. When this setting is set to true, a Core Query API license is consumed as soon as a user logs on to DocPop and is released immediately after the user logs off. When the enableCoreQueryAPILicense setting is set to false, a Concurrent Client license is used.

Note:

Core Query API licenses are only available for external users.

AutoDisplayOneDocument- Set this setting to true to always display only the viewer for DocPop queries that return a single result. When this setting is set to false, DocPop displays both the hit list and the viewer for queries that return a single result. This behavior can be overridden by the viewerOnlyForSingle variable in the DocPop query string. The viewerOnlyForSingle variable has no effect when AutoDisplayOneDocument is set to true.

disableContextMenu- Set this setting to true to disable right-click menu options in the DocPop results list and viewer. Set it to false(the default setting) if right-click menu options should be available. This setting does not affect right-click menu options in the OnBase Web Client outside of DocPop.

forceSSOAutoLoginOverDomain - Set this value to true when OnBase is configured for LDAP or Active Directory - Enhanced authentication but single sign-on should be used for authentication when OnBase is accessed using the Web Client.

If single sign-on is configured and forceSSOAutoLoginOverDomain is set to false, users must log in to the Web Client using the authentication method configured in the Directory Service Authentication settings (standard, LDAP, or Active Directory - Enhanced) with respect to the EnableAutoLogin setting.