Site Configuration

The Admin > Configuration screen provides a convenient way for System Administrators to update and add (non-startup) configuration keys to their ProjectDox installation. These additions are primarily used for integration requirements. Updates made in this screen will be written to the database.

Related settings are categorized by type and are available through the various tabs of the Configuration screen described in the following sections. Any changes made to the Configuration user interface are tracked in the LogReports table for troubleshooting purposes.

App Features

BatchStampEnabled

Boolean to define whether batch stamping is enabled.

GIStreamIntegrationEnabled

Determines whether GIStream Integration is enabled for this ProjectDox instance. Note that disabling GIStreamIntegrationEnabled will deselect the Gistream check boxes for users on the Admin -> Users screen. In addition, when enabling GIS back on, admins will be required to select the GIstream check boxes for each user to re-enable that permission.

ProjectExportEnabled

Whether to allow project export. Also requires this feature to be licensed.

ProjectFlow8Integration

Determines if ProjectDox 9.0 is ProjectFlow instance.

ProjectFlowEnabled

Determines if ProjectFlow will be enabled for workflows.

StandardWorkflowEnabled

Whether to enable ProjectDox workflow functionality.

 

 

Batch Stamp

BatchStampOutputTypes

Accepted output file types for batch stamping. Accepted types are: DWF, PDF, and TIFF.

BatchStampPages

Accepted stamp pages for batch stamping - accepted values are: First(F) ,Last(L), First & Last(FL), All(A).

BatchStampPath

Server directory that contains all the stamps available for batch stamping. This can exist anywhere on the Web Server or network, but ProjectDox and the Job Processor must have read/write access on it.

BatchStampPlacement

Accepted stamp positions for batch stamping - accepted values are: Top Left(TL), Top Center(TC), Top Right(TR), Left Center(LC), Center Center(CC), Right Center(RC), Bottom Left(BL), Bottom Center(BC), Bottom Right(BR).

 

Brava

These settings determine the state of the Brava Client Viewer.

 

BELSPort

Server port number that BELS (Brava Enterprise License Server) is running on. This is needed to get the license information for Brava client to work correctly.

BELSServer

Server that BELS (Brava Enterprise License Server) is running on. This is needed to get the license information for Brava Client to work correctly.

BravaCABFolder

Specifies the folder containing the Brava Client integration version CAB file.

BravaClassID

Brava ClassID does not change when the code base and version changes - it is constant.

BravaClientLog

Logging level for Brava to log debut info on the client PC – writes to c:\temp\BravaDebugLog.txt – to turn off, set to 9. 0 = very minimal output, 1 = extensive log only debug info.

BravaCodeBase

Brava CAB Codebase.

BravaCustomParams

Any number of custom parameters that control the Brava Client GUI. Possible values listed in Appendix X. Each parameter must be on its own line. This field is where the feature to enable taking ownership of another's markup would be configured.

BravaExtensions

SHOULD BE DEPRECATED AND ALL MOVED TO FILETYPESALLOWED WHEN WEB.CONFIG MOVED TO DB. Valid engineering file extensions (all other extensions will be assumed to be office-type docs, not engineering files).

BravaPublishTimeout

Determines how many seconds to attempt Brava HTML publishing before timing out.

BravaServerURL

Server URL where Brava Server is installed and running. ProjectDox requires the Brava Server for the HTML5 Viewer integration.

BravaThumbnailsEnabled

Determines if Brava thumbnails will be generated. Applicable to HTML viewer only and for multi-page documents.

BravaVersion

Brava Client integration version.

 

Core

These settings determine the key configuration options for the core ProjectDox site itself, independent of additional features.

 

AppName

User-friendly name - for display in the browser title bar.

AutoFileBrowse

DEPRECATED. Determines whether to automatically launch the file browser in the uploader control.

CascadeByDefault

Determines whether to enable permissions cascade in the Manage Permissions page by default. It may be changed in the UI at any time and for every permission-granting session.

ColorHighlight

Text-box background-color used for indicating required fields (primarily used in the Profile screen). Use 6-character color code.

DataCacheTimeout

The amount of time in seconds to cache the returned data for queries that are run repeatedly in ProjectDox, before the query’s results expire. To turn off the caching at the data level, set to zero.

DebugEmail

If DebugMode is enabled, then ALL email going out from system will go to this email.

DebugMode

Enable/disable logging various items to the TempDir\ProjectDoxDebug.txt file.

EnableFriendlyErrorHandling

If true, then ProjectDox will handle errors and give friendly error output. If false, then raw errors will be thrown from .NET.

EnableProjectTopicsNotes

 

Enable/disable access to topics and notes at the project level.

 

FileIOTimeout

The amount of time in seconds for ProjectDox to wait for the file system to unlock a file before it throws an error message. This setting should be under 15 seconds or else there might be performance problems.

FileLoadRecordCount

The count of files that will be loaded via the lazy load feature of the file pane. This is the count of files that will be returned initially and each time the user scrolls down to get more. It is best to default the number at 1000.

FileNewDaysBack

This number determines the number of days an uploaded file is to be considered "new," and is therefore flagged.

FileTypesAllowed

Office 2007 extensions must be listed after extensions from earlier versions. IN ADDITION TO BravaExtensions, these are the extensions for file types allowed to be uploaded in ProjectDox.

FolderInheritDefault

If true, all newly-created folders will have the "inherit" flag checked by default. This may be unselected at folder creation time. This is reflected in the project folders and default folders.

GIStreamMapViewerUrl

Specifies the full URL to the ProjectDox GIStream Viewer web page.

GIStreamShowMapInSeparateWindow

Determines if GIStream Map displays inside ProjectDox or in a separate browser window.

HeaderImage

Rectangular image at the top of every main ProjectDox screen.

IISPort

When the ProjectDox IIS web site port must be explicitly included in each URL, specify it here, otherwise leave it blank. For port 80, leave it blank.

IntegrationDLLs

This setting specifies any integrations that ProjectDox is using. Enter as a comma separated list.

LegalTextLoginFile

OPTIONAL SETTING - Name of text file residing in \ProjectDox\Custom containing legal text (see TermsAndConditions.txt for example), disclaimers, terms and conditions, etc. The FIRST LINE of the file must be a number between 2 and 20, which determines how many rows at a time to display before having to scroll.

LockOutUsersFromApp

If this option is enabled, then all users (with the exception of System Admins), will be prevented from logging into ProjectDox.

LockOutUsersFromAppMessage

Message to display to the users if they attempt to log in when LockOutUsersFromApp is set to true.

LogoImage

File name of logo image.

LogoImageLogin

URL for logo image on login screen that is beneath the main logo, in the left side of the box.

LogoURL1

Web address (URL) that accompanies logo image on login screen that is beneath the main logo, in the left side of the box.

LogoURLLogin

URL that LogoImageLogin links to.

LogoutNewUrl

The URL that the user's browser will go to when he/she clicks the "Open a new browser window" in the Session Ended screen.

MaxUploadFileCount*

DEPRECATED. Sets the number of files that can be uploaded at a time.

MaxUploadFileSize*

DEPRECATED. Sets the size of a single file. The value of the property should be in bytes, 1 MB = 1048576 bytes, 1 GB = 1073741824 bytes.

MaxUploadSize*

DEPRECATED. Sets the total size of the files. The value of the property should be in bytes, 1 MB = 1048576 bytes, 1 GB = 1073741824 bytes.

MetadataEnabled

Determines whether to enable custom Metadata for this site.

MSIDisplayDescr

This description will display in the mouse-over tooltip of the MSI download link.

MultipleLoginEnabled

Allow multiple login to be disabled/enabled on a per-profile basis. If this is set to false, then System Admins cannot set a profile to allow multiple logins and no users will be able to have multiple logins.

NotifyOnUpload

Determines whether to allow users to select project members for notification of upload immediately following upload (*push* notification rather than *pull*).

PassThruProj

Determines whether pass-through can be set at the Project level.

PassThruSite

If PassThruProj is true, this serves as a default pass-through list for each project - if PassThruProj is false, this serves as the only site-level pass-through extensions.

PDoxWebAPIURL

Specifies the full URL to the ProjectDox Web API. This URL is required when ProjectFlow is enabled.

PDoxWebUIPath

Sets the physical path to the ProjectDox web.ui site. This is where ProjectFlow runs.

PDoxWebUIURL

Specifies the full URL to the ProjectDox Web UI. This URL is required when ProjectFlow is enabled.

PDoxWebURL

The complete URL to your ProjectDox site, needed for ProjectFlow integration. The full URL will have the following information: https://yourdomain.com/yourvirtualdirectory

Example:   https://eplans.cityofabc.net/projectdox

PortalEnabled

Specifies if portal is enabled with this installation of ProjectDox. This could be ProjectDox portal or a customer implementation of portal.

PortalJurisdictionID

Specifies the portal jurisdiction ID for this installation of ProjectDox.

PortalWebApiUrl

Specifies the full URL to the Portal web API services.

PortalWebUiUrl

Specifies the full URL to the Portal web login.

ProjectCreate

1 grants by default, 0 denies by default.

Qpath

The path where ProjectDox Job Processor and FTP windows service will look for queue files from which the instructions are taken. There can be only one queue path per server, so if there are multiple ProjectDox sites, they must all point to the same queue folder location. This setting is mandatory and must not be removed.

SchedulerMaxThreadCount

Sets the total number of threads that can be executing at any one time for the ProjectDox Task Scheduler.

ShowCountry

Determines whether to expose a Country field in user settings and to expose a Country field in the list of Required User Info.

TempFolder

Temp folder for ProjectDox use - should be exclusively used by ProjectDox (don’t use Windows Temp folder or similar).

TempFolderURL

URL where temporary uploaded files can be reached. For Web Farm/Load Balance environments, this must be reachable by all servers in the farm.

UploaderAsync

Determines whether to make the uploader call sync or async - should always be true in production - can be false when debugging.

UserFilesPublish

UNC path shared folder where all published files go by default - this share must have adequate permissions so that ProjectDox can freely access resources inside - if additional sites exist, this path must be different for each site.

UserFilesSource

UNC path shared folder where all source files reside by default - this share must have adequate permissions so that ProjectDox can freely access resources inside - if additional sites exist, this path must be different for each site.

UserNameFormat

This setting will determine how user names are show throughout the ProjectDox interface and emails generated by ProjectDox. If left blank the places in the interface and emails will be blank. Default is "FirstName LastName". Any combination of FirstName, LastName, FirstInitial, LastInitial and any other text is allowed. For example, "LastName, FirstName" (no quotes).

UTF8Required

Determines whether to require UTF-8 encoding, necessary when running on foreign operating systems such as Japanese, Korean and others.

VersionByDefault

Determines whether versioning is enabled for each new project by default.

VersioningOn

Determines whether Versioning is enabled. Once any project enables versioning, this cannot be turned off for the site.

VirtualDir

Name (alias) of IIS virtual directory.

VirtualDirPublish

Name of IIS virtual directory where published documents and drawings reside. For simple implementations, this should be the same virtual directory referenced in Application ("VirtualDir") and the publish folder should be inside the root ProjectDox folder. If the publish folder is outside the ProjectDox folder, or on another server, a new virtual directory must be created to point to the publish folder, and this setting must contain that alias name.

Watermark (see Watermarks )

Watermark text that appears across all files viewed or printed in Brava. This optional setting can be left blank.

WebDNSAllow

If WebDNSAllow and WebDNSDisallow are used then it takes the HttpContext.Current.Request.Url.Host value and replaces WebDNSDisallow with WebDNSAllow. If WebDNSAllow is used without WebDNSDisallow then WebDNSAllow is the sole value used for the main URL. If neither WebDNSAllow nor WebDNSDisallow are used, the HttpContext.Current.Request.Url.Host is used as the main URL.

WebDNSDisallow

Portion or all of a potential WebDNSInternal string that must not be allowed, and must be automatically flipped to the value in Application ("WebDNSAllow") - this setting is optional and can be left blank.

WebDNSInternal

The DNS used by the ProjectDox Job Processor when notifying ProjectDox that a file has published successfully, or failed to publish. Example: www.YourProjectDox.com. In a load balanced environment, this is the common address NOT one of the server addresses.

ZipFileThreshold

Threshold (in MB) at which files will begin to be zipped when individually downloaded.

 

Email

This tab contains settings to determine global email options.

 

EmailAdmin

This email address is in the footer of all email templates.

EmailEventsFromUser

Determines whether notification events will appear to come from the user who triggered the event - if False, mail sender for notification events will originate from the value in MailSender.

EmailOnProjectCreate

Email addresses to receive emails on project creation. Enter as a comma-delimited list of emails.

Incoming

Determines whether to enable functionality in which ProjectDox can process incoming emails and display that information in the application.

IncomingDomain

The subdomain portion of the email address that is used to send emails to ProjectDox (everything after the @ sign) - an example: 27@ProjectDox.yourcompany.com, where "27" is the ProjectID that should receive the email, the subdomain is "ProjectDox.yourcompany.com."

MailSender

From address for all auto-generated emails.

PermissionsEmail

Determines whether to send an auto-generated email each time a user's permissions change.

TMailEnabled

Enable or disable Team Mail site-wide.

 

LDAP

These settings determine ProjectDox LDAP (Lightweight Directory Access Protocol) authentication.

LDAPURL

URL of the LDAP ProjectDox server so emails that go to LDAP users will have the correct LDAP ProjectDox URL.

Please see the ProjectDox LDAP Authentication integration for Single Sign On (SSO) documentation for further information on how this functionality is configured. When the license bit is turned on, then all possible fields for the LDAP display.

Localization

The localization tab controls settings used with localized installations.

 

AsianDisplay

Used for Japanese and other Asian locales, this setting determines whether to display all names as LastName + <Space> + FirstName, and Address order as Postal Code - State - City.

HiliteTrans

Used for translation setup & debug purposes only. Should be set to false in production, or just remove the setting entirely.

ISOLanguageCode

ISO Language Code for the language that most users of this site speak/read.

LanguageDefault

The default country code language for this site. For American/English it should be set to en-us. Different culture codes are specified in /Integration/TranslationWYSIWYG/LanguageCodes.htm.

LanguageSupport

Comma-separated list of all languages that this site will support. Any number of languages can be entered; do not use spaces between languages, just commas.

PermissionIMG

Image to use for the permissions labels in PermissionsTop.aspx. Useful for sites running foreign languages.

RegionTemplate

A customer-specific text file inside the .\ProjectDox\Custom\Regions folder - can be states, provinces, regions, prefectures, etc. If file is missing, instead of pull-down, there will be a free text field - put one location per line in the text file.

 

Log

Determines error log options.

 

LogOutput

Determines where to log errors | Sum of desired log types invokes those log types. Default is 2.

0 = Disabled

1 = Trace – this option writes log output to the Event Viewer. Trace must also be enable in web.config or enabled from the SystemConfig.aspx page.

2 = DB – adds log entries to the Debug table in the database.

JobProcessorLogURL

URL to the Job Processor Log (Logfile.xml). This file is easily launched from the Admin/Troubleshooting page of the user interface.

 

 

Markup

Determines markup file permissions.

 

AllowDelMrk

Determines whether users can delete markups that they created.

AllowDelMrkFiles

Specifies whether users with file delete permissions can delete files containing markups.

MarkupLinks

Determines whether to display icon links for external and internal markup URLs.

 

PermitApp

These options support legacy workflow implementations.

 

DefaultOwnerEmail

Email of the Plan Check Administrator, to be assigned as Project Owner for all auto-created projects coming from the Permit App.

EmailOwnerProjectCreate

Determines whether to include plan check coordinator on emails notifying them they have been invited to the newly created project.

EmailSeal

Seal image filename to be stamped on auto-generated Permit App emails.

 

Report

These options support ProjectDox reporting.

 

ReportDataSourcePassword

The database password associated with the user name used to access the data from the data source.

ReportDataSourceUserName

The database user name used to access the data from the data source.

ReportServerLoginDomain

The domain used to log into the report server.

ReportServerLoginPassword

The password associated with the user name used to log into the report server.

ReportServerLoginUserName

The user name of the account used to log into the report server.

ReportServerURL

The URL used to communicate with the SQL Server Report Server. This folder is a virtual folder used to communicate to the SQL Server Reporting Engine.

ReportWebServiceUrl

The URL to the ReportService2005.asmx file. Used to programmatically communicate with the SQL Server Reporting Server using web service requests.

 

 

Security

Determines site security options.

 

PasswordExpiresDays

Determines how many days before a user has to change their password. If set to 0, then passwords never expire.

PasswordValidationDesc

Regular expression description so user knows what to enter.

PasswordValidationIsGlobal

Determines if regular expression should be used in the application. true = everyone, false = only System Administrators.

PasswordValidationRegExp

Regular expression to validate an entered password. Always used for System Administrators.

PropagateInvite

Determines whether a user that has Invite permissions (but not Manage Users) to a folder can, in turn, give another user "Invite" permissions to that folder. If a user has Manage Users permissions, Invite can always be granted regardless of the value of this setting.

SaveUsername

Keep username in cookie and provide it during login process.

SecurityToken

Security token for ProjectDox web services and public pages - can be a GUID, an encryption, or any long & secure string.

SessionTimeout

Number of minutes that a user’s session will remain active (after inactivity). Each time a page in ProjectDox is accessed, the timeout period will start over for that user. If a large upload is in place, the upload page updates the session so it will not time out while the upload is occurring.

SSLInternal

Whether to require secure /ssl/https communications between ProjectDox servers. The standard setting is unchecked for the internal servers.

SSLLevel

Possible values: 1 - SSL is disabled for the site; 3 - Full SSL for all pages, as well as SSL-encryption of uploaded files. The standard is level 3 for outward facing implementations.

SSLRequired

If checked, indicates that ProjectDox is required to run in SSL mode IF the SSLLevel=3. If this is true and SSL = 3 then it will bump the user to SSL if they try to access ProjectDox as non-SSL. This configuration allows SSL offload, where the SSL is terminated on the NetScaler, for instance, and the traffic from the NetScaler is forwarded to the server over the http protocol.

 

SMTP

Determines SMTP mail server settings.

 

SMTPEnableSSL

Determines if SMTP (mail) connection is secure.

SMTPPassword

SMTP mail server password.

SMTPPort

SMTP (mail) server port.

SMTPServer

SMTP (mail) server address to relay email.

SMTPUsername

SMTP mail server username.

 

Workflow

 

TaskListColumnHeaders

Column headings (pipe delimited) for the workflow task list grid that map to the Projects table columns specified in TaskListColumnNamessAddOn. Example: PublishPath|SourcePath|City|Description

TaskListColumnNames

Additional columns (pipe delimited) from the Projects table that should be displayed on the ProjectDox Workflow task list. Example: PublishPath|SourcePath|City|Description

 

To see a compiled list of all the settings within this menu, select the All tab.

Adding a New Setting

Provided at the bottom of each tab of the Configuration screen is a section that allows you to create new custom settings for the respective screen, to use for custom integrations you are developing for ProjectDox. The feature is also used by Avolve System Engineers during the upgrade and installation process, if necessary.

To add new configuration setting to the currently selected tab:

Select a tab that you would like to create a new setting for and fill out the fields at the bottom of the Configuration screen. The following fields are available:

Key – name of new key that will be added to the database. No spaces or special characters permitted.

Value – possible values of the new key

Default value – default value (from possible values) of the new key

Description – provide a brief description of what function this key performs

Type – select the setting type - possible selections include:

Boolean – accepts true or false value

Decimal – accepts decimal values

Encrypted – values in this field will not be visible; dots will display in place of the characters.

Integer – accepts number value

Multi Line Text – accepts any text strings on multiple lines

Path – accepts directory path value

Text – accepts any text string on one line

When finished, click Add and the new setting will be added to the bottom of the list of current settings in the tab.