Changes between Version 24 and Version 25 of UserOptInConsent


Ignore:
Timestamp:
Sep 17, 2018, 2:46:25 PM (6 years ago)
Author:
skwang
Comment:

additions to usage

Legend:

Unmodified
Added
Removed
Modified

  • UserOptInConsent

    v24 v25  
    1111For Web registration, the login page can provide the terms of use text. Users will have to accept the terms of use before creating an account. This agreement will be stored in the project's database.
    1212
    13 For existing accounts: A project may decide that existing accounts should also agree to a terms of use. This is a separate feature from the user agreement to a terms of use when registering an account. Existing users will have tto agree to a terms of use via a checkbox, and then that agreement is stored in the project's database.
     13For existing accounts: A project may decide that existing accounts should also agree to a terms of use. This is a separate feature from the user agreement to a terms of use when registering an account. Existing users will have to agree to a terms of use via a checkbox, and then that agreement is stored in the project's database.
    1414
    1515== Existing code ==
    … …  
    4646* `consent_type`
    4747  * `id` - consent type id, also the primary key.
    48   * `shortname` - consent name, these should be short and in ALLCAPS, e.g., ENROLL, STATSEXPORTS, etc. There should be no spaces either.
     48  * `shortname` - consent name, these should be short and in ALLCAPS, e.g., ENROLL, STATSEXPORT, etc. There should be no spaces either.
    4949  * `description` - text field describing the consent that user gives (or has given).
    5050  * `enabled` - if true, this consent type is enabled. This is toggled in the OPS page for managing consent types.
    … …  
    7171The `enabled` flag is fairly important. By default no consent types are enabled. The project admins may toggle this in the Manage Consent Types OPS page. If the 'ENROLL' type is enabled, users will have to agree to a terms of use when creating an account. (The terms of use file must also exist). Independently, if 'ENROLL' is enabled, and parameter 'enable_login_mustagree_termsofuse' is equal to 1 (TRUE), existing users must agree to the site's terms of use.
    7272
    73 If 'STATSEXPORTS' type is enabled, users will see a new privacy preference option about statistics exports. They may give consent to this consent type in the user preference pages.
     73If 'STATSEXPORT' type is enabled, users will see a new privacy preference option about statistics exports. They may give consent to this consent type in the user preference pages.
    7474
    7575Re: `consent` table
    … …  
    139139From a project administrator's point-of-view. To enable the Opt-in feature:
    140140
    141 1. First in the OPS pages, go to "Manage consent types". All consent types are disabled by default. You should enable `ENROLL` and `STATSEXPORTS`, the two default consent types.
    142 1. You must add a `terms_of_use.txt` text file in the root of the project directory. This is the same directory `config.xml` may be found. This file must have the exact filename `terms_of_use.txt`, with underscores. It contains your projects terms-of-use text.
     141== Consent to Terms-of-Use ==
     142
     1431. First in the OPS pages, go to "Manage consent types". All consent types are disabled by default. You should enable `ENROLL` and `STATSEXPORT`, the two default consent types.
     1441. You must add a `terms_of_use.txt` text file in the root of the project directory. This is the same directory `config.xml` may be found. This file must have the exact filename `terms_of_use.txt`, with underscores. It contains your projects terms-of-use text. See TermsOfUse.
    1431451. `config.xml` must be updated: add XML `<enable_login_mustagree_termsofuse>1</enable_login_mustagree_termsofuse>` to the `<config>` section.
    144   * Note: If this config option is **not** set, the behavior of the site will be as follows. New accounts, whether created from the BOINC client or the Web site, will see a terms-of-use dialog which the user must agree to. However, existing accounts, when they login, are not asked to agree to a terms-of-use.
     146  * Note: If this config option is **not** set but the other two above it **are set**, the behavior of the site will be as follows. New accounts, whether created from the BOINC client or the Web site, will see a terms-of-use dialog which the user must agree to. However, existing accounts, when they login, are not asked to agree to a terms-of-use.
     147
     148== Consent to statistics exports ==
     149
     150How `STATSEXPORT` affects `db_dump`. If the `STATSEXPORT` consent_type is **enabled** in the OPS pages, users will be able to select whether they consent to having their statistics exported. This option is **false** by default. This option is found in the project preferences page, example: `https://projectURL/prefs.php?subset=project`. This option is also **false** by default.
     151
     152Only if a user has consented to this `STATSEXPORT`, then `db_dump` will include their user account and their hosts in the anonymous statistics created.
     153
     154== Project-specific consent types ==
     155
     156On the manage consent type OP pages, you may add your own consent types. However, you must provide any custom code that **uses** this consent type.