# You must use a tab-size of 4 spaces to edit this file.
---
author_name: Tribal Systems
copyright_info: © Tribal Limited
editions: Pro, ProBusiness, Enterprise
start_running_on_install: false
license_info: 'Modified BSD License'
display_name: Extranet Registration
description: |
    <p>This module allows a visitor to register an account as an extranet user, or as a contact.</p>

    <p>When this module is started, it creates an HTML registration page with a registration plugin on it. You should navigate to that content item, check the settings, and publish it.</p>

    <p>In typical use, a visitor must enter their email address, first and last name, and choose a password. The plugin settings have a range of options, and it is possible to let a user choose a public "screen name", to require them to accept terms and conditions, to fill in custom fields from the Users & Contacts dataset, and more. See plugin settings for detailed options.</p>

    <p>The normal behaviour is to create a new User account with a "pending" status, with the system sending a verification email to the email address given by the user. Provided the user clicks the verification link, the account status is change to "active". Once "active", the user can log in to areas of the site where the content items have their permissions set to share to "all extranet users".</p>

    <p>It is possible to have the status remain as "pending" after the verification step, so that an administrator should manually check and activate the account. It is also possible to use Groups, and by a user being a member of a group they are granted access to areas of the site whose content items are shared only to members of a certain group.</p>

    <p>Most behaviours are defined in the plugin settings, but note also that there are site settings for User and Contact data, and for User permissions, which affect global behaviour.</p>

    <p>For emails sent by this module, the email template can contain various merge fields:</p>
            <ul>
                <li>[[first_name]] - user's first name</li>
                <li>[[last_name]] - user's last name</li>
                <li>[[screen_name]] - user's screen name</li>
                <li>[[password]] - user's password (only available at the time of sign-up)</li>
                <li>[[email]] - user's email address</li>
                <li>[[hash]] - a hash code required to activate the email address (for use in email verification templates only)</li>
                <li>[[cms_url]] - this website's URL
                <li>[[email_confirmation_link]] - a confirmation link to finish registration process (for use in email verification email templates only)</li>
                <li>[[organizer_link]] - a link to the newly created user in Organizer (for use in admin notification templates only).</li>
                <li>[[user_groups]] - comma separated list of groups to which user is signed up (can only be used after user's email address verification).</li>
            </ul>
category: management
keywords: extranet, new, register, sign, signup, user

# Reminder: you need to increment the LATEST_REVISION_NO in this module's
# latest_revision_no.inc.php file if you change any of the fields below:
vlp_class_name: zenario_extranet_registration
css_class_name: zenario_extranet_registration
is_pluggable: true
can_be_plugged_into:
    content_items: true
    layouts: false
    regular_nests: false
    slideshows: false
    ajax_nests_without_conductor: false
    ajax_nests_with_conductor: false
plugin_must_be_on_public_page: true
can_be_version_controlled: false
default_framework: personal
special_pages:
    special_page:
        page_type: zenario_registration
        default_alias: register
        default_title: Register
        only_show_to_visitors_who_are_logged_out: true
        logic: create_and_maintain_in_default_language
        allow_hide: true

# Warning: adding a new dependency to an existing module will break any existing sites
# where the dependency is not running.
# You can fix this on a per-site basis by manually running the dependency, i.e. by running
#   UPDATE zenario_modules SET status = 'module_running' WHERE class_name = 'dependency'
# in MySQL and then going to /admin/ to apply database updates.
# If this is a core module, consider using runNewModuleDependency() in a 
# database-revision in zenario/admin/db_updates/step_4_migrate_the_data/plugins.inc.php
# to fix it automatically for every site.
dependencies:
    zenario_extranet: true
    zenario_users: true
    zenario_country_manager: true
default_instance_name: Extranet Registration

