MoodleDocs - User contributions [en]

Emeeting module

2006-09-05T14:09:39Z

Nitle06:

{{Emeeting}}
The eMeeting module is a simple interface between Marratech video conferencing suite and Moodle. It allows meetings to be created on Moodle as course activities. It uses special servlets attached to the Marratech API to seamlessly create corresponding rooms on Marratech.

[[Emeeting module installation]]

[[Emeeting module Log4j]]

[[Category:Modules (non-standard)]]
[[Category:Administrator]]
[[Category:Teacher]]

Emeeting Participation Logs

2006-08-04T15:09:04Z

Nitle06: /* Participation logs by Emeeting */

{{Emeeting}}
__FORCETOC__

See the participation logs entry [[mod/emeeting/view#Viewing_participation_logs | here]].

== Participation logs by Emeeting ==

This page displays a table with information about the usage of the eMeeting instance.

*First Name: This is the first name of the user who entered the eMeeting

*Last Name: This is the last name of the user who entered the eMeeting

*Time Entered: This is the time at which the user entered the eMeeting

*Time Exited: This is the time at which the user left the eMeeting

These logs would appear a little while after the eMeeting is closed on the Marratech side.

[[Category:Teacher]],[[Category:Administrator]]

Emeeting Admin Logs

2006-08-04T15:08:31Z

Nitle06:

{{Emeeting}}
__FORCETOC__
= eMeeting Admin Logs =

These are the logs that will be viewed by the admin. The page contains two tables, Meeting logs and Participation Logs. There is a link at the top of the page that will take the user to the Participation Logs at the bottom of the page for convenience.

== Meeting Log ==

This table shows the number of sessions, number of participants, and total expected bandwidth usage for each cron cycle. Each entry also has a "By Room" link that takes the user to a page which displays a detailed listing of all the emeetings that were active during that time.
This table can be sorted based on field information by clicking on the titles of the columns.

== Participation Log ==

This table shows the participation logs for every meeting that has occured in the moodle system. It is similar to the emeeting specific participation logs that a teacher would see in a course. It displays the Course Name, Meeting Name, the First and Last name of the participant, time the participant entered the meeting, and the time the participant left the meeting.

[[Category:Administrator]]

Emeeting Admin Setting

2006-08-04T15:08:00Z

Nitle06: /* Config Page Buttons */

{{Emeeting}}
== Site Administrator Settings ==

In this page the administrator must configure the settings of the eMeeting module. It is very important that the admin sets the IP address of their Marratech server in order to enable refreshing from Marratech the limits of their license. From this the admin can then configure his own setting with respect to the license limitations of Marratech.

=== Basic Settings ===
*Admin Logs: This link will take you to a page which displays the logs for eMeeting usage. It documents the number of open sessions, number of participants, and total bandwidth at a certain time.
*Max Participants: Here the admin sets the limit on how many users can access the Marratech server at one time. This is directly dependent on the Marratech license. Make sure to click the refresh from Marratech button at the bottom of the page in order to fetch the license information for this particular instance.
*Max Duration: This sets the maximum length of any eMeeting in minutes. This is totally under the discretion of the site administrator.
*Bandwidth Warning Threshold: This sets the number of megabits of total bandwidth usage by all concurrent eMeetings at which the administrator will receive a warning email. The option of "No Limit" means the administrator will receive no warning.
*Marratech IP: This is the most important setting for the administrator. This MUST BE SET. This sets the destination of the Marratech server that this instance of Moodle will be contacting.
*Auto Kick Participants: This sets whether or not participants will be automatically kicked out of an eMeeting room when the duration for that meeting expires. When this box is check Auto Kick is enabled.
*Auto Kick Message: This will be the message that is broadcast to users inside an eMeeting room when the duration expires and they are automatically kicked out of the room. This only needs to be set when Auto Kick is enabled.
*Broadcast Warning: This sets the time before the end of a meeting (in minutes) when a message will be broadcast to the room. The message will alert the users in the room that the meeting duration has nearly run out. If it is set to "0 (No Warning)" no warning will be sent.
*Broadcast Message: This is the message that will be sent to the room according to the time specified in the Broadcast Warning option.
**The variable `$minutes` will be displayed as the amount of time remaining in the meeting.

=== Profile Selection ===
==== Standard Profiles ====
With these profiles, you can create as many rooms as you like, but the number of seats taken up is limited to the license size. These type of profiles are noted by the postfix "seats" in the profile selection.
==== Auditorium Profiles ====
Auditorium profiles allow an infinite number of seats, but you are limited in the number of auditorium rooms you can create according to your license restrictions.
==== Profile Selection Table ====
Displayed in this table will be the Marratech room profiles fetched from the Marratech server as options for eMeeting room creation. The administrator also has the option of going to the Marratech server and creating his own template to be used by teachers when they create an eMeeting. It is necessary that at least one of these profiles be selected in order to be able to create an eMeeting. If there are no profiles displayed you can click the refresh from Marratech button to gather the profile possibilities provided the administrator entered the Marratech server IP.
*Name: This is the name of the profile. This is the name that will show up in the drop down menu when creating an eMeeting followed by the associated bandwidth.
*Bandwidth: This is the bandwidth load that the particular room profile can handle.
*Visible: This is where the administrator decides which profiles will be visible for use by teachers when creating an eMeeting. When checked, this profile is visible to teachers.

=== Email Body Message ===
This is a body message that will be attached to the emails that will be sent to the users who are invited for a meeting. Both HTML and Plain-Text message bodies are required, so that it could be viewed by various kinds email clients.

*HTML Email Body: This will be in HTML format so it is viewable by email clients that support HTML formats. You do not need to use any HTML tags, plain text typed into the text area will suffice.
*Plain_Text Email Body: This is totally in plain text. This can be viewed by plain text only email clients.

*Placeholders: These two Email bodies can include placeholders that will be replaced by the corresponding meeting information when the email is sent. Using these placeholders makes the emails flexible for use by every eMeeting. You can change the default message format using any of the following placeholders that you prefer to appear in the email body.
** $title- This is the title of the eMeeting.
** $description- This is the description of the eMeeting.
** $time- This is the time at which the eMeeting will take place.
** $duration- This is the length of the eMeeting in minutes.
** $coursename- This is the course in which the eMeeting is created.

== Config Page Buttons ==
*Save Changes: This saves any changes you have made to any of the configuration settings
*Refresh from Marratech: This retrieves the license information from the Marratech server IP that the administator specifies in the Marratech IP field. This will affect the Max Participants and the Profile Selection. When hitting the Refresh from Marratech button, all possible profiles are made visible to teachers by default.
*Restore Default Email Messages: This will restore the HTML Email Body and Plain_Text Email Body fields back to their defaults.

[[Category:Administrator]]

2.1:Further Details and Validating a meeting

2006-08-04T15:07:22Z

Nitle06:

{{Emeeting}}
__FORCETOC__
== Further Details Page ==

On the Further Details, you can specify the details of the meeting. Specifically, you can set the title,description, the privileges for students and guests, the profile for the eMeeting room, and whether the students in the course should be notified of the eMeeting with an email.
*Title is the title you wish to give your eMeeting.
*The description text area allows you to set the description of the meeting, which users will see when they click on the eMeeting. This uses the standard Moodle text editor.
*If you have selected "Choose Members" in the seats menu from the previous page and there is a conflict with the number of license, a message will appear, following the description box, that tells how many students you can schedule to attend the meeting. To disable a student for the meeting, select "No access" for their privilege level (see below).
*Set Student Privileges allows you to define different privileges for each student. Privileges refer to the type of access you want your users to have. The different types are as follows:
**Moderator allows the user to send audio, video, and chat, both publicly (to all users) and privately (between two users). In addition, the user can draw on the whiteboard for all to see. The user is also able to kick other users out of the eMeeting room and lock the room to prevent others from entering. This is the highest possible level, and you should be careful in assigning it. Teachers and the Moodle administrator are set as moderators automatically.
**Presenter is the second highest privilege level. Presenters have the same broadcasting capabilities but lack the ability to kick users and lock the room. This could be useful for guest speakers, for instance.
**The Attendee privilege level gives the user the ability to send public audio, video, and chat. In addition, Attendees can use the Telepointer to point on the whiteboard.
**Listeners are a receive only user. They can send no audio,video, or chat. Most students should probably be listeners or attendees.
**No access means that the student will not be permitted to attend the eMeeting at all. Setting students to no access allows you to have only a portion of the class attending the meeting. This option will not appear if you have selected "All Members" from the seats menu on the previous page.
*The "Add Guests" section allows you to specify the details for the guests which you have selected to join the meeting, including the name and email. In addition, you may also specify each guest's privileges. This works in the same way as student privileges, but you will not be able to set a guest to "No access"
*Select an eMeeting profile allows you to choose the profile for your eMeeting. Profiles define the basic settings of the meeting; in general, these should only differ by bandwidth, the connection speed of the room. The higher the bandwidth, the better the quality of communication, but your institution will only be able to provide so much bandwidth before encountering problems. On the left side of the colon is the profile's name, and to the right is the bandwidth (in kilobits per second). The Moodle administrator sets the profiles from which you can choose. Ordinarily, you will see a drop-down menu allowing you to select a profile, but if the administrator has only selected one profile, you will just see the profile name and bandwidth written out.
**If you selected the All Members or Choose Members option on the previous page then you only have access to the standard room profile with a limited number of seats.
**If you selected the Auditorium option on the previous page then you only have the auditorium profiles. There are a limited number auditoriums available but you have unlimited seats.
*If you check the email notification box, Moodle will send out a notification email, telling them about the eMeeting that you're scheduling. This email will contain all the important information about the eMeeting, as well as a link to the eMeeting and an [http://en.wikipedia.org/wiki/ICal iCal] object which they can use for scheduling. Guests will always be sent a notification email, regardless of whether you check the box.

Once you have entered these details, click the "Create eMeeting" button. This will validate the meeting one more time. Assuming there are no problems with validating, your eMeeting will be created.

== Validation ==

Marratech, the system on which the eMeeting module is built, is a commercial system with a limited license. This means that, depending on the room type, there are either a certain number of users that can be on at one time; or a certain number of auditoriums that can be online at once. If the seat limit for standard rooms is met, new users will not be able to log on. If there are to many auditoriums open then you might not be able to create your room. Validation exists to avoid that problem. Once you click the "Check Availability" button on the previous page, the eMeeting will check itself against the other eMeetings that exist for all the courses. If your meeting will exceed the user limit, you will be notified. This can take one of three forms:
*If you have selected "All Students" for the number of seats, or if the seats for the given time period are completely full, you will receive an error message telling you that the time is not available. In addition to telling you this, the error message will also display the names of the eMeetings which conflict with your meeting. Clicking the continue button will take you back to the first page, where you will reenter your initial information.
*However, if you have selected "Choose Members", you will be allowed to continue, but on the next page, you will receive a message telling you the maximum number of students you may select to attend the meeting.
*Finally, if you have selected "Auditorium", you will recieve an error that a meeting cannot be created at that time. You will need to create your meeting at a different time.
In addition to checking the license limit, Validation will also give you an error message if the time you have selected is in the past, or if the duration that you have selected is somehow invalid (e.g., 0:00). Once again, clicking the continue button will return you to the first Create page.

Finally, you may also get a message saying that no profiles have been set. In this case, the settings for the eMeeting module lack basic information that they need to be created. Unfortunately, there is nothing that you can do to fix this, and you should contact your Moodle administrator, who can remedy the problem.

In most circumstances, though, none of this will occur, and you will go directly from the first Create page to the second.

[[Category:Teacher]],[[Category:Administrator]]

Further Details and Validating a meeting

2006-08-04T15:07:22Z

Nitle06:

2.1:Creating and Updating a meeting

2006-08-04T15:06:40Z

Nitle06:

{{Emeeting}}
__FORCETOC__

== Creating an eMeeting ==
This is the description of creating a eMeeting activity to be used for the course. Teachers and administrators will be able to use this to schedule time within the Marratech server for a meeting. If you do not have the Marratech client installed on your computer you should do so before working in a meeting.
http://www.marratech.com/

===Adding a new eMeeting===
In this page, you will set the most basic details about the meeting: date and time, duration, whether you want all members of the course to participate, the number of guests you wish to invite, the group settings for the meeting, and whether the eMeeting will be visible to students.
*Date and time for the meeting are fairly self-explanatory, but the time you select cannot be in the past. If it is an error message will be displayed.
*Duration is in hours, followed by minutes.
*Seats refers to the number of students who will be attending the meeting. There are three options: All Members, Choose Members, and Auditoriums.
**All Members indicates that you want everyone in your course to participate; if there is a conflict with the number of licenses for the time you have selected, you won't be able to reach the second page. (Go to the validation explanation for a more in-depth explanation of this)
**Choose Members, on the other hand, indicates that you are willing to hold the meeting with only some of your students. If there is a conflict at your chosen time, but there won't be too many people scheduled, you will be able to select a portion of your students to attend the meeting on the next page.
**Auditorium: you can only pick auditoriums if your administrator has available profiles for auditoriums and your Marratech Licenses contains auditoriums. You will only have access to auditorium profiles when you select your profile and validation checks against the other auditorium rooms.
*Number of Guests indicates the number of guest users that you wish to allow into the eMeeting. This value will count toward your total number of users for validation purposes.
*Group mode allows for using Moodle groups; check the help documents on this topic for more information. ('''TO DO: add link to said help''')
*Visible to students allows you to make the eMeeting hidden when it is created. If you choose "Hide" in the drop-down menu, students will not be able to view the eMeeting once it is created, though you can later change it to be visible. If you choose "Show", however, students will be able to see the eMeeting.

Once you have set all these options to the values that you want, click "Check Availability" to proceed to the next step. This will validate your eMeeting and take you to the [[mod/emeeting/validate|Further Details page]].

== Updating an eMeeting ==

There are two ways to update an eMeeting. You can go to your main course page, click "Turn editing on", and then click the button that looks like a hand. Alternatively, you can click on the eMeeting itself and then click on the "Update this eMeeting" button on the right hand side of the bar at the top of the page. This button will appear on both the eMeeting details page and the Meeting Status page.

The update interface is effectively identical to the interface for creating a new eMeeting; however, the details from your current meeting will already be filled in for you. Updating still goes through the availability check, so if you change the time, you may run into licensing conflicts (see the help on creating a meeting for more details). You cannot update a meeting that is already in progress.

The one major difference is that guests functionality in the update option for a meeting has changed from the create eMeeting option. Right now, you cannot change the number of guests in a meeting manually. Nor can you add new guests, however, if there is a guest you no longer wish to invite you can remove them from the meeting and they will recieve an email saying that the eMeeting is cancelled. They will not be able to log into the meeting as well.

[[Category:Teacher]], [[Category:Administrator]]

Creating and Updating a meeting

2006-08-04T15:06:40Z

Nitle06:

Creating and Updating a meeting

2006-08-04T15:06:18Z

Nitle06:

Creating and Updating a meeting

2006-08-04T15:05:59Z

Nitle06:

Emeeting module Log4j

2006-08-04T15:05:12Z

Nitle06:

{{Emeeting}}

== Log4j Help ==

The java servlets use Log4j for all the logging purposes. It includes two standard methods of outputting the logs, one to the console, the other is a Daily Rolling File Appender that will roll all the days logs into a new file every night at midnight. Log4j is configured in our code through a standard log4j property file that is just a simple text file.

The default log4j property file is:

log4j.rootLogger=INFO, console, logfile
log4j.logger.TestLogProp=ERROR

log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%-5p %c %x - %m%n

log4j.appender.logfile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.logfile.File=log\logout.txt
log4j.appender.logfile.DatePattern='.'yyyy-MM-dd
log4j.appender.logfile.Threshold=INFO
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%p %t %c -%m%n

'''It is strongly recommended that you change the default location, it will create a log folder in the location the servlets are run, which can be difficult to find.'''

Other things you might change:
** The type of file that is used, there are several kinds
*** File Appender
*** Rolling File Appender
** The Threshold level, it is currently set to info which includes all but the lowest level statements. You might need more or less, most of our statements are debug statements with simple method entrys.
*** DEBUG (lowest)
*** INFO
*** WARN (middle)
*** ERROR
*** FATAL (highest)
** The Conversion Pattern, it currently uses a standard one but you may wish to configure it.
*** %p --The priority of the logging event(debug, warn)
*** %t --The name of the thread generating the event
*** %c --The category of the logging event
*** %m --message
*** %n --newline character
*** %d --date of the logging event
*** %l --Outputs the source code location information

For other information you can look at the following websites:
This is the official Log4j Project home page that contains helpful information.

[http://logging.apache.org/log4j/docs/index.html Log4j Project - Introduction]

This is a helpful walk through that is very thorough and helpful.

[http://www.vipan.com/htmdocs/log4jhelp.html Don't Use System.out.println!]

[[Category:Administrator]]

Emeeting Participation Logs

2006-08-04T15:04:29Z

Nitle06:

mod/emeeting/participationlogs

2006-08-04T15:04:20Z

Nitle06:

#REDIRECT [[Participation Logs]]

Emeeting Admin Logs

2006-08-04T15:03:43Z

Nitle06:

mod/emeeting/adminlog

2006-08-04T15:03:38Z

Nitle06:

#REDIRECT [[Admin Logs]]

Emeeting Admin Setting

2006-08-04T15:03:00Z

Nitle06:

mod/emeeting/config

2006-08-04T15:02:54Z

Nitle06:

#REDIRECT [[Admin Setting]]

Emeeting Details and Status

2006-08-04T15:02:22Z

Nitle06:

{{Emeeting}}

== eMeeting Details Page ==

This page is meant to display details about the eMeeting and provide a way to enter the meeting through Moodle. It will include the name of the meeting, the time it starts according to the users timezone, the duration of the meeting, the meeting profile, a link to "Check Status / Join Meeting", a link for teachers and Admins that appears once the meeting is over showing the meeting participation logs, and shows entered meeting description. It also contains a link to download the Marratech client. Depending on whether or not your Marratech Administrator has Java Web Start turned on you may need to download the client.

==Meeting Status Page ==
This page will display information about a meeting the is received from the meeting.
It will display the status of the eMeeting, they are-
* The eMeeting is ready to be activated
** This is only shown to teachers or administrators
** This will also display a link to Activate meeting which will create the room on Marratech.
* The eMeeting is Active
** This will be seen by all users
** It will display a button to enter the meeting
*** To enter the meeting it will download a file, connect.sdx. This will launch the Marratech client with you logged into the eMeeting
** If you are an admin and not a member of the course you will have access to the meeting but you will receive a warning message.
*** It is "Warning, You are not a current course member and are not counted for the meeting participant number but will count against the Marratech License if you enter the room."
* The eMeeting is currently inactive
** This will display when the meeting is outside its time slot
** If you are a student you will see this message whenever the meeting is not active

Next it will display the meeting information, including its name, the time of the meeting, the duration, and its description.

It also contains a link to Marratech so that you may download the client.

== Updating an eMeeting ==

There are two ways to update an eMeeting. You can go to your main course page, click "Turn editing on", and then click the button that looks like a hand. Alternatively, you can click on the eMeeting itself and then click on the "Update this eMeeting" button on the right hand side of the bar at the top of the page. This button will appear on both the eMeeting details page and the Meeting Status page.

The update interface is effectively identical to the interface for creating a new eMeeting; however, the details from your current meeting will already be filled in for you. Updating still goes through the availability check, so if you change the time, you may run into licensing conflicts (see the help on creating a meeting for more details). You cannot update a meeting that is already in progress.

If you wish to update an eMeeting that has guests invited to it, you will notice that when you go to the 2nd update page a table shows the guest user with a check box next to his or her name. If you were to uncheck this box this would cause the guest to be uninvited. This means that they will not have access to the eMeeting and they will receive a friendly email telling them that the eMeeting has been cancelled.

== Deleting an eMeeting ==

There are two ways to delete an eMeeting. First, you can go to the main course page, and click "Turn editing on". Then, click the X-shaped icon next to the eMeeting you wish to delete. You will be prompted with a message asking if you are sure you wish to delete the eMeeting; if you are, click "Yes." Otherwise, you can click "No," and the meeting will not be deleted.

In addition, you can also delete an eMeeting by going to the eMeeting Details page and clicking the "Delete eMeeting" button on the right side of the page, below the "Update this eMeeting" button. This works in the same way as clicking on the X on the main page. When you delete a meeting it will also delete it on Marratech if it is in progress.

[[Category:Teacher]],[[Category:Administrator]]

mod/emeeting/view

2006-08-04T15:02:17Z

Nitle06:

#REDIRECT [[Emeeting Details and Status]]

Further Details and Validating a meeting

2006-08-04T15:01:31Z

Nitle06:

mod/emeeting/validate

2006-08-04T15:01:25Z

Nitle06:

#REDIRECT [[Further Details and Validating a meeting]]

Creating and Updating a meeting

2006-08-04T15:00:28Z

Nitle06:

mod/emeeting/mod

2006-08-04T15:00:18Z

Nitle06:

#REDIRECT [[Creating and Updating a meeting]]

mod/emeeting/

2006-08-04T14:59:11Z

Nitle06:

#REDIRECT [[Emeeting module]]

mod/emeeting/

2006-08-04T14:58:59Z

Nitle06:

#REDIRECT [[Emeeting Module]]

mod/emeeting/mod

2006-08-04T14:58:18Z

Nitle06:

mod/emeeting/mod

2006-08-04T14:50:45Z

Nitle06:

{{Emeeting}}
__FORCETOC__
= Creating and Updating an Emeeting =

== Creating an eMeeting ==
This is the description of creating a eMeeting activity to be used for the course. Teachers and administrators will be able to use this to schedule time within the Marratech server for a meeting. If you do not have the Marratech client installed on your computer you should do so before working in a meeting.
http://www.marratech.com/

===Adding a new eMeeting===
In this page, you will set the most basic details about the meeting: date and time, duration, whether you want all members of the course to participate, the number of guests you wish to invite, the group settings for the meeting, and whether the eMeeting will be visible to students.
*Date and time for the meeting are fairly self-explanatory, but the time you select cannot be in the past. If it is an error message will be displayed.
*Duration is in hours, followed by minutes.
*Seats refers to the number of students who will be attending the meeting. There are three options: All Members, Choose Members, and Auditoriums.
**All Members indicates that you want everyone in your course to participate; if there is a conflict with the number of licenses for the time you have selected, you won't be able to reach the second page. (Go to the validation explanation for a more in-depth explanation of this)
**Choose Members, on the other hand, indicates that you are willing to hold the meeting with only some of your students. If there is a conflict at your chosen time, but there won't be too many people scheduled, you will be able to select a portion of your students to attend the meeting on the next page.
**Auditorium: you can only pick auditoriums if your administrator has available profiles for auditoriums and your Marratech Licenses contains auditoriums. You will only have access to auditorium profiles when you select your profile and validation checks against the other auditorium rooms.
*Number of Guests indicates the number of guest users that you wish to allow into the eMeeting. This value will count toward your total number of users for validation purposes.
*Group mode allows for using Moodle groups; check the help documents on this topic for more information. ('''TO DO: add link to said help''')
*Visible to students allows you to make the eMeeting hidden when it is created. If you choose "Hide" in the drop-down menu, students will not be able to view the eMeeting once it is created, though you can later change it to be visible. If you choose "Show", however, students will be able to see the eMeeting.

Once you have set all these options to the values that you want, click "Check Availability" to proceed to the next step. This will validate your eMeeting and take you to the [[mod/emeeting/validate|Further Details page]].

== Updating an eMeeting ==

There are two ways to update an eMeeting. You can go to your main course page, click "Turn editing on", and then click the button that looks like a hand. Alternatively, you can click on the eMeeting itself and then click on the "Update this eMeeting" button on the right hand side of the bar at the top of the page. This button will appear on both the eMeeting details page and the Meeting Status page.

The update interface is effectively identical to the interface for creating a new eMeeting; however, the details from your current meeting will already be filled in for you. Updating still goes through the availability check, so if you change the time, you may run into licensing conflicts (see the help on creating a meeting for more details). You cannot update a meeting that is already in progress.

The one major difference is that guests functionality in the update option for a meeting has changed from the create eMeeting option. Right now, you cannot change the number of guests in a meeting manually. Nor can you add new guests, however, if there is a guest you no longer wish to invite you can remove them from the meeting and they will recieve an email saying that the eMeeting is cancelled. They will not be able to log into the meeting as well.

Template:Emeeting

2006-08-04T14:49:57Z

Nitle06:

<div class="sideblock right" style="width:135px;">
<div class="header">Emeeting Module</div>
<div class="content">
* [[Emeeting module]]
** [[Emeeting module installation]]
** [[Emeeting module Log4j]]
* [[mod/emeeting/mod|Create/Update a meeting]]
* [[mod/emeeting/validate|Further Details/Validation]]
* [[mod/emeeting/view|Details and Status page]]
* [[mod/emeeting/config|Admin Settings]]
* [[mod/emeeting/adminlog| Admin Logs]]
* [[mod/emeeting/participationlogs|Participation Logs]]
</div>
</div>

Template:Emeeting

2006-08-04T14:49:41Z

Nitle06:

<div class="sideblock right" style="width:125px;">
<div class="header">Emeeting Module</div>
<div class="content">
* [[Emeeting module]]
** [[Emeeting module installation]]
** [[Emeeting module Log4j]]
* [[mod/emeeting/mod|Create/Update a meeting]]
* [[mod/emeeting/validate|Further Details/Validation]]
* [[mod/emeeting/view|Details and Status page]]
* [[mod/emeeting/config|Admin Settings]]
* [[mod/emeeting/adminlog| Admin Logs]]
* [[mod/emeeting/participationlogs|Participation Logs]]
</div>
</div>

mod/emeeting/mod

2006-08-04T14:48:03Z

Nitle06:

mod/emeeting/participationlogs

2006-08-04T14:47:29Z

Nitle06:

mod/emeeting/adminlog

2006-08-04T14:47:04Z

Nitle06:

mod/emeeting/config

2006-08-04T14:46:44Z

Nitle06:

mod/emeeting/view

2006-08-04T14:46:32Z

Nitle06:

mod/emeeting/validate

2006-08-04T14:46:02Z

Nitle06:

mod/emeeting/mod

2006-08-04T14:45:33Z

Nitle06:

{{Emeeting}}

== Creating an eMeeting ==
This is the description of creating a eMeeting activity to be used for the course. Teachers and administrators will be able to use this to schedule time within the Marratech server for a meeting. If you do not have the Marratech client installed on your computer you should do so before working in a meeting.
http://www.marratech.com/

===Adding a new eMeeting===
In this page, you will set the most basic details about the meeting: date and time, duration, whether you want all members of the course to participate, the number of guests you wish to invite, the group settings for the meeting, and whether the eMeeting will be visible to students.
*Date and time for the meeting are fairly self-explanatory, but the time you select cannot be in the past. If it is an error message will be displayed.
*Duration is in hours, followed by minutes.
*Seats refers to the number of students who will be attending the meeting. There are three options: All Members, Choose Members, and Auditoriums.
**All Members indicates that you want everyone in your course to participate; if there is a conflict with the number of licenses for the time you have selected, you won't be able to reach the second page. (Go to the validation explanation for a more in-depth explanation of this)
**Choose Members, on the other hand, indicates that you are willing to hold the meeting with only some of your students. If there is a conflict at your chosen time, but there won't be too many people scheduled, you will be able to select a portion of your students to attend the meeting on the next page.
**Auditorium: you can only pick auditoriums if your administrator has available profiles for auditoriums and your Marratech Licenses contains auditoriums. You will only have access to auditorium profiles when you select your profile and validation checks against the other auditorium rooms.
*Number of Guests indicates the number of guest users that you wish to allow into the eMeeting. This value will count toward your total number of users for validation purposes.
*Group mode allows for using Moodle groups; check the help documents on this topic for more information. ('''TO DO: add link to said help''')
*Visible to students allows you to make the eMeeting hidden when it is created. If you choose "Hide" in the drop-down menu, students will not be able to view the eMeeting once it is created, though you can later change it to be visible. If you choose "Show", however, students will be able to see the eMeeting.

Once you have set all these options to the values that you want, click "Check Availability" to proceed to the next step. This will validate your eMeeting and take you to the [[mod/emeeting/validate|Further Details page]].

== Updating an eMeeting ==

There are two ways to update an eMeeting. You can go to your main course page, click "Turn editing on", and then click the button that looks like a hand. Alternatively, you can click on the eMeeting itself and then click on the "Update this eMeeting" button on the right hand side of the bar at the top of the page. This button will appear on both the eMeeting details page and the Meeting Status page.

The update interface is effectively identical to the interface for creating a new eMeeting; however, the details from your current meeting will already be filled in for you. Updating still goes through the availability check, so if you change the time, you may run into licensing conflicts (see the help on creating a meeting for more details). You cannot update a meeting that is already in progress.

The one major difference is that guests functionality in the update option for a meeting has changed from the create eMeeting option. Right now, you cannot change the number of guests in a meeting manually. Nor can you add new guests, however, if there is a guest you no longer wish to invite you can remove them from the meeting and they will recieve an email saying that the eMeeting is cancelled. They will not be able to log into the meeting as well.

Emeeting module Log4j

2006-08-04T14:45:15Z

Nitle06:

Emeeting module Log4j

2006-08-04T14:44:57Z

Nitle06:

{{Emeeting}}

== Log4j Help ==

The java servlets use Log4j for all the logging purposes. It includes two standard methods of outputting the logs, one to the console, the other is a Daily Rolling File Appender that will roll all the days logs into a new file every night at midnight. Log4j is configured in our code through a standard log4j property file that is just a simple text file.

The default log4j property file is:

log4j.rootLogger=DEBUG, console, logfile
log4j.logger.TestLogProp=ERROR

log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%-5p %c %x - %m%n

log4j.appender.logfile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.logfile.File=log\logout.txt
log4j.appender.logfile.DatePattern='.'yyyy-MM-dd
log4j.appender.logfile.Threshold=INFO
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%p %t %c -%m%n

'''It is strongly recommended that you change the default location, it will create a log folder in the location the servlets are run, which can be difficult to find.'''

Other things you might change:
** The type of file that is used, there are several kinds
*** File Appender
*** Rolling File Appender
** The Threshold level, it is currently set to info which includes all but the lowest level statements. You might need more or less, most of our statements are debug statements with simple method entrys.
*** DEBUG (lowest)
*** INFO
*** WARN (middle)
*** ERROR
*** FATAL (highest)
** The Conversion Pattern, it currently uses a standard one but you may wish to configure it.
*** %p --The priority of the logging event(debug, warn)
*** %t --The name of the thread generating the event
*** %c --The category of the logging event
*** %m --message
*** %n --newline character
*** %d --date of the logging event
*** %l --Outputs the source code location information

For other information you can look at the following websites:
This is the official Log4j Project home page that contains helpful information.

[http://logging.apache.org/log4j/docs/index.html Log4j Project - Introduction]

This is a helpful walk through that is very thorough and helpful.

[http://www.vipan.com/htmdocs/log4jhelp.html Don't Use System.out.println!]

Emeeting module installation

2006-08-04T14:44:21Z

Nitle06:

{{Emeeting}}

The [[Emeeting module|eMeeting module]] is a simple interface between Marratech video conferencing suite and Moodle.

==Servlet Installation==

You have two options for deploying the servlets used in this plugin: you can install them in Marratech Manager or you can install them in a separate server environment, such as Tomcat.
'''Install servlets first, then the Moodle Module.'''

=== Installing Servlets into Marratech Manager ===
''Note: This installation has only been tested with Marratech Manager 3.4.''

==== Linux Installation ====
Extract <code>emeeting_linux_servletinstall.tar.gz</code> into a new directory.
In the directory run installer using:
./install_servlets [Marratech Manager installation directory]

After the installation, restart Marratech Manager. This can be done with:
/etc/init.d/MarratechManagerXX stop
/etc/init.d/MarratechManagerXX start
Where the <code>XX</code> depends on your version of Marratech Manager.
Go to the Compiling Servlets section.

==== Windows Installation ====

Extract the <code>emeeting_win_servletinstall.zip</code> into your Marratech Manager installation directory (ex. <code>c:\Program Files\Marratech\MarratechManager3.4</code>).

Restart your Marratech Manager. Go to Compiling Servlets section.

==== Compiling Servlets ====
Once the server is running, log into Marratech Manager
as admin. Go to:
Administration>Advance>Control Central>JSP&Servlets
Click the Compile All button.
Scroll down see that .jsp pages /mdlplug/* are active.
This completes the installation.

=== Installing Servlets on Tomcat ===
These instructions assume that you are using Windows and that you have a working copy of Tomcat on your system. If you do not have Tomcat, you may download it at http://tomcat.apache.org/. Note that our servlets will not function properly if the directory to which you install Tomcat has any spaces in it; this is an issue with Java and is unavoidable.

Once you have Tomcat configured on your server, go into the Tomcat Manager page. Then, under the "War file to deploy" heading, click the browse button and open the eMeeting .war file that you have downloaded to your computer. Then, click the "deploy" button on the Manager page. This will install the servlets in Tomcat.

Now, you need to configure two properties which the servlets require to run properly. Go to the Configuration pane (accessible from the Tomcat Monitor) and click on the Java tab. Add the following lines to the end of the "Java Options" box:

-Dnitle.nodekit_path=[nodekitpath]
-Dnitle.logconfig_path=[logconfigpath]

Replace [nodekitpath] with the full pathname to the node.kit file which you have generated from Marratech ([[emeeting/nodekit|How to generate a node.kit file]]). Similarly, replace [logconfigpath] with the full path to the webapps directory of your Tomcat distribution followed by /emeeting/WEB-INF/logproperties.txt. Click "OK" to save these changes, and then restart the Tomcat server. You should now be ready to run the servlets.

Use a similar procedure to install the servlets onto other Java servers.

== Moodle Module Installation ==
Dependencies: PHP 5, PEAR, PEAR package HTTP Request, running MarratechManager and installed servlets

# Extract the compressed file into your Moodle directory.
# Visit the main administration page to automatically set up the module tables.
# Go into the modules administration page, click on 'Settings' for eMeeting (http://MOODLEROOT/admin/module.php?module=emeeting on Moodle 1.6).
## Set the Marratech Manager address, DO NOT include following slash (ex. http://marratech.server.com:8000).
## Set the location of additional Marratech servlets, include following slash. This can be a subdirectory of the Marratech Manager root. (ex. http://othertomcat.server.com/mdlplug/)
## Click 'Save / Update Server Info', scroll down and check that there are tempelates in the 'Profile Selection' section.

'''You are now ready to enjoy the eMeeting Moodle Plugin!'''

[[Category:Administrator]]

Emeeting module

2006-08-04T14:43:55Z

Nitle06:

{{Emeeting}}
The eMeeting module is a simple interface between Marratech video conferencing suite and Moodle. It allows meetings to be created on Moodle as course activities. It uses special servlets attached to the Marratech API to seamlessly create correspoding rooms on Marratech.

[[Emeeting module installation]]

[[Emeeting module Log4j]]

[[Category:Modules (non-standard)]]
[[Category:Administrator]]
[[Category:Teacher]]

Template:Emeeting

2006-08-04T14:43:12Z

Nitle06:

<div class="sideblock right" style="width:125px;">
<div class="header">[[Emeeting module|Emeeting]]</div>
<div class="content">
* [[Emeeting module]]
** [[Emeeting module installation]]
** [[Emeeting module Log4j]]
* [[mod/emeeting/mod|Create/Update a meeting]]
* [[mod/emeeting/validate|Further Details/Validation]]
* [[mod/emeeting/view|Details and Status page]]
* [[mod/emeeting/config|Admin Settings]]
* [[mod/emeeting/adminlog| Admin Logs]]
* [[mod/emeeting/participationlogs|Participation Logs]]
</div>
</div>

Template:Emeeting

2006-08-04T14:42:04Z

Nitle06:

Emeeting module

2006-08-04T14:35:52Z

Nitle06:

The eMeeting module is a simple interface between Marratech video conferencing suite and Moodle. It allows meetings to be created on Moodle as course activities. It uses special servlets attached to the Marratech API to seamlessly create correspoding rooms on Marratech.

[[Emeeting module installation]]

[[Emeeting module Log4j]]

[[Category:Modules (non-standard)]]
[[Category:Administrator]]
[[Category:Teacher]]

Emeeting module Log4j

2006-08-04T14:35:20Z

Nitle06:

== Log4j Help ==

The java servlets use Log4j for all the logging purposes. It includes two standard methods of outputting the logs, one to the console, the other is a Daily Rolling File Appender that will roll all the days logs into a new file every night at midnight. Log4j is configured in our code through a standard log4j property file that is just a simple text file.

The default log4j property file is:

log4j.rootLogger=DEBUG, console, logfile
log4j.logger.TestLogProp=ERROR

log4j.appender.console=org.apache.log4j.ConsoleAppender
log4j.appender.console.layout=org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPattern=%-5p %c %x - %m%n

log4j.appender.logfile=org.apache.log4j.DailyRollingFileAppender
log4j.appender.logfile.File=log\logout.txt
log4j.appender.logfile.DatePattern='.'yyyy-MM-dd
log4j.appender.logfile.Threshold=INFO
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%p %t %c -%m%n

'''It is strongly recommended that you change the default location, it will create a log folder in the location the servlets are run, which can be difficult to find.'''

Other things you might change:
** The type of file that is used, there are several kinds
*** File Appender
*** Rolling File Appender
** The Threshold level, it is currently set to info which includes all but the lowest level statements. You might need more or less, most of our statements are debug statements with simple method entrys.
*** DEBUG (lowest)
*** INFO
*** WARN (middle)
*** ERROR
*** FATAL (highest)
** The Conversion Pattern, it currently uses a standard one but you may wish to configure it.
*** %p --The priority of the logging event(debug, warn)
*** %t --The name of the thread generating the event
*** %c --The category of the logging event
*** %m --message
*** %n --newline character
*** %d --date of the logging event
*** %l --Outputs the source code location information

For other information you can look at the following websites:
This is the official Log4j Project home page that contains helpful information.

[http://logging.apache.org/log4j/docs/index.html Log4j Project - Introduction]

This is a helpful walk through that is very thorough and helpful.

[http://www.vipan.com/htmdocs/log4jhelp.html Don't Use System.out.println!]

Emeeting module

2006-08-04T14:26:29Z

Nitle06:

The eMeeting module is a simple interface between Marratech video conferencing suite and Moodle. It allows meetings to be created on Moodle as course activities. It uses special servlets attached to the Marratech API to seamlessly create correspoding rooms on Marratech.

[[eMeeting module installation]]

[[eMeeting module Log4j]]

[[Category:Modules (non-standard)]]
[[Category:Administrator]]
[[Category:Teacher]]

mod/emeeting/view

2006-08-04T14:14:44Z

Nitle06: /* Deleting an eMeeting */

== eMeeting Details Page ==

This page is meant to display details about the eMeeting and provide a way to enter the meeting through Moodle. It will include the name of the meeting, the time it starts according to the users timezone, the duration of the meeting, the meeting profile, a link to "Check Status / Join Meeting", a link for teachers and Admins that appears once the meeting is over showing the meeting participation logs, and shows entered meeting description. It also contains a link to download the Marratech client. Depending on whether or not your Marratech Administrator has Java Web Start turned on you may need to download the client.

==Meeting Status Page ==
This page will display information about a meeting the is received from the meeting.
It will display the status of the eMeeting, they are-
* The eMeeting is ready to be activated
** This is only shown to teachers or administrators
** This will also display a link to Activate meeting which will create the room on Marratech.
* The eMeeting is Active
** This will be seen by all users
** It will display a button to enter the meeting
*** To enter the meeting it will download a file, connect.sdx. This will launch the Marratech client with you logged into the eMeeting
** If you are an admin and not a member of the course you will have access to the meeting but you will receive a warning message.
*** It is "Warning, You are not a current course member and are not counted for the meeting participant number but will count against the Marratech License if you enter the room."
* The eMeeting is currently inactive
** This will display when the meeting is outside its time slot
** If you are a student you will see this message whenever the meeting is not active

Next it will display the meeting information, including its name, the time of the meeting, the duration, and its description.

It also contains a link to Marratech so that you may download the client.

== Updating an eMeeting ==

There are two ways to update an eMeeting. You can go to your main course page, click "Turn editing on", and then click the button that looks like a hand. Alternatively, you can click on the eMeeting itself and then click on the "Update this eMeeting" button on the right hand side of the bar at the top of the page. This button will appear on both the eMeeting details page and the Meeting Status page.

The update interface is effectively identical to the interface for creating a new eMeeting; however, the details from your current meeting will already be filled in for you. Updating still goes through the availability check, so if you change the time, you may run into licensing conflicts (see the help on creating a meeting for more details). You cannot update a meeting that is already in progress.

If you wish to update an eMeeting that has guests invited to it, you will notice that when you go to the 2nd update page a table shows the guest user with a check box next to his or her name. If you were to uncheck this box this would cause the guest to be uninvited. This means that they will not have access to the eMeeting and they will receive a friendly email telling them that the eMeeting has been cancelled.

== Deleting an eMeeting ==

There are two ways to delete an eMeeting. First, you can go to the main course page, and click "Turn editing on". Then, click the X-shaped icon next to the eMeeting you wish to delete. You will be prompted with a message asking if you are sure you wish to delete the eMeeting; if you are, click "Yes." Otherwise, you can click "No," and the meeting will not be deleted.

In addition, you can also delete an eMeeting by going to the eMeeting Details page and clicking the "Delete eMeeting" button on the right side of the page, below the "Update this eMeeting" button. This works in the same way as clicking on the X on the main page. When you delete a meeting it will also delete it on Marratech if it is in progress.

[[Category:Teacher]],[[Category:Administrator]]

mod/emeeting/view

2006-08-04T14:13:35Z

Nitle06:

mod/emeeting/view

2006-08-04T14:11:50Z

Nitle06: /* Meeting Status Page */

mod/emeeting/view

2006-08-04T14:09:28Z

Nitle06: /* eMeeting Details Page */

== eMeeting Details Page ==

This page is meant to display details about the eMeeting and provide a way to enter the meeting through Moodle. It will include the name of the meeting, the time it starts according to the users timezone, the duration of the meeting, the meeting profile, a link to "Check Status / Join Meeting", a link for teachers and Admins that appears once the meeting is over showing the meeting participation logs, and shows entered meeting description. It also contains a link to download the Marratech client. Depending on whether or not your Marratech Administrator has Java Web Start turned on you may need to download the client.

==Meeting Status Page ==
This page will display information about a meeting the is received from the meeting.
It will display the status of the eMeeting, they are-
* The eMeeting is ready to be activated
** This is only shown to teachers
** This will also display a link to Activate meeting which will create the room on Marratech.
* The eMeeting is Active
** This will be seen by all users
** It will display a button to enter the meeting
*** To enter the meeting it will download a file, connect.sdx. This will launch the Marratech client with you logged into the eMeeting
** If you are an admin and not a member of the course you will have access to the meeting but you will receive a warning message.
*** It is "Warning, You are not a current course member and are not counted for the meeting participant number but will count against the Marratech License if you enter the room."
* The eMeeting is currently inactive
** This will display when the meeting is outside its time slot
** If you are a student you will see this message whenever the meeting is not active

Next it will display the meeting information, including its name, the time of the meeting, the duration, and its description.

It also contains a link to Marratech so that you may download the client.

== Updating an eMeeting ==

There are two ways to update an eMeeting. You can go to your main course page, click "Turn editing on", and then click the button that looks like a hand. Alternatively, you can click on the eMeeting itself and then click on the "Update this eMeeting" button on the right hand side of the bar at the top of the page. This button will appear on both the eMeeting details page and the Meeting Status page.

The update interface is effectively identical to the interface for creating a new eMeeting; however, the details from your current meeting will already be filled in for you. Updating still goes through the availability check, so if you change the time, you may run into licensing conflicts (see the help on creating a meeting for more details). You cannot update a meeting that is already in progress.

If you wish to update an eMeeting that has guests invited to it, you will notice that when you go to the 2nd update page a table shows the guest user with a check box next to his or her name. If you were to uncheck this box this would cause the guest to be uninvited. This means that they will not have access to the eMeeting and they will receive a friendly email telling them that the eMeeting has been cancelled.

== Deleting an eMeeting ==

There are two ways to delete an eMeeting. First, you can go to the main course page, and click "Turn editing on". Then, click the X-shaped icon next to the eMeeting you wish to delete. You will be prompted with a message asking if you are sure you wish to delete the eMeeting; if you are, click "Yes." Otherwise, you can click "No," and the meeting will not be deleted.

In addition, you can also delete an eMeeting by going to the eMeeting Details page and clicking the "Delete eMeeting" button on the right side of the page, below the "Update this eMeeting" button. This works in the same way as clicking on the X on the main page.

mod/emeeting/mod

2006-08-04T13:48:44Z

Nitle06: /* Adding a new eMeeting */

== Creating an eMeeting ==
This is the description of creating a eMeeting activity to be used for the course. Teachers and administrators will be able to use this to schedule time within the Marratech server for a meeting. If you do not have the Marratech client installed on your computer you should do so before working in a meeting.
http://www.marratech.com/

===Adding a new eMeeting===
In this page, you will set the most basic details about the meeting: date and time, duration, whether you want all members of the course to participate, the number of guests you wish to invite, the group settings for the meeting, and whether the eMeeting will be visible to students.
*Date and time for the meeting are fairly self-explanatory, but the time you select cannot be in the past. If it is an error message will be displayed.
*Duration is in hours, followed by minutes.
*Seats refers to the number of students who will be attending the meeting. There are three options: All Members, Choose Members, and Auditoriums.
**All Members indicates that you want everyone in your course to participate; if there is a conflict with the number of licenses for the time you have selected, you won't be able to reach the second page. (Go to the validation explanation for a more in-depth explanation of this)
**Choose Members, on the other hand, indicates that you are willing to hold the meeting with only some of your students. If there is a conflict at your chosen time, but there won't be too many people scheduled, you will be able to select a portion of your students to attend the meeting on the next page.
**Auditorium: you can only pick auditoriums if your administrator has available profiles for auditoriums and your Marratech Licenses contains auditoriums. You will only have access to auditorium profiles when you select your profile and validation checks against the other auditorium rooms.
*Number of Guests indicates the number of guest users that you wish to allow into the eMeeting. This value will count toward your total number of users for validation purposes.
*Group mode allows for using Moodle groups; check the help documents on this topic for more information. ('''TO DO: add link to said help''')
*Visible to students allows you to make the eMeeting hidden when it is created. If you choose "Hide" in the drop-down menu, students will not be able to view the eMeeting once it is created, though you can later change it to be visible. If you choose "Show", however, students will be able to see the eMeeting.

Once you have set all these options to the values that you want, click "Check Availability" to proceed to the next step. This will validate your eMeeting and take you to the [[mod/emeeting/validate|Further Details page]].

== Updating an eMeeting ==

There are two ways to update an eMeeting. You can go to your main course page, click "Turn editing on", and then click the button that looks like a hand. Alternatively, you can click on the eMeeting itself and then click on the "Update this eMeeting" button on the right hand side of the bar at the top of the page. This button will appear on both the eMeeting details page and the Meeting Status page.

The update interface is effectively identical to the interface for creating a new eMeeting; however, the details from your current meeting will already be filled in for you. Updating still goes through the availability check, so if you change the time, you may run into licensing conflicts (see the help on creating a meeting for more details). You cannot update a meeting that is already in progress.

The one major difference is that guests functionality in the update option for a meeting has changed from the create eMeeting option. Right now, you cannot change the number of guests in a meeting manually. Nor can you add new guests, however, if there is a guest you no longer wish to invite you can remove them from the meeting and they will recieve an email saying that the eMeeting is cancelled. They will not be able to log into the meeting as well.