Understanding System Options
The information shown on the System Options screen is generally informational and provides the DocuPhase Platform and its components with information regarding the parameters set up in relation to database(s), repositories, and servers.
!WARNING
Changes to ANY of these settings should only be made by certified System Administrators/TPOCs; and, only when absolutely necessary. Unauthorized or unplanned changes could result in severe issues with the performance of the system.
TIP
To access the System Optionsscreen: from the main header, go to AdministrationSYSTEMSystem Options.
Tell me about...
System Option Settings
| Name | Use it to view/update/change... |
|---|---|
| ScanTo Service Bus | the communications bus for Send To ScanDox functionality.
EXAMPLEHTTP/SALESAWS/DocuPhase |
| MessageBus | the communication path between the DocuPhase UI and DocuPhase Server(s).
EXAMPLEHTTP/SALESAWS 33103 |
| AnalyticsEnabled | the use of Analytics. A value of True indicates Analytics is activated; a value of False indicates Analytics is not active. |
| FullText Schedule | the time range during which the Full-Text Service runs. The first number shown indicates the start time; the second number shown indicates the end time. Time is measured as military time (e.g., 1800 means 6pm, while 8 means 8am).
EXAMPLE18,8 |
| Image Viewer | the state in which the Image Viewer displays by default(e.g., Control) |
| ProgressionEnabled | the use of Progression. A value of True indicates Progression is activated; a value of False indicates Progression is not active. |
| Analytics Repository Location | the location of the Analytics Repository.
EXAMPLEC:\Program Files (x86)\DocuPhase\Analytics\ANTServer |
| Analytics System Server* | the server where the Analytics system is located.
EXAMPLESALESAWS |
| DocuPhase HTML5 Viewer URL | the location at which DocuPhase HTML5 Viewer is installed.
EXAMPLEhttp://someserver/DocuPhaseHTML5Viewer |
| iForms* Data Directory | the named path’s actual directory path to each of the installed components for your organization’s installation: The path to the iForms Data component.
EXAMPLEC:\ProgramData\DocuPhase\iForms Server\data |
| iForms* Install Directory | the location of the iForms Install component.
EXAMPLEC:\Program Files (x86)\DocuPhase\iForms Server |
| Repository Path | the path to where the DocuPhase repository resides.
EXAMPLE\\localhost\Repository\ |
| Source Path | the folder from which incoming files are processed.EXAMPLE\\localhost\Incoming\ |
| Progression* Engine | the location of the Progression Engine scheduling/status server.
EXAMPLEHTTP://SALESAWS:33102 |
| Analytics Integration Url | the location of the repository for the Analytics integration.EXAMPLEC:\ProgramData\DocuPhase Analytics\ANTServer |
| Application Servers | the core component that provides authentication and system information consumed by the DocuPhase services.
EXAMPLEHTTP/SALESAWS/DocuPhase |
| Configuration Service URL | support for access to configuration, Indexing profiles, and other products settings (REST API).
EXAMPLEhttp://SALESAWS/ConfigurationService/v1 |
| Data Service URL 0 | the location at which the data services are installed.
EXAMPLEhttp://SALESAWS/DataService/v1 |
| Data Services | the directory in which the data services are installed.
EXAMPLEHTTP://SALESAWS/ApplicationServer/DataService.asmx |
| Designer* Services | the directory in which applicable designer services are installed.
EXAMPLEHTTP://SALESAWS/progressionserver/DesignerService.asmx |
| Document Servers | the location where the DocuPhase Document XML is stored.
EXAMPLEHTTP://SALESAWS/DocumentServer/DocumentService.asmx |
| FederationRelayService | the service used in conjunction with ADFS* integration for the desktop Applications like ScanDox*. |
| Forms Service URL |
the location of the Forms web service (unrelated to Frevvo). |
| iForms* Service URL | the location of the iForms Service (Frevvo).
EXAMPLEhttp://SALESAWS:8082 |
| Install Services | the location of the Install Server that supports DocuPhase Tools menu workstation downloads.
EXAMPLEHTTP://SALESAWS/InstallServer |
| Licenses Servers | the location where the license servers are installed.
EXAMPLEHTTP://SALESAWS/LicenseServer/LicenseService.asmx |
| Progression* Design Service URL | the location at which the Progression Studio Application is stored.
EXAMPLEHTTP://SALESAWS/ProgressionDesignService |
| Public Forms* Service URL | the location where the iForms Public Form Service is performed.
EXAMPLEhttp://SALESAWS/PublicFormsService |
| Search Service URL | the location of the DocuPhase Search Service.
EXAMPLEHTTP://SALESAWS/SearchService/v1 |
| Security Service URL | the location of the DocuPhase Security Service.
EXAMPLEHTTP://SALESAWS/SecurityService/v1 |
| Workflow* Service URL | the location of the Workflow automation Applications.
EXAMPLEhttp://SALESAWS/WorkflowService/v1 |
| Workflow* Services | the name of any selected Workflow automation Applications.
EXAMPLEHTTP://SALESAWS/progressionserver/WorkflowService.asmx |
the email address that shows as the contact, and is used to contact the System Admin when a user requests an account via the Register new account link on the Sign In window.
NOTEThe need for this information to be entered here is based on whether or not your organization is using the new account request functionality (as described below). |
|
| DotNet* Framework URL | directory in which the Dotnet Framework resides.
EXAMPLE./installs/dotnetfx.exe |
| whether (True) or not (False) the Register a new account option should appear on the Sign In window. When set to true (i.e., enabled) a user can use the option to send basic information to the System Administrator for the creation of an account in DocuPhase. Tell me more... |
|
| whether (True) or not (False) the Trouble logging in? (i.e., self-service password reset) option should appear on the Sign In window. When set to true (i.e., enabled) a user can use the option to reset their password without having to contact the System Administrator Tell me more... |
|
| Login Timeout | number of minutes of idle time before an inactive User is automatically logged out of the system. This setting provides two benefits:
|
| Maximum Records | maximum number of records that are returned as a result of a search.
EXAMPLEIf a search results in 1,000 returned records, but the maximum records is set to 30, only 30 records are displayed at a time. NOTEAnything over 1,000 records may have an impact on performance (i.e., the more results being returned, the more time it takes for them to be displayed). |
| the number of hours that a temporary password remains valid once issued. When a user requests to reset their password, a temporary password is issued. This setting lets you decide how long that user has to use that temporary password. If the user exceeds that time limit, he/she has to submit a new reset password request. |
|
| Passwords Encrypted | selected value for the encryption of passwords. A value of True indicates that passwords are encrypted; a value of False indicates the passwords are not encrypted. |
| SingleSignOn | status of the Single Sign-On feature. A value of True indicates Single Sign-On is activated; a value of False indicates Single Sign-On is not active. |
| SmtpServer | email server URL for the DocuPhase install.
EXAMPLEDocuPhase-com.mail.protection.outlook.com IMPORTANT!Since the SMTP email server goes through this server, if changes are made to the email server, be sure to update this setting here. |
| the setting that shortens a long user defined list tht contains 5000 or more items. Setting this option to "true" enables this option, whereas a setting of "false" disables it. | |
| whether or not a Referral link will appear in the DocuPhase footer. | |
| whether you want brute-force attack prevention to be based on the IP (i.e., true) or user account (i.e., false). | |
| how many hours the system should allow brute-force login attempts before the offending entity (IP or User, as described above) is locked out. | |
| how many times the system should allow brute-force attempts before the offending entity (IP or User, as described above) is locked out. | |
| CorporateName | name of the installed DocuPhase Platform (i.e., usually the name of your organization).
EXAMPLE123 Industries, Ltd |
| CorporateURL | Internet address of the website of your organization or a related portal. It is the hyperlink that's associated with the icon (  ) at the top of the DocuPhasescreen. Tell me more...
EXAMPLEhttp://www.123Industries.com |
*Only applicable when the associated DocuPhase component is in use.
