If_EmployeeRecord
|
| load | | This is called to load an employee : | | | | Required arguments: | | owner_id - The owner ID# | | Optional arguments: | | emp_id - The employee ID# (if not present, new employee) | | loginname - Login name (if not present, new employee) | | This returns 'yes' or 'no' depending on whether the item was loaded. |
|
| addupdateemployee | | This command creates or updates an existing employee. | | (Nothing is committed to the database yet) | | | | Optional arguments (all the fields default to empty): | | cli_id - Client ID | | 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: | | emp_status - Employee Status | | emp_perm - Employee Permission Level | | notes - Employee notes | | | | Returns the addressnum of the new address unless an error occurs. |
|
| setclient | | Sets cli_id value | | | | Arguments: | | cli_id - cli_id to be set (required) | | | | Returns 'ok' or 'error:...' |
|
| setstatus | | Sets emp_status value | | | | Arguments: | | emp_status - emp_status level to be set (required) | | | | Returns 'ok' or 'error:...' |
|
| setperm | | Sets emp_perm value | | | | Arguments: | | emp_perm - emp_perm level to be set (required) | | | | Returns 'ok' or 'error:...' |
|
| setpreference | | Sets an emp_preference property | | | | Arguments: | | key - key to be set (required) | | value - value to be set (required) | | | | Returns 'ok' or 'error:...' |
|
| setemail | | Sets emp_email value | | | | Arguments: | | emp_email - emp_email level to be set (required) | | | | Returns 'ok' or 'error:...' |
|
| setpreferences | | Sets emp_preferences value | | | | Arguments: | | emp_preferences - emp_preferences level to be set (required) | | | | Returns 'ok' or 'error:...' |
|
| setcliid | | Sets cli_id value | | | | Arguments: | | cli_id - cli_id to be set (required) | | | | Returns 'ok' or 'error:...' |
|
| These are commands to print/get info about the current employee
All of these that print something support 'prefix' and 'postfix'. |
|
| getfname | | Returns employee/contact first name |
|
| getlname | | Returns employee/contact last name |
|
| getphone | | Returns employee/contact phone number |
|
| getcliid | | Returns employee/contact cli_id |
|
| getemail | | Returns employee/contact email address |
|
| getperm | | Returns permissions for employee/contact |
|
| getlinkedempi | | Returns linked employee/contact ID |
|
| getid | | Returns the customer ID |
|
| getcustid | | Returns the customer ID |
|
| getempid | | Returns the customer ID |
|
| getownerid | | Returns the owner record ID |
|
| getnotes | | Returns notes from employee/contact record |
|
| fname | | Prints employee first name |
|
| lname | | Prints employee last name |
|
| mname | | Prints employee middle name |
|
| address1 | | Prints employee address line 1 |
|
| address2 | | Prints employee address line 2 |
|
|
| state | | Prints employee state |
|
|
| phone | | Prints employee phone |
|
|
| tollfree | | Prints employee tollfree |
|
| email | | Prints employee email |
|
|
| notes | | Prints employee notes |
|
| empperm | | Prints employee permission level |
|
| templateemployeeinfo | | This command shows employee information based on a template | | | | Arguments: | | template - Template format as below (required) | | | | Template replacable macros: | | ##FNAME## - First name | | ##MNAME## - Middle name | | ##LNAME## - Last name | | ##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 | | ##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 | | ##ID## - Record (employee) ID | | ##CLI_ID## - Client ID | | ##PERM## - Employee Permission Level | | ##PREF(count)## - (count) value found in EMP_PREFERENCES properties field | | | | Returns 'ok' or 'error:...' |
|
| checkloginexists | | Checks to see if a particular login name 'login' exists | | Returns 'yes' or 'no' |
|
| checkpassword | | This command checks the password of the loaded customer | | | | Arguments: | | password - The plaintext password to test (will always return 'no' if this is not specified.) | | | | Returns 'yes' or '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:...' |
|
| commit | | Commits data to database | | | | Returns 'ok' or 'error:...' |
|