Apez
Plugins
Prerequisites
Did you already check General Aspects before going on ?
Did you already try to rez a OnTouch before going on ?
Introduction
Apez is a well-known mark under SL. Their goal is to
provide a wide range of services. Among them, two are
interesting for, and would benefit from an integration
with Group.Invitor service:
- Apez.iVend: the networked vendors. The goal of
integration is to invite people who purchased a
product
- Apez.AutoLease: the networked renting system. The
goal of integration is to invite people who rented a
shop, and to eject them once their renting is over.
- This can
be really handled with Group.Invitor.Fixed
service only. First to get ejections, but also to
handle closed groups, as the ones used for shops are
very often closed access.
Apez.iVend
Introduction
Technically, there are several ways to integrate with Apez.iVend.
MyRoBoT chose the one being the easiest when people
already have a big quantity of vendors or servers:
Apez.iVend plugin takes benefit from Apez notification
system: ANS
(Automatic Notification System).
With one single prim, you can decide what to do for
all the items you sell through Apez all over SL world !
Quick Start
If you want to quickly put to work an
integration with Apez.iVend, follow this basic QuickStart procedure:
- Rez a new prim. This new prim will
be the place where treatments for
invitations are done
- Copy the following files from plugin to your new
prim:
- Group.Invitor.ANS.Apez 1.5
- Group.Invitor.Config 1.5
- SimpleServiceBot-GroupInvitor 1.5
- Choose one of the StringsAndLoader.XX,
where XX is your chosen language: fr for
french, de for german, en for english, es for
spanish
- You will see the scripts
giving you an UUID key. Note it down, it
is important. Touch the prim to get the
key again if you missed it
- Go on the Apez web site, in the
preferences
(You might have to login and click this
link again)
- Activate the ANS
- Choose email,
then put the UUID key like this:
UUID@lsl.secondlife.com
- If you wish, enter your secret ANS security code
string. Choose whatever you want, but keep it
confidential
- Update the settings
- Go back in world, and open the
notecard you put in the new prim, named
Group.Invitor.Config 1.5
- The first line beginning with LANG= is the
language. Put the one corresponding to the chosen
StringsAndLoader.XX. For instance, if you
choose english, you should put:
LANG=en
- Next to the string CHECK=, put your ANS
security code if you chose one (leave it empty if
you didn't). for instance, if your
security code was 1234, your notecard
line should be:
CHECK=1234
- Replace the last line of notecard
with your group. For instance, if your
group is MyRoBoT, your line should be:
FILTER=ELSE-->MyRoBoT
- Save the notecard. You will see the machine trying to check it.
- If check was successful, you're done ! Machine
will invite to the group you set on each sale
(provided there isn't any spam condition or
filtering) !
User Manual
Follow the above quick start procedure. Then you can
finetune your settings by working on all the available
options.
General rules for the notecard are:
- The notecard is based on a collection of key=value
pairs, one pair per line.
- Empty lines or text beginning with // are
considered as comment and not taken into account.
- There can be maximum 20 lines (including comments)
Available keys for Apez.iVend are:
- LANG: currently settable values are fr, en, de,
and es, for french, english, german and spanish. You
MUST have the corresponding StringsAndLoader.XX
in the object content. Otherwise, the loading will
fail. Default value is en
- AGEFILTER: accepted value is a quantity of months,
with a < or > sign before. For instance, >12 means to
NOT invite avatars being older than 12 months. You can
use also <, to NOT invite avatars being younger than a
given age. Default value is >36
- CHECK: value is the one you set in the Apez ANS.
If you didn't set any security code by Apez, you can
remove this line, or leave it empty. Default value is
empty
- VERBOSE: accepted values are YES and NO. If YES,
the scripts will say some comments on each invitation.
Default value is YES
- Can also accept value EXTRA, meaning that it is
extra-verbose, displaying received notification from
service
- ANTISPAM: accepted value is an integer, from 86400
to 2592000. It is a quantity of seconds, and it means
you can set an antispam duration from 1 day to 30
days. Default value is 30 days.
- FILTER: there must be at least one line starting
with FILTER, and there can be several. They will be
considered one after the other, in the order they were
declared. Each one is formatted the same way:
FILTER=ServiceKey-->ServiceValue-->Group name|||Role
- where ServiceKey is a key that is sent by Apez services,
through the ANS service.
- where ServiceValue is the value to check
-
where the |||Role is optional, and works only for Group.Invitor.Fixed
service
ServiceKeys sent by Apez system,
through the ANS service can be:
- Grid:
always SL:Production
- Timestamp: unix timestamp
- Timestamp8601: time formatted this way:
yyyy-MM-ddTHH:mm:ssZ
- Type: always Purchase
- Currency: LLD or USD
- SaleID: digit
- TransactionID: digit
- ProductID: digit
- ItemID: digit
- ProductName: name of sold product
- ItemName: name of sold product
- InventoryName: name of object name that was
delivered for sale
- CollectionName: collection name the sold
product belongs to
- PaymentGross: overall amount for payment,
including all commissions
- PaymentShared: amount that was given for
share payments
- PaymentCommission: amount that was given for
commissions
- PaymentFee: amount that was given for
commissions
- BuyerKey: UUID of payer avatar
- PayerKey: UUID of payer avatar
- BuyerName: name of payer avatar
- PayerName: name of payer avatar
- SellerKey: UUID of seller avatar
- SellerName: name of seller avatar
- MerchantKey: UUID of merchant
- MerchantName: name of merchant
- ReceiverKey: UUID of receiver avatar
- ReceiverName: name of receiver avatar
- Region: region name where the purchase
occurred. For instance 'XStream80'
- Location: location of vendor for purchase,
in x,y,z format, for instance: 100, 230, 20
The scripts will compare the value put inside
your notecard with the one given through ANS. This
gives you an extreme flexibility !
Here are Some examples of FILTER lines:
FILTER=Region-->XStream80-->MyRoBoT //
This will invite all avatars purchasing on sim
XStream80 to MyRoBoT group FILTER=CollectionName-->My collec-->Group|||Role //
This will invite all avatars purchasing a product part
of My collec collection to the group Group, with role
Role FILTER=ProductName-->Poofer1-->Miss Gadgets
items addicts ! // This will invite all avatars
purchasing the product Poofer1 to group Miss Gadgets
items addicts ! You can also put a special default line, that will be the one used if no other line is in a match condition. For instance:
FILTER=ELSE-->MyRoBoT //
This will invite all avatars to MyRoBoT group, when there was no match with other conditions
Apez.AutoLease
Introduction
There is unfortunately no way to gather all requests for AutoLease from one single point.
You will need to add scripts to each of your Apez.AutoLease
units in-world.
Quick Start
If you want to quickly put to work an
integration with an Apez.AutoLease unit, follow this basic QuickStart procedure:
- Copy the following files from plugin to your
Apez.AutoLease unit:
- Group.Invitor.Apez.AutoLease 1.5
- Group.Invitor.Config 1.5
- SimpleServiceBot-GroupInvitor 1.5
- Choose one of the StringsAndLoader.Rent.XX,
where XX is your chosen language: fr for
french, de for german, en for english, es for
spanish
- Open the notecard you just put in the new prim, named
Group.Invitor.Config 1.5
- The first line beginning with LANG= is the
language. Put the one corresponding to the chosen
StringsAndLoader.Rent.XX. For instance, if you
choose english, you should put:
LANG=en
- Locate the line beginning with GROUP=. Replace
the text after the = with your exact group name. For instance, if your
group is MyRoBoT, your line should be:
GROUP=MyRoBoT
- Save the notecard. You will see the machine trying to check it.
- If check was successful, you're done ! People
will be invited once they paid for a new renting !
User Manual
Follow the above quick start procedure. Then you can
finetune your settings by working on all the available
options.
General rules for the notecard are:
- The notecard is based on a collection of key=value
pairs, one pair per line.
- Empty lines or text beginning with // are
considered as comment and not taken into account.
- There can be maximum 20 lines (including comments)
Available keys for Apez.AutoLease are:
- LANG: currently settable values are fr, en, de,
and es, for french, english, german and spanish. You
MUST have the corresponding StringsAndLoader.XX
in the object content. Otherwise, the loading will
fail. Default value is en
- VERBOSE: accepted values are YES and NO. If YES,
the scripts will say some comments on each invitation/ejection
- Can also accept value EXTRA, meaning that it is
extra-verbose, displaying received notification from
service
- GROUP: the value must be your group name. You can
also append the role name, separated with ||| sign.
The role only works with Group.Invitor.Fixed
service. Example:
GROUP=MyRoBoT|||Officers
- EJECTACTION: this entry is only considered while
being with Group.Invitor.Fixed
service. 2 values can be set: LeaveGroup or
LeaveRole.
- When LeaveGroup is used, an avatar
reaching the end of lease will be ejected from
group.
- When LeaveRole is used, an avatar
reaching the end of lease will be ejected from role
(if there was no given role, or if role is Everyone,
the avatar will be ejected)
- When no value is given (empty or no line with
this key), the avatar will remain in group/role when
lease is ended. This is the default value, and the
only usable one with Group.Invitor (standard
edition)
|
|