Elive - Elluminate Live! (c) client library

Version 0.64

The following (somewhat contrived) example sets up a meeting of selected participants:

    use Elive;
    use Elive::Entity::User;
    use Elive::Entity::Meeting;

    my $MeetingName = 'Meeting of the Smiths';

    Elive->connect('http://someEllumServer.com/test',
                   'serversupport', 'mypass');

    my $participants = Elive::Entity::User->list(filter => "(lastName = 'Smith')");
    die "smithless" unless @$participants;

    my $start = time() + 15 * 60; # starts in 15 minutes
    my $end   = $start + 30 * 60; # runs for half an hour

    my $meeting = Elive::Entity::Meeting->insert({
	 name           => $MeetingName,
	 facilitatorId  => Elive->login,
	 start          => $start . '000',
	 end            => $end   . '000',
	 });

    my $participant_list = $meeting->participant_list;
    $participant_list->participants($participants);
    $participant_list->update;

    Elive->disconnect;

Elive is a set of Perl bindings and entity definitions for the Elluminate Live! SDK.

The Elluminate SDK runs as a SOAP service and can be used to automate the raising meetings and launching of meetings; as well as managing meetings, users, groups, preloads, recordings and other related entities.

Elluminate Live! (c) is is a web tool for virtual online classrooms.

It is suitable for online collaboration, demonstrations, meetings, web conferences, seminars and IT deployment, training and support.

Users, Meetings and other resources are stored in a management database. These can be accessed via the Elluminate Live! SDK.

Most actions that can be performed via the web interface can also be achieved via the SOAP SDK. This is known as the Command Toolkit and is detailed in chapter 4 of the Elluminate Live! Software Developers Kit.

This module provides Perl object bindings to Elluminate Live! entities via the command toolkit.

     my $e1 = Elive->connect('http://myServer.com/test1', 'user1', 'pass1');

     Elive->connect('http://myServer.com/test2', 'user2', 'pass2');
     my $e2 = Elive->connection;

Connects to an Elluminate server instance. Dies if the connection could not be established. If, for example, the SOAP connection or user login failed.

The login user must be an Elluminate Live! system administrator account.

See also Elive::Connection.

     $e1 = Elive->connection
         or warn 'no elive connection active';

Returns the default Elive connection handle.

Returns the login user for the default connection.

Returns the server details for the default connection.

Disconnects the default Elluminate connection. It is recommended that you do this prior to exiting your program.

    Elive->debug(1)

    Set or get the debug level.

      0 = no debugging
      1 = dump object and class information 
      2 = also enable SOAP::Lite tracing
      3 = very detailed

    Elive->check_adapter('getUser')

Asserts that the adapter is valid, i.e. it's in the list of known adapters.

See also: elive_lint_config.

Returns an array of hash-value pairs for all Elluminate Live! adapters required by Elive. This list is cross-checked by the script elive_lint_config.

Associate an inside-out property with objects of a given class.

Elluminate Services Errors:

"Unable to determine a command for the key : listXxxx"

This may indicate that the particular command adaptor is is not available for your site instance.

Check that your Elluminate Live! server software version; This module has been tested against 9.0, 9.1 and 9.5.2

If the problem persists, the command entry may be missing from your site configuration file. Please follow the instructions in the README file for instructions on detecting and repairing missing adapters.

elive_query is an example simple sql-like script. It is a basic program for listing and retrieving entities. It serves as a simple demonstration script, and can be used to confirm basic operation of Elive.

It servers a secondary function of querying entity metadata. For example, to show the user entity:

    $> elive_query
    Elive query 0.xx  - type 'help' for help

    elive> show
    usage: show group|meeting|meetingParameters|participantList|preload|recording|serverDetails|serverParameters|use

    elive> show meeting
    meeting: Elive::Entity::Meeting:
      meetingId          : pkey Int        
      allModerators      : Bool      -- all participants can moderate
      deleted            : Bool            
      end                : HiResDate -- meeting end time
      facilitatorId      : Str       -- userId of facilitator
      name               : Str       -- meeting name
      password           : Str       -- meeting password
      privateMeeting     : Bool      -- don't display meeting in public schedule
      restrictedMeeting  : Bool      -- Restricted meeting
      start              : HiResDate -- meeting start time

This is a demonstration script to create a meeting, set options, assign participants and upload meeting preloads (whiteboard and media files to be used to used for the meeting.

For more information, type the command: elive_raise_meeting --help

A utility script that checks your Elluminate server configuration. Please see the README file.

Perl Modules:

Elive::Connection - Elluminate SOAP connection

Elive::Struct - base class for Elive::Entity

Elive::Entity - base class for all elive entities

Elive::Entity::Group

Elive::Entity::Meeting

Elive::Entity::MeetingParameters

Elive::Entity::ParticipantList

Elive::Entity::Preload

Elive::Entity::Recording

Elive::Entity::ServerDetails

Elive::Entity::ServerParameters

Elive::Entity::User

Scripts:

elive_query - simple interactive queries on Elive entities

elive_raise_meeting - sample script that create meetings via one-liners

elive_lint_config - sanity checker for Elluminate site configurations

Elluminate Live! Documentation. This comes with your distribution

ELM2.5_SDK.pdf

General Description of SDK's available for Elluminate Live!. In particular see section 4 - the SOAP command toolkit.

DatabaseSchema.pdf

Elluminate Database Schema Documentation.

InstanceManager.pdf

Describes setting up multiple site instances.

Database Access

The Elluminate Live! advanced configuration guide mentions that it can be configured to use other databases that support a JDBC bridge (most databases in widespread use). It specifically mentions SQL Server or Oracle. MySQL is supported with 9.5.0

LDAP Authentication

Elluminate Live! can also be configured to use an LDAP repository for user authentication. Users can still be retrieved or listed.

* You can map both of the user's userId and loginName to the LDAP uid attribute.

* Updates and deletes are not supported by the LDAP DAO adapter.

David Warring, <david.warring at gmail.com>

Elive is a newish module

It has been used and tested against a number of sites running Elluminate 9.0 to 9.7.

So far it does not implement all SOAP calls, but concentrates on entities such as users, meetings, preloads and meeting participants.

Elive does not support hosted (SAS) systems

The package currently supports only the installed server version of Elluminate Live which uses the ELM management layer. It does not yet support the hosted servers deployed with SAS (Session Administration System).

Please report any bugs or feature requests to bug-elive at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Elive. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

You can find documentation for this module with the perldoc command.

    perldoc Elive

You can also look for information at:

* RT: CPAN's request tracker

http://rt.cpan.org/NoAuth/Bugs.html?Dist=Elive

* AnnoCPAN: Annotated CPAN documentation

http://annocpan.org/dist/Elive

* CPAN Ratings

http://cpanratings.perl.org/d/Elive

* Search CPAN

http://search.cpan.org/dist/Elive/

Thanks to Lex Lucas and Simon Haidley for their testing, support and direction during the construction of this module.

Copyright 2009 David Warring, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.