Moodle-Cvent

Sponsored by:
    United States Baha'i National Center: http://american.bahai.us/

Supported Moodle versions:
    * 2.0+

Introduction:
    If you're a Cvent customer and you've got access to their integration API,
    this enrollment module allows you to get new and updated user accounts and
    enrollments from Cvent.

    The code is designed to make the best possible use of their API, attempting
    to get all (but only) the necessary data to keep moodle up-to-date while
    using the smallest possible number of API calls. (Cvent limits the number of
    calls that can be made within a 24-hour period.)

    This has been developed specifically for one client, but the hope is that
    others will also find this to be useful. Comments, questions, and patches
    are welcome!

Installation:
    Copy the the contents of this directory into your own moodle, and then go
    to http://yourmoodle.tld/admin/ in your browser. This will create the DB
    tables. Then go to
    http://yourmoodle.tld/admin/settings.php?section=manageenrols to
    enable the Cvent module and configure its settings.

You MUST be a Cvent customer with access to their API service, because:

    1. in the settings page you'll need to enter the authentication information
       (username, account number, and password) they give you for their API, and
    2. you must contact Cvent and give them your server's IP address so they can
       add it to their whitelist.

    If you have any authentication errors (such as "INVALID_LOGIN"), please be
    sure both of these things have been done.

Synchronizing:
    This plugin uses Moodle's cron() feature to synchronize regularly.

    Each execution of the cron() for this enrolment plugin should use no more
    than 8 Cvent API calls, unless you have more than 10k updates in between two
    runs of this script.

Testing:
    Just to be sure the basic connection works, you can execute the following on
    the command line:
        php enrol/cvent/cli/test.php?

    Without any arguments, that script will just attempt to make a connection to
    Cvent. The script will tell you whether the connection was successful.

    test.php can do other things, too, and it's intended that developers will
    monkey with it as needed for debugging.

TODO:
    * add configuration settings that determine how user provisioning works
        * how do we check for pre-existing accounts?
        * how do we set username/password for new accounts?
    * document how user provisioning and enrollment handling work

Matt Oquist 
Sat Mar 10 14:39:33 EST 2012