This creates a log for you to use.
Example:
/as log ConferenceRoom add
This is the first step to setting up logging for a room.
This command forces ConferenceRoom to build the web page for the log. It is normally called automatically, but you can use it to force the web page to be built before logging has started or to make changes.
Example:
/as log open buildwebpage
This can be useful if you want to customize the web page or change the template. Normally you should not need to use this command.
This command sets a specific room to be logged. The example below would log #conferenceroom to the log called ConferenceRoom.
Example:
/as log ConferenceRoom channel #conferenceroom
Once a log has been added and had its channel set then it can be enabled. But you should also set the logfile and webpage for your logs.
This deletes a log that you no longer have a use for.
Example:
/as log ConferenceRoom del
If you merely want to stop logging, you should use disable. Del removes the entry entirely so that you will have to reconfigure all of your settings if you change your mind.
This command stops the logging of a room. The entry remains present, but it is inactive until you enable it again.
Example:
/as log ConferenceRoom disable
This allows you to leave the entry inactive but ready for whenever you want to use it again.
This command activates the log entry. It will begin logging according to the way it was set.
Example:
/as log ConferenceRoom enable
This command will only work after the log entry has been configured. You must add the log and set a room for it to log. Most of the settings have defaults they will use if you do not specify.
This command will show you the settings for a particular log.
Example:
/as log ConferenceRoom list
This is very useful for checking how your logging has been configured.
DIRECTORY - Save rotating log files into a directory
FILE - Save the log to the specified file name.
Set the file that the log will log to. It will normally place the file within your WEBMASTER\logs directory.
Example:
/as log ConferenceRoom logfile confroom.html
You will probably want to end the file name with either .htm or .html so that you can easily view the file from the web.
This command allows you to change the name of a log. All of the settings remain intact.
Example:
/as log ConferenceRoom rename cr
Since the log name is only relevant for sending ConferenceRoom commands, you may decide that a log you set up with a practical name is too unwieldy. You might want to shorten it or choose something simpler to type. This command allows you to move all of your configurations to a new log name so that you do not need to remake a new log and delete the old one.
These 'LOG SET' commands define the title, description and the theme to use for the look and style of the log file.
DESCRIPTION - Set a description for the log.
THEME - Set the theme for the log output.
TITLE - Set the title for the log.
Examples:
/as help log set <topic>
These settings are all for output and customization of logs.
END - End time for the specified log.
INTERVAL - Time Interval for the specified log.
START - Start time for the specified log.
This works the same as the TIME command for events. You can set a start and end time for running scripts or you can specify an interval such as daily, weekly, monthly, or once.
Examples:
/as help log time <topic>
If you have regular hours when you wish to log, you can set up your logging in advance to automatically turn on and off for you. This is particularly useful for recurring events.
See EVENT SET TIME.
Webpage sets the URL where you can access the log. The path needs to be set from the same location as where your ConferenceRoom Java Client resides. This command doesn't take a full URL; it only takes path names and should always end in .htm or .html.
Example:
/as log ConferenceRoom webpage mylogs/conferenceroom.htm
You should probably make the webpage name the same as the log name plus either .htm or .html. This will make your logs easy to find and keep track of. You might want to consider putting your logs in a secure directory.