The CommParams Element - Front Office Scanning - Foundation 23.1 - Foundation 23.1 - Ready - OnBase - Premier - external - Standard - Essential - Premier - Standard - Essential

Front Office Scanning

Platform
OnBase
Product
Front Office Scanning
Release
Foundation 23.1
License
Premier
Standard
Essential

The CommParams element contains the information needed to configure your Front Office Scanning client to connect to your OnBase Application Server.

<CommParams domain="" username="" password="" credentials="" dbname="HylandHospital" url="http://ServerName/appserver/ service.asmx" ntsecurity="" automaticClientTimeout="" />

The following settings are found in the CommParams element. If your Front Office Scanning solution is configured to use Identity Provider (IdP) authentication, additional settings apply. For more information on configuring Front Office Scanning for use with IdP authentication, see the Identity and Access Management Services module reference guide.

CommParams Element Settings

Description

domain

Note:

This option is only used if your Front Office Scanning solution is configured to use Active Directory or LDAP authentication.

This setting allows you to specify a default domain to be used when a user logs on to the Front Office Scanning client.

For example, if all users that are to be performing Front Office Scanning belong to the Clinical domain, you could specify it as the default domain to be used by all users that log onto the Front Office Scanning client using this configuration file.

Set the domain setting to contain the name of the default domain to be used.

  • If a value is supplied for the domain setting, when a user launches Front Office Scanning, the Front Office Scanning User Log On dialog box is displayed with the domain value pre-populated in the Domain field. This value can be modified by users as needed.

    Note:

    When using interactive Active Directory or LDAP authentication, values for the User Name and Password fields are not pre-populated, even if a default username and password are specified in the Front Office Scanning configuration file.

  • If no value is supplied for the domain setting, when a user launches Front Office Scanning, the Front Office Scanning User Log On dialog box is displayed and the user must enter a valid domain value into the Domain field.

username

The username setting allows you to specify a default user account to be used when a user logs on to the Front Office Scanning client.

For example, if all users that are to be performing Front Office Scanning do not need their own OnBase user account, you could create a default account (for example, ER_Registration) to be used by all users that log onto the Front Office Scanning client using this configuration file.

Note:

If your Front Office Scanning solution is configured to use IdP authentication, the username setting is ignored.

Set the username setting to contain the OnBase user name of the default OnBase user account to be used.

  • If a value is supplied for the username setting, but no value is supplied for the password setting, when a user launches Front Office Scanning, the Front Office Scanning User Log On dialog box is displayed with the username value pre-populated in the User Name field. This value can be modified by users as needed.

    If a value is supplied for both the username and password settings, the log on process is automated using these credentials; the Front Office Scanning User Log On dialog box is not displayed and the Front Office Scanning client is automatically displayed.

  • If no value is supplied for the username setting, when a user launches Front Office Scanning, the Front Office Scanning User Log On dialog box is displayed and the user must enter a valid OnBase user name into the User Name field.

Once the Front Office Scanning client is launched for the first time with the Front Office Scanning configuration file, the username setting is removed and is stored as an encrypted value in the credentials setting. It can no longer be viewed in the Front Office Scanning configuration file.

Note:

If a default user account is used to log on to the Front Office Scanning client, this user account is recorded as the creator for all documents scanned/created in the Front Office Scanning client in the documents' document history.

password

The password setting allows you to specify the password for the default user account identified by the username setting.

Note:

The password setting is ignored if no value is entered for the username setting or if your Front Office Scanning solution is configured to use IdP authentication.

The password setting is used in conjunction with the username setting. Set the password setting to contain the password associated with the OnBase user account being used.

Tip:

The password setting is optional, even when using the username setting. To add a measure of security, a default user name can be specified without supplying the password for the account.

Once the Front Office Scanning client is launched for the first time with the Front Office Scanning configuration file, the password setting is removed and is stored as an encrypted value in the credentials setting. It can no longer be viewed in the Front Office Scanning configuration file.

credentials

The credentials setting contains the encrypted values representing the default username and the default password that were specified in the Front Office Scanning configuration file.

Note:

If your Front Office Scanning solution is configured to use IdP authentication, the credentials setting is ignored.

The credentials setting is used in conjunction with the username and password settings. The credentials setting is automatically added to the Front Office Scanning configuration file after a default username or a default password has been specified and the Front Office Scanning client has been launched.

dbname

This setting is used to specify the name of the data source used to connect to the OnBase database. This setting is required.

Set the dbname setting to the name of the data source used to connect to the OnBase database.

url

This setting is used to specify the URL of the OnBase Application Server. This setting is required.

Set the url setting to the URL of the OnBase Application Server to which the Front Office Scanning client connects. This value should include the full path to the Application Server's service page (for example, url="http://ServerName/appserver/service.asmx").

ntsecurity

This setting is used to configure the Front Office Scanning client to validate users via Active Directory or LDAP authentication.

Note:

In order for Front Office Scanning to be able to use Active Directory or LDAP authentication, your OnBase solution must first be configured to use Active Directory - Enhanced or LDAP authentication. See the Legacy Authentication Methods module reference guide for more information.

  • If ntsecurity is set to true, then the Front Office Scanning client is configured to authenticate users using Active Directory or LDAP authentication.

  • If ntsecurity is set to false, or if no value is present, then the Front Office Scanning client is configured to authenticate users using standard OnBase security, and a valid OnBase user name and password is required to access the Front Office Scanning client.

Note:

If your Front Office Scanning solution is configured to use IdP authentication, the ntsecurity setting is ignored.

automaticClientTimeout

The automaticClientTimeout setting is used to specify the number of minutes of inactivity after which the Front Office Scanning client's current user is automatically logged out.

Once logged out, the user can log back in to resume the session or cancel to end the session. If the user cancels the session, the Front Office Scanning client is closed and any pending documents from the session are discarded.

If automaticClientTimeout is set to 5, for example, then the current user is automatically logged out after five minutes of inactivity.

If automaticClientTimeout is set to a value less than or equal to 0, or if no value is present, then the current user is not automatically logged out after any period of inactivity.