This document describes the database schema and classes available in build 128 of the Subscribers database API.
The DatabaseRoutines class provides several miscellaneous routines relating to the API as a whole:
Subscribers.DatabaseRoutines.Build;Subscribers::DatabaseRoutines::Build();Subscribers.DatabaseRoutines.ConnectionString = "DSN=My DSN";Subscribers::DatabaseRoutines::SetDSN("My DSN");OS accounts
| Column | Type | Description |
| Created (FLD_CREATED) | datetime (optional) | Creation date |
| Review (FLD_REVIEW) | datetime (optional) | Review date |
| Owner (FLD_OWNER) | string(64) (optional) | Owner |
| Computer (FLD_COMPUTER) | string(64) (optional, read-only) | Computer |
| Platform (FLD_PLATFORM) | string(32) (optional, read-only) | Platform |
| Account (FLD_ACCOUNT) | string(64) (optional, read-only) | Account |
| Comment (FLD_COMMENT) | string(64) (optional) | Comment |
| Roles (FLD_ROLES) | string(32) (optional) | Roles |
| Spare1 (FLD_SPARE1) | string(32) (optional) | Spare |
| ReconcileStatus (FLD_RECONCILE_STATUS) | string(12) (optional) | Reconcile status |
| LastReconciled (FLD_LAST_RECONCILED) | datetime (optional) | Last reconciled |
New objects of this class are constructed with:
new Subscribers.Account(string Platform, string Computer, string AccountField)new Subscribers::Account($FLD_PLATFORM, $FLD_COMPUTER, $FLD_ACCOUNT)The following methods return a single object, or a null reference if the requested object was not found:
Lookup(string FLD_PLATFORM, string FLD_COMPUTER, string FLD_ACCOUNT)The following methods return a list of objects:
GetAll()GetAccountsForOwner(string BadgeNumber)Other methods:
Save() -- save the object to the database.Delete() -- delete the object from the database.Error() (Perl only) -- get error message from last operation, if any.| Object | Type | Description |
| OwnerPerson | People | The owner of the account |
Application accounts
| Column | Type | Description |
| Created (FLD_CREATED) | datetime (optional) | Creation date |
| Review (FLD_REVIEW) | datetime (optional) | Review date |
| Owner (FLD_OWNER) | string(64) (optional) | Owner |
| Computer (FLD_COMPUTER) | string(64) (optional, read-only) | Computer |
| Platform (FLD_PLATFORM) | string(32) (optional, read-only) | Platform |
| Account (FLD_ACCOUNT) | string(64) (optional, read-only) | Account |
| Comment (FLD_COMMENT) | string(64) (optional) | Comment |
| Connection (FLD_CONNECTION) | string(64) (optional) | Connection |
| Roles (FLD_ROLES) | string(32) (optional) | Roles |
| Spare1 (FLD_SPARE1) | string(32) (optional) | Spare |
| ReconcileStatus (FLD_RECONCILE_STATUS) | string(12) (optional) | Reconcile status |
| LastReconciled (FLD_LAST_RECONCILED) | datetime (optional) | Last reconciled |
New objects of this class are constructed with:
new Subscribers.Application(string Platform, string Computer, string Account)new Subscribers::Application($FLD_PLATFORM, $FLD_COMPUTER, $FLD_ACCOUNT)The following methods return a single object, or a null reference if the requested object was not found:
Lookup(string FLD_PLATFORM, string FLD_COMPUTER, string FLD_ACCOUNT)The following methods return a list of objects:
GetAll()GetAccountsForOwner(string BadgeNumber)Other methods:
Save() -- save the object to the database.Delete() -- delete the object from the database.Error() (Perl only) -- get error message from last operation, if any.| Object | Type | Description |
| OwnerPerson | People | The owner of the account |
Subscribers
| Column | Type | Description |
| Index (FLD_INDEX) | string(32) (read-only) | Badge Number |
| Name (FLD_NAME) | string(64) (optional) | Name |
| Lastname (FLD_LASTNAME) | string(32) (optional) | Last name |
| Title (FLD_TITLE) | string(32) (optional) | Title |
| AccTitle (FLD_ACC_TITLE) | string(32) (optional) | Academic Title |
| Address (FLD_ADDRESS) | string(64) (optional) | Address |
| PoBox (FLD_PO_BOX) | string(32) (optional) | PO Box |
| City (FLD_CITY) | string(64) (optional) | City |
| State (FLD_STATE) | string(32) (optional) | State |
| Zip (FLD_ZIP) | string(32) (optional) | Zip |
| Country (FLD_COUNTRY) | string(32) (optional) | Country |
| Room (FLD_ROOM) | string(32) (optional) | Room |
| Telephone (FLD_TELEPHONE) | string(32) (optional) | Telephone Number |
| Mobile (FLD_MOBILE) | string(32) (optional) | Mobile Number |
| Fax (FLD_FAX) | string(32) (optional) | Fax Number |
| Isdn (FLD_ISDN) | string(32) (optional) | ISDN Number |
| Email (FLD_EMAIL) | string(64) (optional) | E-mail Address |
| CostCenter (FLD_COST_CENTER) | string(32) (optional) | Cost Center |
| CcMgr (FLD_CC_MGR) | string(64) (optional) | Cost Center Manager |
| Partner (FLD_PARTNER) | string(64) (optional) | Partner |
| Secretary (FLD_SECRETARY) | string(64) (optional) | Secretary |
| SecretaryPhone (FLD_SECRETARY_PHONE) | string(32) (optional) | Secretary Phone Number |
| Language (FLD_LANGUAGE) | string(32) (optional) | Language |
| UsrGroup (FLD_USR_GROUP) | string(32) (optional) | USR_GROUP |
| JobTitle (FLD_JOB_TITLE) | string(32) (optional) | Job Title |
| OrgName (FLD_ORG_NAME) | string(64) (optional) | Organization Name |
| OrgUnit1 (FLD_ORG_UNIT1) | string(64) (optional) | Org Unit 1 |
| OrgUnit2 (FLD_ORG_UNIT2) | string(64) (optional) | Org Unit 2 |
| OrgUnit3 (FLD_ORG_UNIT3) | string(64) (optional) | Org Unit 3 |
| OrgUnit4 (FLD_ORG_UNIT4) | string(64) (optional) | Org Unit 4 |
| Department (FLD_DEPARTMENT) | string(64) (optional) | Department |
| CountryCode (FLD_COUNTRY_CODE) | string(12) (optional) | Country Code |
| GeogLoc (FLD_GEOG_LOC) | string(64) (optional) | Geographical Location |
| LastVmsUicGp (FLD_LAST_VMS_UIC_GP) | string(12) (optional) | LAST_VMS_UIC_GP |
| LastVmsUicMem (FLD_LAST_VMS_UIC_MEM) | string(12) (optional) | LAST_VMS_UIC_MEM |
| LastUnixUidGp (FLD_LAST_UNIX_UID_GP) | string(32) (optional) | LAST_UNIX_UID_GP |
| LastUnixUidMem (FLD_LAST_UNIX_UID_MEM) | string(32) (optional) | LAST_UNIX_UID_MEM |
| Roles (FLD_ROLES) | string(32) (optional) | Roles |
| UsrDef1 (FLD_USR_DEF1) | string(64) (optional) | User-defined Field 1 |
| UsrDef2 (FLD_USR_DEF2) | string(64) (optional) | User-defined Field 2 |
| UsrDef3 (FLD_USR_DEF3) | string(64) (optional) | User-defined Field 3 |
| UsrDef4 (FLD_USR_DEF4) | string(64) (optional) | User-defined Field 4 |
| DefUsername (FLD_DEF_USERNAME) | string(64) (optional) | Default Username |
| Comment (FLD_COMMENT) | string(64) (optional) | Comment |
| LastEmploymentDate (FLD_LAST_EMPLOYMENT_DATE) | datetime (optional) | Last Employment Date |
| RecType (FLD_REC_TYPE) | string(16) (optional) | Record Type |
| RecStatus (FLD_REC_STATUS) | string(12) (optional) | Record Status |
| RecstatChange (FLD_RECSTAT_CHANGE) | datetime (optional) | Record Status Last Changed |
| SynchStatus (FLD_SYNCH_STATUS) | string(32) (optional) | Synchronization Status |
| SynchDate (FLD_SYNCH_DATE) | datetime (optional) | Synchronization Status Last Changed |
| DistinguishedName (FLD_DISTINGUISHED_NAME) | string(128) (optional) | Distinguished Name |
| Created (FLD_CREATED) | datetime (optional) | Creation Date |
| LastMod (FLD_LAST_MOD) | datetime (optional) | Last Modified Date |
New objects of this class are constructed with:
new Subscribers.People(string Index)new Subscribers::People($FLD_INDEX)The following methods return a single object, or a null reference if the requested object was not found:
Lookup(string FLD_INDEX)The following methods return a list of objects:
GetAll()GetByPartialName(string LikeName)Other methods:
Save() -- save the object to the database.Delete() -- delete the object from the database.Error() (Perl only) -- get error message from last operation, if any.