Latest revision as of 20:46, 18 February 2024

What Are Rental Profiles?

Rental profiles allow you to specify which group of units will be shown via a particular rental kiosk.

A rental profile is basically a stored search, which is intelligently cached by our servers to ensure that everything loads as quickly as possible.

The default behavior is for the rental kiosks and vendors to show all of your rentals, across all sims/regions.

If you want to sort specific units to specific kiosks/vendors, then you will need to use rental profiles.

Rental profiles (and their associated rule filters) allow you to add filter rules to specify which units you want to display via a particular kiosk or vendor.

Each Rental Profile Is Tied to an Active Kiosk or Rental Vendor

You must keep at least 1 kiosk/rental vendor with a particular rental profile rezzed out somewhere. You don't need multiple kiosks with it, especially if you have your own scripted wizardry for rental signage. But you do need to have ONE per profile, rezzed out somewhere, like in a backup or storage location. You can see the DropBox storage hosting page if you need a spare place to do that.

Overview of Profile Rule Filters

A rental kiosk may use a rental profile instead of the default setting.

A rental kiosk is only able to display ONE profile - but the profile may include any number of rule filters, which the system will interpret to filter the display of your rental units in a specific manner. (Much the same way as you'd use email filters to sort specific emails to specific folders in your email client.)

When a new rental unit is added, deleted, or a rental state change occurs, the system first tests each of your profiles against that single unit key to see if the unit is "included" in the profile.

If a match is found, then the full profile is regenerated, and cached.

This means that a query is not performed every time someone browses a vendor or loads the units on the website, but instead only when the data changes. This keeps everything running quickly despite the complex queries involved.

What Is In a Rental Profile?

A complete profile may hold one, or multiple rule filters. At the present time there are no limits on the number of rule filters that may be added to a profile.

The components of a complete rental profile are:

Profile name (this is shown on the CasperPanel website)
Avatar name (the owner of the rental kiosk)
The rule filter(s).

The rule filter components are:

Pulldown box to select Include or Exclude
Pulldown box to select "Where" clause (owner name, owner uuid, unit name, unit uuid, unit group, region name)
Note: This is a search TYPE, not a location reference.
Pulldown box to select "Condition" clause (equals, contains, doesn't equal, doesn't contain)
Search query (keywords you type in)

Don't forget to click "Save" when you're done setting up a rule filter!

Avatar Account Name

This is the Second Life account name (NOT the display name) of owner of the rental kiosk. The profiles created under this avatar name can only be attached to kiosk(s) owned by the same avatar. This is so the system knows who the payments are initially going to when the kiosk is paid.

Rule Filter Options

"Include" or "Exclude"

You have a pulldown to select either "include" or "exclude. "Include" rules are run first, to include the maximum number of rental units that match. "Exclude" rules are run after, so any of the previously included units matching the exclude rules will be removed from the end results.

"Where" clause

This is the type of search the rule is doing. You have a pulldown to select search by "unit name", "unit UUID", "unit group", or "region name".

Using Unit Groups

When "unit group" is selected, the "conditions" input box changes to present you with a dropdown to select a group that has already been created in the owner avatar's CasperLet account. The owner avatar should the unit groups for details on how to set these up, if they are not set up already.

"Condition" clause

This allows you to match your search query as "Equals (equal to)", "contains", "doesn't equal", or "doesn't contain".

If the selected "where" clause is "unit group", then the "condition" will always be set to "equals", and the input search box turns into a dropdown box showing the groups you've already defined.

Search Term

This is where you can actually type in the search term you want to use, such as the sim/region name if you're setting up profiles to be sim/region-specific.

Don't forget to click "Save" when you're done setting up a rule filter!

Editing Existing Rental Profiles

To edit existing rule filters, you will need to:

Select the profile name from the dropdown
click the "Edit" button
You will get a popup with the selected rental profile information

The things you may do on this popup window are:

Edit the profile NAME
Delete existing rule filters
Add new rule filters

And of course, don't forget to SAVE your changes!

Testing

When you click save, the system will perform a test query and show you how many units were found, as well as how long the search took to complete based on your rule filters.

Currently there is no limit on the time this test query will take, however, time limits MAY be enforced in the future to maintain system performance at an acceptable level for everyone.

Examples

If I want to include units owned by "Casper Warden", but not those which include "demo" in the name, the profile needs to contain the following:

Select "Avatar" name of Casper Warden
Rule #: Exclude units where Unit Name contains "Demo"

FAQ/Troubleshooting

Q. I have made Include Rule and 0 results show, I tried to add a 2nd Exclude Unit Group does not equal that same Unit Group, the equal/does not equal box is greyed out and sets to equal as the only option.

A. If the first include rule has 0 results, first check and be sure you saved it. Then, see if the unit(s) you are trying to include are already in another group - each unit can only be in one unit group.

@@ Line 1: / Line 1: @@
-'''NOTE''' This page relates to upcoming features and should not be used yet.
-Rental Profiles are a nifty way of "selecting" units for display in our rental vendors and web kiosks. They're basically stored searches, which are intelligently cached by our servers to ensure that everything runs as quickly as possible.
+{|align=right
+  |__TOC__
+  |}
+= '''<span style="color:#00528c">What Are Rental Profiles?</span>''' =
+Rental profiles allow you to specify which group of units will be shown via a particular rental kiosk.
-== What do they do? ==
+A rental profile is basically a stored search, which is intelligently cached by our servers to ensure that everything loads as quickly as possible.
-By default, our rental vendors and kiosks will display '''all''' of your rentals. Rental profiles allow you to add rules to specify which units you want to display.
+The '''default''' behavior is for the rental kiosks and vendors to show '''all''' of your rentals, across all sims/regions.
-== How do rules work? ==
+If you want to sort specific units to specific kiosks/vendors, then you will need to use rental profiles.
+Rental profiles (and their associated rule filters) allow you to add filter rules to specify which units you want to display via a particular kiosk or vendor.
+== Each Rental Profile Is Tied to an Active Kiosk or Rental Vendor ==
+You must keep at least 1 kiosk/rental vendor with a particular rental profile rezzed out somewhere. You don't need multiple kiosks with it, especially if you have your own scripted wizardry for rental signage. But you do need to have ONE per profile, rezzed out somewhere, like in a backup or storage location. You can see the [[DropBox_Hosting | DropBox storage hosting page]] if you need a spare place to do that.
+== Overview of Profile Rule Filters ==
 [[File:Addrentalprofile.jpg|400px]]
-You add any number of '''rules''' which the system interprets to filter your rental units.
+A rental kiosk may use a rental profile instead of the default setting.
+A rental kiosk is only able to display ONE profile - but the profile may include any number of rule filters, which the system will interpret to filter the display of your rental units in a specific manner. (Much the same way as you'd use email filters to sort specific emails to specific folders in your email client.)
+When a new rental unit is added, deleted, or a rental state change occurs, the system first tests each of your profiles against that single unit key to see if the unit is "included" in the profile.
+If a match is found, then the full profile is regenerated, and cached.
+This means that a query is not performed every time someone browses a vendor or loads the units on the website, but instead '''only when the data changes'''. This keeps everything running quickly despite the complex queries involved.
+='''<span style="color:#00528c">What Is In a Rental Profile?</span>''' =
-The first option is '''include''' or '''exclude'''.  '''Include''' rules are ran first, and units matching ANY of the "Include" rules are included in the profile. '''Exclude''' rules are ran last, and any of the previously included units which match these rules are thrown out.
+A complete profile may hold one, or multiple rule filters. At the present time there are no limits on the number of rule filters that may be added to a profile.
-The next option is the '''where''' clause, which is the type of search the rule is doing - you can search by Owner Name, Owner UUID, Unit Name, Unit UUID, Unit Group, or Region Name.
+The components of a complete rental profile are:
-After that, comes the '''condition''' clause - which allows you to match as "equals", "contains", "doesn't equal" or "doesn't contain".
+:# Profile name (this is shown on the CasperPanel website)
+:# Avatar name (the owner of the rental kiosk)
+:# The rule filter(s).
-Finally, there's the term - which is the search query. You can enter some text.
+The rule filter components are:
-== Example ==
+:# Pulldown box to select Include or Exclude
+:# Pulldown box to select "Where" clause (owner name, owner uuid, unit name, unit uuid, unit group, region name)<br />'''''Note:''' This is a search TYPE, not a location reference.''
+:# Pulldown box to select "Condition" clause (equals, contains, doesn't equal, doesn't contain)
+:# Search query (keywords you type in)
-If I want to include units owned by "Casper Warden", but not those which include "demo" in the name, I would add two rules:
+'''Don't forget to click "Save" when you're done setting up a rule filter!'''
-Rule #0: Include units where Owner Name equals "Casper Warden"
+== Avatar Account Name ==
-Rule #1: Exclude units where Unit Name contains "Demo"
+This is the Second Life account name (NOT the display name) of owner of the rental kiosk. The profiles created under this avatar name can only be attached to kiosk(s) owned by the same avatar. This is so the system knows who the payments are initially going to when the kiosk is paid.
-== Testing ==
+== Rule Filter Options ==
+==="Include" or "Exclude"===
+----
+You have a pulldown to select either "include" or "exclude. "Include" rules are run first, to include the maximum number of rental units that match. "Exclude" rules are run after, so any of the previously included units matching the exclude rules will be removed from the end results.
-After you have added the rules, the system will perform a "test query" and will show you how many units were found, as well as how long the query took. Currently there is no limit on query time, however a limit may be enforced in the future.
+==="Where" clause===
+----
+This is the type of search the rule is doing. You have a pulldown to select search by "unit name", "unit UUID", "unit group", or "region name". <br />
-== Technical stuff ==
+====Using Unit Groups ====
+----
+When "unit group" is selected, the "conditions" input box changes to present you with a dropdown to select a group that has already been created in the owner avatar's CasperLet account. The owner avatar should the '''[[CasperLet/Unit_Groups | unit groups]]''' for details on how to set these up, if they are not set up already.
-When a new rental unit is added, deleted, or a rental state change occurs, the system first tests each of your profiles against that single unit key to see if the unit is "included" in the profile.
+==="Condition" clause===
+----
+This allows you to match your search query as "Equals (equal to)", "contains", "doesn't equal", or "doesn't contain".
+If the selected "where" clause is "unit group", then the "condition" will '''always''' be set to "equals", and the input search box turns into a dropdown box showing the groups you've already defined.
+===Search Term===
+----
+This is where you can actually type in the search term you want to use, such as the sim/region name if you're setting up profiles to be sim/region-specific.
+'''Don't forget to click "Save" when you're done setting up a rule filter!'''
+== Editing Existing Rental Profiles ==
+To edit existing rule filters, you will need to:
+:# Select the profile name from the dropdown
+:# click the "Edit" button
+:# You will get a popup with the selected rental profile information
+The things you may do on this popup window are:
+:* Edit the profile NAME
+:* Delete existing rule filters
+:* Add new rule filters
+And of course, don't forget to '''SAVE''' your changes!
+=== Testing ===
+----
+When you click save, the system will perform a test query and show you how many units were found, as well as how long the search took to complete based on your rule filters.
+Currently there is no limit on the time this test query will take, however, time limits '''MAY''' be enforced in the future to maintain system performance at an acceptable level for everyone.
+='''<span style="color:#00528c">Examples</span>''' =
+If I want to include units owned by "Casper Warden", but not those which include "demo" in the name, the profile needs to contain the following:
+:* Select "Avatar" name of Casper Warden
+:* Rule #: Exclude units where Unit Name contains "Demo"
-If a match is found, then the full profile is regenerated, and cached.
+='''<span style="color:#00528c">FAQ/Troubleshooting</span>''' =
+:'''Q.  I have made Include Rule and 0 results show, I tried to add a 2nd Exclude Unit Group does not equal that same Unit Group, the equal/does not equal box is greyed out and sets to equal as the only option.'''
-This means that a query is not performed every time someone browses a vendor or loads the units on the website, but instead only when the data is stale. This keeps everything running quickly despite the complex queries involved.
+:: '''A.''' If the first include rule has 0 results, first check and be sure you saved it. Then, see if the unit(s) you are trying to include are already in another group - each unit can only be in one unit group.

WebKiosk/Rental Profiles: Difference between revisions