- uidfield — the main field that contains the main ID or User ID of the user.
Example:
uidfield=UID
- ridfield — the referrer field that contains the sponsor of the account.
Example:
ridfield=SID
- cqpoints — Coop Qualification Points, the total PRODUCT POINTS needed to qualify for the COOP REBATE program (i.e. a slot on COOP LINE).
Example:
cqpoints=100
- rqpoints — Rebate Qualification Points, the required accumulation of COOP POINTS in order to earn the equivalent REBATE POINTS.
Example:
rqpoints=1400
- rebatepoints — Points earned after accumulating certain amount of COOP POINTS as defined by rqpoints.
Example:
rebatepoints=10000
which translates to 1400 COOP POINTS = 10000 rebate points
- cashback — Cash credited to the user after accumulating certain amount of COOP POINTS as defined by rqpoints.
Example:
cashback=100,2000600
This will credit 100 with trantype 2000600 (Cash Back) to the user after completing or graduating a slot.
- rebateSched — Rebate schedule in crediting the rebatepoints. Valid options are REALTIME and EOD, with REALTIME
as the default option.
Example:
rebateSched=EOD
This will credit all rebate points at End-of-Day.
- cashbackOverride — Used when computing for 'Prorated Cashback Value' during EOD computation.
Example:
cashbackOverride=150
This will use 150 as allocated value during EOD computation of 'Prorated Cashback Value'.
- cooplinepv — The points earned by the current active node on the COOP LINE.
Example:
cooplinepv=50
- cooplinepv_x — The points earned by a slot on COOP LINE queue based on the position from the active slot.
When defining levels, do not skip a level, if you have a value for 2 and 4 but none for 3, set cooplinepv_3=0.
Example:
cooplinepv_1=50
This works exactly like coopline because it credits slot 1 which is the current active slot.
cooplinepv_2=100
This will credit the 2nd slot after the current active slot.
- coopline_lvlpv_x — The points earned by each level on the COOP LINE based on the Team.
Example:
coopline_lvlpv_1=100
coopline_lvlpv_2=50
coopline_lvlpv_3=50
- cooplinepv_flush — If set to yes, excess unflown points will be flushed out instead of credited to the topmost
user.
Example:
cooplinepv_flush=yes
- clspillfield — or Coop Line Spill Field, is the pointer to the field defined under
'Clients Database::Field Management' or CDB::FM
to store the excess points from Coop Line when it graduated.
Example:
clspillfield=NUMERICFIELD
- clspillover — or Coop Line Spillover, set this option to 'yes', 'true' or 1 to enable
spillover of excess points from previously graduated Coop Line entry into other active
Coop Line entry on queue.
Example:
clspillover=yes
- deferredclfield — or Deferred Coop Line Field, is the pointer to the field defined under
'Clients Database::Field Management' or CDB::FM
to temporarily store points for Coop Line when it earns points.
Example:
deferredclfield=NUMERICFIELD
- deferred_clpv_x — If set to 'yes', the points earned by the specified level on the COOP LINE will be deferred
and saved to deferredclfield.
Example:
deferred_clpv_2=yes
This will defer points earned from level 2 and save it to deferredclfield.
- deferredclmaxcreditperday — This is the maximum amount per day to be credited to a user from pool that was saved
on deferredclfield.
Example:
deferredclmaxcreditperday=1800
At EOD, the user will be credited with 1800 only.
- directrebatepoints — the rebate points that will be directly credited to the user's Rebate Points Pool (RPPOOL) upon
qualifying for a slot on COOPLINE.
Example:
directrebatepoints=500
This will credit 500 rebate points to the user that qualified for the COOPLINE.
- rp_convrate — the value of 1 Rebate Point to Wallet. This is used when converting
Rebate Points into Wallet using 'convert' feature (if feature is enabled by admin).
Example:
rp_convrate=1
Will credit 1 RP to 1 Wallet Cash Value.
rp_convrate=0.9
100 RP is equivalent to 90 Wallet Cash Value.
- rp_conv_wallettype — the transaction type that will be used when converting rebate points
into wallet.
Example:
rp_conv_wallettype=2000500
On standard installation, transaction type 2000500 is 'Convert Request'.
- advancereentryfield — is the pointer to the field defined under
'Clients Database::Field Management' or CDB::FM
to store or count the number of slots that has been pre-purchased by the user from
graduating a slot. This should be a numeric field. Check the field autoBuyProdID for the Product ID to purchase.
Example:
advancereentryfield=REENTRYCNT
This will use field name REENTRYCNT for counting pre-purchased slots.
- advancereentrystep — is the count of graduated slots before
advance reentry is triggered. If not defined, advance reentry will always trigger.
This should be a numeric field.
Example:
advancereentrystep=6
This will trigger advance reentry every 6th graduate.
- advancereentrystepfield — is the pointer to the field defined under
'Clients Database::Field Management' or CDB::FM
to store or count purchases by the user from
graduating a slot as triggered by advancereentrystep. This should be a numeric field.
Check the field autoBuyProdID for the Product ID to purchase.
Example:
advancereentrystepfield=REENTRYSTEPCNT
This will use field name REENTRYSTEPCNT for counting pre-purchased slots triggered by advancereentrystep.
- advancereentrynochecking — set this to a value of 'yes' to disable checking if
CL and WL are both 0 before triggering advance re-entry.
Example:
advancereentrynochecking=yes
This will trigger advance re-entry regardless of state of CL or WL
- maintained_slots_multi — the number of maintained slots if Auto Buy is set to MULTI.
This is a numeric value.
Example:
maintained_slots_multi=18
This will maintain 18 slots.
- maintained_slots_multi_threshold — the number of slots the user currently have before
Auto Buy feature is triggered. This is a numeric value.
Example:
maintained_slots_multi_threshold=12
If active slots is equal to or less than 12, it will trigger the Auto Buy feature to maintain
slots defined by maintained_slots_multi.
- maintained_slots_last — the number of maintained slots if Auto Buy is set to LAST.
This is a numeric value.
Example:
maintained_slots_last=6
This will maintain 6 slots.
- maintained_slots_last_threshold — the number of slots the user currently have before
Auto Buy feature is triggered. This is a numeric value.
Example:
maintained_slots_last_threshold=1
If active slots is equal to or less than 1, it will trigger the Auto Buy feature to maintain
slots defined by maintained_slots_last.
- admin_id — The client ID of admin where the uncredited points caused by cooplinepv_flush
will be credited.
This is usually the company/organization account. Make sure this account does not participate or own a slot
so that the points will not mix with regular points activity and can be used for report gathering.
Example:
admin_id=1
- activity_expiry_field — or Activity Point Expiry Field, is the pointer to the field defined under
'Clients Database::Field Management' or CDB::FM
to store the date expiration based on activity of user.
Example:
activity_expiry_field=APEXPIRY
- ap_conv — the value of Point Value per 1 day of Activity Point. This is only used if
the product does not have an AP value. Also used on import and DCF for
Coop Qualification Pool. Result of ap_conv is rounded-up
instead of rounded-off, meaning any decimal in excess is automatically counted as whole number.
Example:
ap_conv=50
will credit 1 day of Activity Point per 50 Point Value.
- slot_ap — the Activity Point that will be added to the user's AP Pool when a slot is created.
AP is in days.
Example:
slot_ap=30
Will add 30 days of Activity Points to the user when a slot is created.
- ranks_name_x — the name to describe a rank for each level.
Example:
ranks_name_1=Silver
ranks_name_2=Gold
ranks_name_3=Platinum
- ranks_ds_x — the required number of direct sponsors for each level to qualify for this rank.
Example:
ranks_ds_1=3
ranks_ds_2=6
ranks_ds_3=9
- ranks_reentry_x — the number of free re-entries after qualifying the specified rank per level.
Example:
ranks_reentry_1=3
ranks_reentry_2=6
ranks_reentry_3=12
- ranks_rpcredit_x — the rebate points credited to a ranking sponsor.
Example:
ranks_rpcredit_1=500,500,1000
ranks_rpcredit_2=1000,1000
ranks_rpcredit_3=2000
- ranks_drcredit_x — the rebate points credited to a ranking user that maintains the specified active referrals.
Example:
ranks_drcredit_1=300
ranks_drcredit_2=500
ranks_drcredit_3=800
- ranks_ar_x — the required number of active referrals for each level to qualify for ranks_drcredit_x.
Example:
ranks_ar_1=5
ranks_ar_2=7
ranks_ar_3=10
- rank_uidfield — the main field that contains the main ID or User ID of the user.
Example:
rank_uidfield=UID
- rank_ridfield — the referrer field that contains the sponsor of the account.
Example:
rank_ridfield=SID
- rank_recntfield — the field use to track re-entries.
Example:
rank_recntfield=NUMTEST
- rank_field — the field use to save the user rank.
Example:
rank_field=RANK_ID
- maxRankAccts — the list of users that will have automatic maximum rank, usually for corporate top nodes.
List is consist of Client IDs separated by comma.
Example:
maxRankAccts=1,2,3
cid 1, 2 and 3 will have max rank.
- drCashbackPercent — is the percentage of earnings by the direct referrals. The
percentage is taken from the total earned points from the rppool trantype listed at drCashbackTrantype
by the referrals.
Example:
drCashbackPercent=5
This will get 5 percent of the earnings of referrals.
- drCashbackTrantype — is the list of trantype separated by comma (,) that will be used to compute
for drCashbackPercent. If this is not defined, the default behaviour is to take total earned points
from ranks_rpcredit_x and ranks_drcredit_x by the referrals.
Example:
drCashbackTrantype=1000300,1000400
This will get 5 percent of the earnings from ranks_rpcredit_x and ranks_drcredit_x of referrals.
- splrank_field_x — defines which checkbox-type field defined under
'Clients Database::Field Management' or CDB::FM
contains the info of the client that indicates whether it is affected by this feature.
You can have more than one definition of this feature indicated by the 'x' replaced by a number.
Example:
splrank_field_1=SPLRANK
This will use the field named SPLRANK as reference. If a user has SPLRANK with value 'checked', the user
will have 'minrank' applied indicated on splrank_minrank_1 option.
- splrank_minrank_x — defines the minimum rank of the user if it has the corresponding
field indicated by 'splrank_field_x' set to 'checked'.
Example:
splrank_minrank_1=3
User with field indicated by splrank_field_1 marked as 'checked' will have a minimum rank of 3.
- autoBuyField — The field that will hold the Auto Buy choice of the user. Field-type should be
checkbox.
Example:
autoBuyfield=AUTOBUY
- multiBuyField — The field that will hold the choice of the user in maintaining slots for auto-buy
option. Field-type should be checkbox-type with multiple slots as the on or checked state and last slot
as the off or unchecked state.
Example:
multiBuyField=MULTIBUY
- autoBuyProdID — The ID number of the product defined at Product
Admin that will be used for auto-buy.
Example:
autoBuyProdID=1
This will automatically purchase Product ID #1.
- showWidget — Enable/Disable display of widgets on the member page containing the
auto-buy and multi-buy switches and the slot status.
Valid options are:
yes or all - displays both the switches and slot status
switches - displays only the switches
slots - display only the slot status
Example:
showWidget=yes
- widgetTitle — The title that will be used when displaying the widget on the member page.
Example:
widgetTitle=Rewards Information
- autoBuyTitle — The title that will be used when displaying auto-buy switch for
the widget on the member page.
Example:
autoBuyTitle=Auto-purchase:
- multiBuyTitle — The title that will be used when displaying multi-buy switch for
the widget on the member page.
Example:
multiBuyTitle=Maintained slots:
- defaultAutoBuyMode — If no autobuy mode is selected by user, the defined setting
here will be used. If this keyword is left blank or not defined, autobuy will not trigger.
Valid values are: MULTI and LAST
Example:
defaultAutoBuyMode=MULTI
- showWidgetRedeemCode — Setting this to 'yes' will display a widget on the header of member page
for entering codes for product redemption.
Example:
showWidgetRedeemCode=yes
- widgetTitleRedeemCode — The title that will be used when displaying the Redeem Code widget on the member page.
Example:
widgetTitleRedeemCode=Rewards Information
- session_ids — Session IDs from CGM::SM that will be allowed to use
on this project when using codes for product redemption. Use comma (,) to separate multiple ids.
Example:
session_ids=1,2
- queueListTitle — The title that will be used when displaying list of queued slots
on the member page.
Example:
queueListTitle=Rewards List
- slotQueueMode — Sets how new slots are added to the COOPLINE queue. Available options are:
default – The default mode of creating a slot whenever cqpoints is reached. Also the default
behaviour if this option is left blank or not defined.
alternate – The alternate mode will only create a slot if the slot before the new slot is not the same
client. If the client will have multiple slot, the remaining slots will be placed on a waiting queue that will be placed on
the COOPLINE queue when another client is added.
Example:
slotQueueMode=alternate
- slotsTransferred — Sets how many slots from waiting queue will be transferred to COOPLINE queue
whenever a new client qualifies for a new slot. This is numeric integer.
Example:
slotsTransferred=2
- newSlotsBeforeTransfer — Sets how many new slots to allow before waiting queue is transferred to COOPLINE queue
This is numeric integer.
Example:
newSlotsBeforeTransfer=2