View source for RolePay Time Clock Expansion

[[Rolepay Money System/Expansions|← Rolepay Money System Expansion Packs]]
{|align=right
|__TOC__
|}

= '''<span style="color:#4D5A93">Using Expansion Packs</span>''' =
<p>In order to use any expansion pack, you must have an API key only obtained from the Web Interface from the RolePay Server.<br />You can also obtain an API key from the network owner or someone who has access to the Web Interface.</p><br />

= '''<span style="color:#4D5A93">Making Expansion Packs</span>''' =
<p>Want to learn how to make expansion packs? All expansion packs are made using the [[Rolepay Money System/API|RolePay Money System API]].<br />All you will need is basic knowledge of HTTP and LSL.</p><br />

= '''<span style="color:#4D5A93">Setting Up The Time Clock Expansion</span>''' =
<p>These steps assume that you already have an API key.<br />Follow these steps to configure your device:</p>
#Locate the Time Clock in your inventory and rez into place
#Left-click the Time Clock to receive the dialog menu &amp; select "Setup"
#A URL dialog will be presented, offering you a link to the online device registration page
#Once on the registration page, input a RolePay API key and select "Validate"
#If successfully validated, you can then select the funding source which will be the funding used to complete payouts.<br />You can either input a credit card number belonging to the RolePay network that you're connecting to <b>or</b> use network funds (please ensure you have permission from the network owner)
#Once funding has been validated, you will be directed to the Time Clock dashboard and your Time Clock is ready for use!
<br/>

== '''User Registration &amp; User Options''' ==
<p>To add users to the Time Clock, you will need to visit the Time Clock's online dashboard. To do this, left-click the Time Clock &amp; select "Dashboard" from the menu.<br />Once you've accessed the dashboard, navigate to the "Users" tab. On the left, enter the Second Life username and the hourly wage for the user you'd like to register and select "Add User". The users name will then appear to the right of the registration box if the user was successfully registered.<br /><br />Selecting a registered user from the Registered Users list will display the users unpaid/paid earnings and allow you to edit the following settings:</p>
*<b>Rate/HR</b>: Set the $ amount that the user will earn <b>per hour</b> clocked in
*<b>Auto Clockout</b>: Check the box if you wish to enable the Auto Clockout feature; this feature will monitor the status of clocked in users &amp; will automatically clock out those that go offline.
** <b><u>Please Note:</u></b> This feature requires additional configuration to the Time Clock in-world. More instructions will become available on the interface once you've enabled Auto Clockout for one or more users
*<b>Work Days:</b> Allows you to check the boxes of the week days the user is permitted to work. <b>Note:</b> The system conducts <b>midnight</b> checks; if the user is not permitted to work the new day, they'll be clocked out automatically
<br />

= '''<span style="color:#4D5A93">Clocking Out Users</span>''' =
<p>On the "Home" dashboard page, any users that are currently clocked in will be listed there. You will be able to see when each person started with the option to clock out the user. When a user is clocked out, the system will calculate their total earnings and add it to the users <u>unpaid earnings</u>. <b>Note:</b> Regardless if the user has been clocked out manually or automatically by the system (ex. Auto clockout) - The users clocked time will always be added to their unpaid earnings which then allows those unpaid earnings to be paid out.</p><br />

= '''<span style="color:#4D5A93">Payouts &amp; Records</span>''' =
<p>There are two payout options available:</p>
#<b>Manual Payouts by Owner:</b> If you would like to manually payout time for each user, you can do so by visitng the "Users" page on the Time Clock dashboard. Simply select the user, followed by "Payout". If the Payout option is not clickable, the user has no unpaid earnings to payout.
#<b>Manual Payouts by User:</b> To allow users the ability to request payouts themsevles, navigate to the "Settings" page on the Time Clock dashboard &amp; enable "Allow Manual Payout"; users will then be able to request payouts for their unpaid earnings via the Time Clock menu.
<p>Each time a payout has been completed, a new record will be made on the "Payouts" page. Each record consists of the following details: Date &amp; Time, Payee, Funding Source, and the Amount paid.</p><br />

= '''<span style="color:#4D5A93">Updating Time Clock Configuration</span>''' =
<p>Navigate to the "Settings" page on the online Time Clock dashboard. There you are able to change the RolePay API key &amp; funding source details.</p><br />

= '''<span style="color:#4D5A93">API Documentation</span>''' =
<p>In order to use the Time Clock API, you must first get an API key from the <b>Time Clock Dashboard</b>, "API Keys" page.</p><br />

== '''API Features''' ==
*Check Key (Checks to make sure an API key is valid and exists)
*Register User (Registers user into the Time Clock network)
*Clock-in User (Clocks in specified user into the Time Clock network)
*Clock-out User (Clocks out specified user from the Time Clock network)
<br />

== '''<span style="color:#4D5A93">Check API Key</span>''' ==
<p>This function will check to see if the specified API Key exists and is valid.</p>

=== Information required for API call ===
* action (check_key)
* api_key

=== HTTP API Call ===
<pre>http://rolepay.timeclock.morethanpixels.rocks/api/action/check_key/api_key/{API_KEY} GET</pre>

=== Example Response ===
<pre>
{
    "success": "api_key found"
}
</pre>


== '''<span style="color:#4D5A93">Register User</span>''' ==
<p>This function will register the specified user to the Time Clock network.</p>

=== Information required for API call ===
* action (register_user)
* api_key
* user_uuid (The user to register)
* wage (The users hourly wage)

=== HTTP API Call ===
<pre>http://rolepay.timeclock.morethanpixels.rocks/api/action/register_user/api_key/{API_KEY}/user_uuid/{USER_UUID}/wage/{USER_WAGE} GET</pre>

=== Example Response ===
<pre>
{
    "success": "User has successfully been registered!"
}
</pre>


== '''<span style="color:#4D5A93">Clock-In User</span>''' ==
<p>This function will clock-in the specified user.</p>

=== Information required for API call ===
* action (clock-in_user)
* api_key
* user_uuid (The user to clock-in)

=== HTTP API Call ===
<pre>http://rolepay.timeclock.morethanpixels.rocks/api/action/clock-in_user/api_key/{API_KEY}/user_uuid/{USER_UUID} GET</pre>

=== Example Response ===
<pre>
{
    "success": "User has successfully been clocked in."
}
</pre>


== '''<span style="color:#4D5A93">Clock-Out User</span>''' ==
<p>This function will clock-out the specified user.</p>

=== Information required for API call ===
* action (clock-out_user)
* api_key
* user_uuid (The user to clock-out)

=== HTTP API Call ===
<pre>http://rolepay.timeclock.morethanpixels.rocks/api/action/clock-out_user/api_key/{API_KEY}/user_uuid/{USER_UUID} GET</pre>

=== Example Response ===
<pre>
{
    "success": "User has successfully been clocked out."
}
</pre>