Format is as follows:

<Value Type><Field Name>[<Level Code>,<Level Option>]->
<Ref.Field Name>=<Value>,<Type>,<Extra>
# in one line only
# If <Value Type> = J for JSON data: 
<Value Type><Field Name>=<JSON data>

Where:

• Value Type is any of the following:
  • C for Cash – credit or debit of cash through Wallet Management
  • P for Points – credit or debit points through Points System Management
  • F for Field – modify the content of a field through Clients Database
  • X for eXecute – Execute specialized function to perform special tasks.
  • J for JSON data – Store JSON data for later use within the same Flow entry.
  • DI for Data Insert – modify the content of Data Management.
  • DU for Data Update – modify the content of Data Management.
• Field Name

  the name of the field (refer to CDB::FM )

  For <Value Type> = J (JSON data):
  

  • RAMM – for use with RAMM module.
    
    • trsb – For Top-Rank Sales Bonus, will set the percentage of rebate for each level of qualifying member.
      Example:
      

      JRAMM={'trsb':'1,1,1,1'}

• Ref. Field Name

  reference field name, used to match the field name to determine the client id (cid). Leave blank to use the same cid as the input from queue. When used, this is usually the referer field of Field Name. (refer to CDB::FM )

• Level Code

  as defined at Levels Management

  Set level code to RAMM for special behaviour based on ranks.

• Level Options

  Current available are:

  • dc – Dynamic Compression, increments Level Counter only if credit was injected
  • pm1 – Credits normally based on levels, then credit only strong leg up to infinity
  • pm2 – Credits normally up to infinity

  For, RAMM, current available are:

  • nosrc – Do not credit the user triggering the flow.
  • nodst – Do not credit the uplines of the user

• Value

  If Value Type is 'C' or 'P', value is the amount or reference amount to be flowed or credited.

  If Value Type is 'F', value will modified based on the Field Type:

  • Text or Textarea Type – if the field is text or textarea type, the Value will replace the value stored at the Field Name.
  • Numeric Type – if the field is numeric type, the value will be added (or subtracted if the value is negative) to the current numeric value of the field.
    Example:
    FUID=NUMFLD,10 – will add ten (10) to the field named NUMFLD.
    FRID->UID=NUMFLD,-10 – will subtract ten (10) to the field named NUMFLD of the SID of the UID. In other words, if SID is the sponsor, UID is the user that triggered this command through registration or product purchase, the sponsor will be deducted ten on their field named NUMFLD.
    If you want to replace the value of the field instead of performing arithmetic operation to the field, enclose the value in parenthesis.
    Example:
    FUID=NUMFLD,(10) – will replace the value of the field named NUMFLD with a value of 10.
    
  • Timestamp and Date Types – if the field is timestamp type or date type, the value can be:
    
    • numeric – the numeric value will be treated as seconds and will be added or subtracted to the current timestamp value of the field.
    • 'now' – the string value 'now' translates to the current date and time at the moment the command is triggered, this will set the field with the current date and time.
    Example:
    FUID=TSFLD,86400 – will add 60 * 60 * 24 seconds or 1 day to the field named TSFLD.
    FUID=TSFLD,now – will set the field named TSFLD to current date and time.
    
  • Checkbox Types – if the field is checkbox type, only the value 'checked' is recognized, the rest will translate to blank which is equivalent of the field being unchecked.
    Example:
    FUID=CHKFLD,checked – will set the field named CHKFLD to checked.
    FUID=CHKFLD,no – will set the field named CHKFLD to blank or empty which has the same effect as unchecked.
    

  If Value Type is 'X', value can be one of the following:

  • dynaCache – Use to generate dynamic cache of genealogy structure
    Command Format:
    XUID=dynaCache,[CDB_SG]
    Currently, only CDB_SG is available value for dynaCache
  • pairFlow – Use to perform a special flow with pairing condition on a teamed genealogy
    Command Format:
    XUID=pairflow,<Level Code>|<Field Name>
    
  • rammAddAP – Use to grant (add or insert) an Activity. AP Adjustment can be included, otherwise, it will insert the Activity with defined AP.
    Command Format:
    XUID=rammAddAP,<APAdj>,<Activity ID or Activity Tag>
    

• Type

  the Transaction Type for the value.

  • Type for Points Value are defined at Type Management
  • Type for Cash Value are defined at Type Management

• Extra

  If Value Type is 'C', this defines which Wallet will be credited. Leave blank to use the primary wallet.

Pre-condition and post-condition works on flow options using 'Conditional Scripting'.

The format is {pre-cond}flow option{post-condition}

{pre-cond} must be satisfied or returns true in order to execute flow option.

{post-condition} is applied to each levels checking each iteration before it executes flow option.

Check the examples section for more details.

CUID=100,4000100

– this will credit 100 Cash Value to UID field of the reference ID

CUID=100,4000100,SEC

– this will credit 100 Cash Value under (sec) wallet to UID field of the reference ID

PSID->UID=10,1

– will credit 10 Point Value to SID field of the reference ID

PSID[ABC]->UID=10,1

– this will Flow using the level defined with ABC level code using 10 Point Value to SID field of the reference ID

PSID[ABC,dc]->UID=10,1

– same as above, but with dynamic compression

FUID=CNTR,1

– this will increment the field named CNTR with 1 each time this command is executed.

FSID->UID=CNTR,1

– this will increment the field named CNTR of the sponsor (SID) of the user (UID) that triggered this command.

{seqQP=}FUID=QP,now

– this will set the field named QP with the current date and time each time if the QP field is empty.

XUID=dynaCache,CDB_SG

– this will eXecute dynaCache function for use with CDB::SG

XUID=pairFlow,ABC

– this will eXecute pairFlow function

{seqFLAG_BIN=checked}CUID=100,4000100

– this will credit 100 Cash Value to UID field of the reference ID if FLAG_BIN has a value of 'checked', otherwise, it skips the flow option.

PSID[ABCD,pm2]->UID=10,1{seqFLAG_BIN=checked}

– will Flow using the level defined with ABC level code using 10 Point Value to SID field of the reference ID, however, each level will be checked if FLAG_BIN has a value of 'checked' before the 10 Point Value is credited.

{@nleDCNT=bal,20}DIUID=DCNT,1,DCNT bal le 10

– if balance of DCNT of Data Management is less than or equal to 20, insert a record on DCNT of Data Management by 1 and set the notes of the inserted record as 'DCNT bal le 10'.

{@dmnleDCNT=bal,20,d7}DIUID=DCNT,1,DCNT bal le 10

– if sum of DCNT of Data Management is less than or equal to 20 within 7 days ago, insert a record on DCNT of Data Management by 1 and set the notes of the inserted record as 'DCNT bal le 10'.
Note: date range accepts: s for seconds, h for hours, d for day.

DUUID=DCNT,status,0,1

– Update status of all records under DCNT that has status=0 and set it to status=1

RAMM specific

RAMM flow uses Rank of members when computing and distributing points or crediting wallet.

PRID[RAMM]->UID=75,101

– This will use 75 as the amount in computing for the rebates of the member and its upline subject to rules of each Rank Groups. 101 is the Type ID used when inserting the points value.

PRID[RAMM,nosrc]->UID=75,101

– Like the previous example, but will credit points only to uplines

PRID[RAMM,nodst]->UID=75,101

– Like the previous example, but will credit points only to user

CRID[RAMM]->UID=75,7010100

– Like the previous example, but will credit wallet with rebates instead of points value.

JRAMM={'trsb':'1,1,1,1'}

– Stores JSON data {'trsb':'1,1,1,1'} into RAMM hash variable for later use.

XUID=rammAddAP,0,PP1

– Grant (add or insert) Activity with Tag PP1 to UID with no or zero AP Adjustments.

XUID=rammAddAP,10000,ADJP

– Grant (add or insert) Activity with Tag ADJP to UID with 10000 AP Adjustments.

XUID=rammAddAP,10000,1

– Grant (add or insert) Activity with ID 1 (equivalent to Tag ADJP) to UID with 10000 AP Adjustments.

None at the moment