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_ClientRecord

If_ClientRecord
The ClientRecord interface provides commands to manage client records

load
This is called to load a client :
 
Optional arguments:
cli_id - The client ID# (default = new client)
 
This returns 'yes' or 'no' depending on whether the client was loaded.


These are commands to print/get info about the current client All of these that print something support 'prefix' and 'postfix'.


getannexfield
This will get a field from the metatable CLIENTANNEX based on the field's name
 
Required arguments:
cli_id - The client ID#
template_id - The template ID#
annexfield - The name of the field to get (ie "HEADER")
table - The name of the table (in this case "CLIENTANNEX")
 
Optional arguments:
headerprefix = shows column title, and any HTML code to show before column title
headerpostfix = shows any HTML code to show after column title


addupdateclient
This command creates a new address and adds it to the end of the address list or updates an existing address. (Nothing is committed to the database yet)
 
Optional arguments (all the fields default to empty):
addressnum - If this is present, an existing address is updated
name - Company Name
fname - First name
mname - Middle name
lname - Last name
addr1 - Address line #1
addr2 - Address line #2
city - City
state - 2-letter state code
zip - Zip code
phone - Phone number
fax - Fax number
cell - Cellular phone number
pager - Pager number
tollfree - Toll free phone number
email - Email address
pageremail - Pager email address
title - Title (mr, ms, etc.)
country - Country of residence
attn - Attn to:
linked_emp_id - linked_emp_id
 
Returns the addressnum of the new address unless an error occurs.


commit
Commits data to database
 
Returns 'ok' or 'error:...'
 
Optional arguments :
ownership - wheather the new client is an owner (default=no)


setlogininfo
Sets login and password
 
Arguments:
login - Login name (required)
password - Password in plaintext (required)
encrypt - Scramble password with SHA1? (default=false)
 
Returns 'ok' or 'error:...'


templateclientinfo
This command shows client information based on a template
 
Arguments:
template - Template format as below (required)
 
Template replacable macros:
##ADDR1## - Address line #1
##ADDR2## - Address line #2
##ATTN## - Attn to:
##CELL## - Cellular phone number
##CITY## - City
##COUNTRY## - Country
##EMAIL## - E-Mail address
##FAX## - Fax phone number
##FNAME## - First name
##MNAME## - Middle name
##LNAME## - Last name
##PAGER## - Pager phone number
##PAGEREMAIL## - Pager email address
##PHONE## - Main phone number
##STATE## - 2-letter state code
##SSL## - State as options list
##TITLE## - Title or salutation
##TOLLFREE## - Toll free phone number
##ZIP## - Zip code
 
Returns 'ok' or 'error:...'