Application properties
At least two properties are required for correct work:
core.socialApplicationUrlweb.workerMessageReceiverUrl
| property name | description | default value | introduced |
|---|---|---|---|
| dataSource.driverClassName | Driver class | org.postgresql.Driver | |
| dataSource.url | JDBC URL to workspace database | jdbc:postgresql://localhost/virtualizer | |
| dataSource.minPoolSize | 5 | ||
| dataSource.maxPoolSize | 40 | ||
| dataSource.maxStatements | 50 | ||
| email.from | |||
| email.host | google.com | ||
| email.port | 8080 | ||
| core.defaultPendingAssignmentsLimit | This value is used when CrowdControl did not specify PendingAssignmentsLimit when registering HitType. Default value is 10, but can be changed. The variable is used for old data as for new HitTypes CC saves -1 when no limit is come from CC, which means unlimited amount of assignments per user per HitType. |
10 | |
| core.defaultSkippedAssignmentDurationInSeconds | This amount is used as a delay to delete assignments with status SKIPPED or RETURNED. User will see the skipped/returned Hits again after this delay. | 600 | |
| core.abandonAssignmentsJobChunkSize | The size of chunk used to query database and abandon expired assignments. | 100 | |
| core.countAvailableHitsUpTo | Sets upper limit of tasks to count in each HitType and Category. Default is 100 (if not set) | 100 | 2.14.7, 2.15.0, 2.16.0 |
| core.useFastHitLookupStrategy | false | ||
| core.hitSortingStrategy | Strategy to sort HITs using task comparator. It must be either "HitType" or "Category". If strategy is "HitType", hits will be sorted independently for each HitType. For "Category" the sort order bill be set for all HITs which are the members of any particular category. The value is optional, default is "HitType". | HitType | |
| core.templateFilesExternalLocation | Defines the folder with CV message templates | /opt/cv-templates | |
| core.instanceIdentifier | CV | ||
| core.socialApplicationUrl | Required. It should be set to full URL value of workspace. It's used for example in registration email confirmation OR for sending push notifications | ||
| core.payPalServiceUrl | URL for PayPal service | https://svcs.sandbox.paypal.com/ | |
password.workerPasswordExpirationDurationInSeconds |
This number is used as worker password expiration duration. If 0 set worker password does not expire | 0 | |
| password.requesterPasswordExpirationDurationInSeconds | This number is used as requester password expiration duration. If 0 set requester password does not expire | 0 | |
| password.resetPasswordTokenExpirationTimeInMinutes | Sets the timeout for password token reset. If a user didn’t reset a user password during the lifetime of this token, they will be prompted to reset the password again. | 15 | 2.13 |
mobile.sns.endpoint |
Amazon SNS endpoint URL (mobile app is used by tr only) | SNS-endpoint | 2.12 (deprecated) |
| mobile.allowDownload | Allow workers download mobile application (mobile app is used by tr only) | false | 2.12 (deprecated) |
| mobile.downloadPageUrl | The URL of static page, that shows the links to download iOS and Android CV apps (mobile app is used by tr only) | https://s3.amazonaws.com/cv-mobile/index.html | 2.12 (deprecated) |
web.googleAnalyticsEnabled |
Disables google analytics for (useful for on-premise local deployment with no Internet access) | true | 2.12 |
| web.twitterLink | String to WF twitter account | null | |
| web.enableWorkerEmailConfirmation | Disables email confirmation while registering (useful for on-premise deployment) | true | 2.12 |
| web.displaySupportEmail | If true email support is shown in footer | true | |
| web.manualBalanceUpdateAllowed | false | 2.4 | |
| web.socialPostSignInUrl | The path to redirect user after he logged in with OAuth. Used by ClickWorkers at the moment to redirect them directly to /categories | /dashboard | |
| web.workerMessageReceiverUrl | Required. The callback URL to send worker messages to CrowdControl. This messages will appear on CC dashboard. The URL should be like following: https://somehost.com/workfusion/api/v1/feedbacks |
||
| web.resourceUrl | Path to workspace resources. The resources include help and branding images. | https://s3.amazonaws.com/workspace-resources | |
| web.tourEnabled | If true tour modal is shown on first worker sign in | true | 8.5 |
| clickworker.apiUrl | https://sandboxbeta-hgv4.clickworker.com | ||
| clickworker.enabled | Enables or disables clickworker integration. Should be set to true for clickworker instances only (clickworker and clickworker-test) | false | |
securityLogin.lockoutType |
time-based | ||
| securityLogin.lockoutTimeout | 15 | ||
| securityLogin.timeframeToCountAttempts | 1440 | ||
| securityLogin.maxAttemptsAmount | 6 | ||
| ldap.enabled | false | ||
| ldap.internal.authorization.enabled | If set to true then groups/filters ignored and ldap is used for authentication only (check that username and password match)
|
false | |
ldap.user.base |
|||
| ldap.user.filter | (sAMAccountName={0}) | ||
| ldap.group.base | |||
| ldap.group.filter | (member={0}) | ||
| ldap.requester.groups | If user belongs to one of groups he's signed in as requester
|
||
| ldap.worker.groups | |||
| ldap.user.attribute.email | |||
| ldap.user.attribute.firstName | givenname | ||
| ldap.user.attribute.lastName | sn | ||
| ldap.user.attribute.country | country | ||
ldap.search.subtree |
|||
| ldap.search.timelimit | The time limit for user and groups search in milliseconds. If the value is 0, this means to wait indefinitely. | 0 | |
| ldap.search.dereflink | if true links will be dereferenced; if false, not followed. | false | |
ws.sso.saml.entity.base.url |
none | ||
| ws.sso.saml.response.skew | 60 | ||
| ws.sso.saml.enable | false | ||
secure.storage.safe.customer.default |
See WorkSpace Secure Properties for SMS config | local_WFApp | |
| secure.storage.safe.internal | local_WFInternal | ||
| secure.storage.type | LOCAL | ||
| secure.storage.serverApi | |||
| secure.storage.platformId | WFApplication | ||
| secure.storage.client.certificate | |||
| secure.storage.client.keyPass | |||
| secure.storage.username.customer |
The sample workspace.properties file is as follows:
dataSource.url=jdbc:postgresql://localhost/virtualizer
dataSource.driverClassName=org.postgresql.Driver
core.defaultPendingAssignmentsLimit=10
core.abandonAssignmentsJobChunkSize=100
core.defaultSkippedAssignmentDurationInSeconds=600
web.workerMessageReceiverUrl=https://localhost/mturk-web/rest/feedback
email.host=localhost
email.port=25
email.from=crowdsupport2@workfusion.com
core.socialApplicationUrl=https://localhost/virtualizer-web
core.instanceIdentifier=LCLPROD
core.hitSortingStrategy=Category
web.manualBalanceUpdateAllowed=True
web.twitterLink=http://twitter.com/WorkFusionSupport
web.tourEnabled=true
mobile.allowDownload=true
clickworker.enabled=true
clickworker.apiUrl=https://clickworker.com
web.socialPostSignInUrl=/categories
core.useFastHitLookupStrategy=true
mobile.downloadPageUrl=https://s3.amazonaws.com/cv-mobile/index.html
password.resetPasswordTokenExpirationTimeInMinutes=15
core.templateFilesExternalLocation=/opt/cv-templates
core.countAvailableHitsUpTo=100
web.resourceUrl=https://s3.amazonaws.com/workspace-resources2
ldap.enabled=false
ldap.internal.authorization.enabled=false
ldap.user.filter=(uid={0})
ldap.group.base=ou=Groups,dc=crowdcomputingsystems,dc=com
ldap.group.filter=(memberUid={1})
ldap.worker.groups=CC Dev
ldap.requester.groups=CC Req
ldap.user.attribute.email=mail
ldap.user.attribute.firstName=givenname
ldap.user.attribute.lastName=sn
ldap.user.attribute.country=country
ldap.user.base=ou=People,dc=crowdcomputingsystems,dc=com
ldap.search.subtree=true
ldap.search.timelimit=0
ldap.search.dereflink=false
secure.storage.safe.customer.default=local_WFApp
secure.storage.safe.internal=local_WFInternal
secure.storage.type=LOCAL
secure.storage.serverApi=/Users/workfusion/Documents/Work/local_secure_storage/
secure.storage.platformId=${catalina.home}/conf/secure.properties
secure.storage.client.certificate=
secure.storage.client.keyPass=
secure.storage.username.customer=