# 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.</p>
    <p>When you start this module, it automatically creates a registation plugin and puts it on a new content item. To make it live, you should navigate to that content item and publish it.</p>
    <p>To register, 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.</p>
    <p>By default, the plugin will create a new account in a Pending state and send a verification email to the email address given by a new user, and then change the account status to Active when the user verifies their email address by clicking the link in the email.</p>
    <p>The plugin settings encompass a range of possible setups:<ol>
        <li>The <strong>Initial signup</strong> tab defines the various options for the registration form itself</li>
        <li>The <strong>Custom fields</strong> tab allows you to add custom fields to the registration form (they must first be defined in Organizer->Configuration->Datasets->Users</li>
        <li>The <strong>Activation</strong> tab defines whether new accounts are made as Users (who may log in, once activated) or as Contacts (who may not log in), whether to send an email notification, whether to make a User account active automatically after the email address is verified (or whether to await administrator approval), and how to redirect the new user when they first log in.</li>
        </ol>

    <p>For email notification, 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
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

jobs:
    job:
        name: jobSendDelayedRegistrationEmails
        static: true
        months: jan,feb,mar,apr,may,jun,jul,aug,sep,oct,nov,dec
        days: mon,tue,wed,thr,fri,sat,sun
        hours: >
            0h,1h,2h,3h,4h,5h,6h,7h,8h,9h,10h,11h,12h,13h,14h,15h,16h,17h,18h,19h,20h,21h,22h,23h
        minutes: 0m
        log_on_action: true
        log_on_no_action: false
        email_on_action: true
