XactCommerce Xact Objects
Home
News
XactCommerce
Typical Applications
Custom Development
Private Backend
XactScript Language
Performance
Deployment
Partners
Portfolio
About Us
leXml Language < Interface Modules & Commands < If_ClientBrowserV1

If_ClientBrowserV1
The ClientBrowserV1 interface provides commands to view lists of client records

load
Called to load a list of items into the session.
 
Optional arguments:
owner_id = Owner ID of items to browse (default=all)
cli_id = Client ID if you're just looking at one record (default=all)
orderby = Valid values: name,priceasc,pricedesc,id,partno,none (default=name)
search_text = Any text used to search in item name or descriptions
owners = Weather to only search owners (default=no)
nonowners = Weather to only search non-owners (default=no)
linked_emp_id = Location of Client's Main Record
title = Title of Client's Main Record
emp_perm = Employee Permission Level
emp_perm_greater = Employee Permission Level greater than this value
emp_perm_less = Employee Permission Level less than this value


cli_id
Prints and returns cli_id


getcounter
Returns and prints the item counter


hasnext
Returns 'yes' or 'no' depending on whether there is a next item


isready
Returns 'yes' or 'no' depending on if we have any more items to view This will also return 'no' if we've just loaded an item list but haven't called next yet!


name
Prints client name


next
Moves to next item and returns 'yes' or 'no' like isready


remainingclientcount
Prints and returns number of items remaining
If 'truncateto' is set, this value will be limited to 'truncateto'
(e.g. for doing 'view next ## items')


resume
Resumes an existing item browse session
Optional arguments:
startat - Item counter to start at (default=-1)
Returns 'yes' or 'no' depending on whether there was a session to resume


templateclientlist
This command allows a different approach to the listing of items. It loops 'itemcount' times and uses 'template' to create the HTML to list. 'template' contains HTML and can contain a series of special macros that will be replaced with specific info about the item. The item list also stops if no more items are available.
 
Here are the macros that can be included in the template:
 
##NAME## - Name of client
##CLI_ID## - Replaced with client ID
##EMP_ID## - Replaced with client main employee ID
##OWNER_ID## - Replaced with owner ID
##ADDR1## - Replaced with client main employee address line 1
##ADDR2## - Replaced with client main employee address line 2
##CITY## - Replaced with client main employee city
##STATE## - Replaced with client main employee state
##ZIP## - Replaced with client main employee zip
##PHONE## - Replaced with client main employee phone #
##FAX## - Replaced with client main employee fax #
##EMAIL## - Replaced with client main employee email
##EMP_PERM## - Replaced with employee permission level
 
Arguments:
itemcount - Number of items to display (default=10)
template - The main HTML template as described above (required)
 
Returns how many clients were actually printed or "error:..." if an error occurred.


totalclientcount
Prints and returns total number of items in current cursor