Difference between revisions of "Client table fields"

From All n One's bxp software Wixi

Jump to: navigation, search
m
m
Line 15: Line 15:
 
= Overview =
 
= Overview =
  
The primary security table for individual users in bxp is called the "Client" table. This stores the details of users in the bxp system.
+
The primary security table for individual users in bxp is called the "Client" table. This stores the details of users in the bxp system.
  
  
Paired with this table is the Security and the HR table. Security manages the functional access to the system linking it with the Id column of the client table. The HR table also links to the Id column of the client table.
+
Paired with this table is the Security and the HR table. Security manages the functional access to the system linking it with the Id column of the client table. The HR table also links to the Id column of the client table.
  
  
Line 28: Line 28:
 
= Field reference =
 
= Field reference =
  
== Account ==  
+
== Account ==  
  
 
{| class="wikitable" style="width:100%;"
 
{| class="wikitable" style="width:100%;"
Line 35: Line 35:
 
! style="width:60%" | Notes
 
! style="width:60%" | Notes
 
|-
 
|-
| strClient_Title ||   ||
+
| strClient_Title || ||  
 
|-
 
|-
| strClient_Firstname ||   ||
+
| strClient_Firstname || ||  
 
|-
 
|-
| strClient_Surname ||   ||
+
| strClient_Surname || ||  
 
|-
 
|-
| intClient_Status ||   ||
+
| intClient_Status || ||  
 
|-
 
|-
 
|}
 
|}
   
+
== Primary Contact ==  
+
== Primary Contact ==  
 
{| class="wikitable" style="width:100%;"
 
{| class="wikitable" style="width:100%;"
 
! style="width:20%" | Db field name
 
! style="width:20%" | Db field name
Line 51: Line 51:
 
! style="width:60%" | Notes
 
! style="width:60%" | Notes
 
|-
 
|-
| strClient_CompanyStaffIdNumber || Company Staff Id Number ||     Comany Staff Id
+
| strClient_CompanyStaffIdNumber || Company Staff Id Number || Comany Staff Id
 
|-
 
|-
| strClient_Mobile || Work Contact Mobile ||     Used to SMS Staff
+
| strClient_Mobile || Work Contact Mobile || Used to SMS Staff
 
|-
 
|-
| strClient_Phone || Work Contact Email ||     Used to email Staff
+
| strClient_Phone || Work Contact Email || Used to email Staff
 
|-
 
|-
| intClient_Department || Department ||     The Department or Team the Staff works in
+
| intClient_Department || Department || The Department or Team the Staff works in
 
|-
 
|-
| intClient_Role || Role ||     The role of that staff member
+
| intClient_Role || Role || The role of that staff member
 
|-
 
|-
| strClient_CostCentre || Cost Centre ||     Please enter a cost centre name
+
| strClient_CostCentre || Cost Centre || Please enter a cost centre name
 
|-
 
|-
| strClient_IsChampion || Is System Champion ||     Will include the user on all System Champion notifications.
+
| strClient_IsChampion || Is System Champion || Will include the user on all System Champion notifications.
 
|-
 
|-
| strClient_IsApprovedContact || Is Approved Contact ||     Will allow the user submit Change Requests.
+
| strClient_IsApprovedContact || Is Approved Contact || Will allow the user submit Change Requests.
 
|-
 
|-
 
|}
 
|}
   
+
== Security Questions ==  
+
== Security Questions ==  
 
{| class="wikitable" style="width:100%;"
 
{| class="wikitable" style="width:100%;"
 
! style="width:20%" | Db field name
 
! style="width:20%" | Db field name
Line 75: Line 75:
 
! style="width:60%" | Notes
 
! style="width:60%" | Notes
 
|-
 
|-
| strClient_SecurityQuestion1 || Security Question 1 ||     Self service password, security question 1
+
| strClient_SecurityQuestion1 || Security Question 1 || Self service password, security question 1
 
|-
 
|-
| strClient_SecurityQuestion2 || Security Answer 1 ||     Self service password, security question 1 answer
+
| strClient_SecurityQuestion2 || Security Answer 1 || Self service password, security question 1 answer
 
|-
 
|-
| strClient_SecurityAnswer1 || Security Question 2 ||     Self service password, security question 2
+
| strClient_SecurityAnswer1 || Security Question 2 || Self service password, security question 2
 
|-
 
|-
| strClient_SecurityAnswer2 || Security Answer 2 ||     Self service password, security question 2 answer
+
| strClient_SecurityAnswer2 || Security Answer 2 || Self service password, security question 2 answer
 
|-
 
|-
 
|}
 
|}
   
+
== Primary Security Details ==  
+
== Primary Security Details ==  
 
{| class="wikitable" style="width:100%;"
 
{| class="wikitable" style="width:100%;"
 
! style="width:20%" | Db field name
 
! style="width:20%" | Db field name
Line 91: Line 91:
 
! style="width:60%" | Notes
 
! style="width:60%" | Notes
 
|-
 
|-
| strClient_IPRange || IP Range ||     If set the account will only be able to log in from this IP. Separate multiples with commas
+
| strClient_IPRange || IP Range || If set the account will only be able to log in from this IP. Separate multiples with commas
 
|-
 
|-
| strClient_ExternalId || External System Id ||     For use with the BEAPI
+
| strClient_ExternalId || External System Id || For use with the BEAPI
 
|-
 
|-
| strClient_ExternalKey || External System Key ||     For use with the BEAPI
+
| strClient_ExternalKey || External System Key || For use with the BEAPI
 
|-
 
|-
| intClient_ForceLogout || Force Inactive Logout ||     After [selected] Minutes. For Data Protection usage
+
| intClient_ForceLogout || Force Inactive Logout || After [selected] Minutes. For Data Protection usage
 
|-
 
|-
| strClient_IsStudent || External Student Access ||     When IP restricted can user still access courses and conferences.
+
| strClient_IsStudent || External Student Access || When IP restricted can user still access courses and conferences.
 
|-
 
|-
| strClient_UrlRedirect || Alternate Login URL ||     Set an alternate destination for the user to be redirected to when they login to bxp
+
| strClient_UrlRedirect || Alternate Login URL || Set an alternate destination for the user to be redirected to when they login to bxp
 
|-
 
|-
| strClient_3rdPartyEngine || 3rd Party Engine ||     If importing from or linking to a 3rd party solution, the name of that solution.
+
| strClient_3rdPartyEngine || 3rd Party Engine || If importing from or linking to a 3rd party solution, the name of that solution.
 
|-
 
|-
| strClient_3rdPartyUserId || 3rd Party User Id ||     The Id of the user to be used in that 3rd party solution.
+
| strClient_3rdPartyUserId || 3rd Party User Id || The Id of the user to be used in that 3rd party solution.
 
|-
 
|-
 
|}
 
|}
   
+
== Primary LDAP Details ==  
+
== Primary LDAP Details ==  
 
{| class="wikitable" style="width:100%;"
 
{| class="wikitable" style="width:100%;"
 
! style="width:20%" | Db field name
 
! style="width:20%" | Db field name
Line 115: Line 115:
 
! style="width:60%" | Notes
 
! style="width:60%" | Notes
 
|-
 
|-
| strClient_LdapHostAddress || Authorised ip addresses ||     IP addresses that are allowed connect to the LDAP server. Seperate multiple by ,
+
| strClient_LdapHostAddress || Authorised ip addresses || IP addresses that are allowed connect to the LDAP server. Seperate multiple by ,
 
|-
 
|-
| strClient_LdapHostPort || LDAP Host Address ||     The Host address of the LDAP server
+
| strClient_LdapHostPort || LDAP Host Address || The Host address of the LDAP server
 
|-
 
|-
| strClient_LdapBaseDn || LDAP Host Port ||     Port the LDAP server will be listening on
+
| strClient_LdapBaseDn || LDAP Host Port || Port the LDAP server will be listening on
 
|-
 
|-
| strClient_LdapAuthorisedIp || LDAP Base Dn ||     The LDAP Servers Base Distinguished Name
+
| strClient_LdapAuthorisedIp || LDAP Base Dn || The LDAP Servers Base Distinguished Name
 
|-
 
|-
| strClient_LdapAdminUserName || LDAP Admin Username i.e ||     User name for the Read Only admin user created on the LDAP server
+
| strClient_LdapAdminUserName || LDAP Admin Username i.e || User name for the Read Only admin user created on the LDAP server
 
|-
 
|-
| strClient_LdapAdminPassword || LDAP Admin Password ||     User name for the Read Only admin user created on the LDAP server
+
| strClient_LdapAdminPassword || LDAP Admin Password || User name for the Read Only admin user created on the LDAP server
 
|-
 
|-
| strClient_LdapMyUserName || LDAP My Username ||     User Name for the bxp users Active Directory account
+
| strClient_LdapMyUserName || LDAP My Username || User Name for the bxp users Active Directory account
 
|-
 
|-
| strClient_LdapMyDomain || LDAP My Domain ||     Domain for the bxp users Active Directory account
+
| strClient_LdapMyDomain || LDAP My Domain || Domain for the bxp users Active Directory account
 
|-
 
|-
 
|}
 
|}
   
+
== Primary VOIP Details ==  
+
== Primary VOIP Details ==  
 
{| class="wikitable" style="width:100%;"
 
{| class="wikitable" style="width:100%;"
 
! style="width:20%" | Db field name
 
! style="width:20%" | Db field name
Line 139: Line 139:
 
! style="width:60%" | Notes
 
! style="width:60%" | Notes
 
|-
 
|-
| strClient_VOIP_ServerTechnology || Phone Server Technology ||     When IP restricted can user still access courses and conferences.
+
| strClient_VOIP_ServerTechnology || Phone Server Technology || When IP restricted can user still access courses and conferences.
 
|-
 
|-
| strClient_VOIP_ServerIP || Server IP ||     The IP Address of the phone system
+
| strClient_VOIP_ServerIP || Server IP || The IP Address of the phone system
 
|-
 
|-
| strClient_VOIP_ServerPort || Server Port ||     The port the requests are sent to
+
| strClient_VOIP_ServerPort || Server Port || The port the requests are sent to
 
|-
 
|-
| strClient_VOIP_Extension || User Extension ||     The extension for this user
+
| strClient_VOIP_Extension || User Extension || The extension for this user
 
|-
 
|-
| strClient_VOIP_PIN || User PIN ||     The PIN code for this user
+
| strClient_VOIP_PIN || User PIN || The PIN code for this user
 
|-
 
|-
| strClient_AllowiFrame || Allow iFrame ||     
+
| strClient_AllowiFrame || Allow iFrame ||  
 
|-
 
|-
 
|}
 
|}
Line 161: Line 161:
 
! style="width:60%" | Notes
 
! style="width:60%" | Notes
 
|-
 
|-
| strClient_HTMLVersion || HTML Version ||     
+
| strClient_HTMLVersion || HTML Version ||  
 
|-
 
|-
| strClient_SpeedInterface || Speed Interface ||     
+
| strClient_SpeedInterface || Speed Interface ||  
 
|-
 
|-
| strClient_UsePresence || Use Presence ||     
+
| strClient_UsePresence || Use Presence ||  
 
|-
 
|-
| strClient_SystemLayout_MainMenu || Main Menu ||     
+
| strClient_SystemLayout_MainMenu || Main Menu ||  
 
|-
 
|-
| strClient_SystemLayout_SectionMenu || Section Menu ||
+
| strClient_SystemLayout_SectionMenu || Section Menu ||  
 
|-
 
|-
| strClient_SystemLayout_Page || Page ||     
+
| strClient_SystemLayout_Page || Page ||  
 
|-
 
|-
| strClient_SystemLayout_BackgroundImage || Background Image ||     
+
| strClient_SystemLayout_BackgroundImage || Background Image ||  
 
|-
 
|-
| strClient_SystemLayout_CSS || CSS ||     
+
| strClient_SystemLayout_CSS || CSS ||  
 
|-
 
|-
 
|}
 
|}
Line 186: Line 186:
 
! style="width:60%" | Notes
 
! style="width:60%" | Notes
 
|-
 
|-
| strClient_ListerOptions || Lister Options ||
+
| strClient_ListerOptions || Lister Options ||  
 
|-
 
|-
| strClient_ListerCategories || Lister Categories ||
+
| strClient_ListerCategories || Lister Categories ||  
 
|-
 
|-
| strClient_ListerType1 || Lister Type 1 ||
+
| strClient_ListerType1 || Lister Type 1 ||  
 
|-
 
|-
| strClient_ListerType2 || Lister Type 2 ||
+
| strClient_ListerType2 || Lister Type 2 ||  
 
|-
 
|-
| strClient_ListerType3 || Lister Type 3 ||
+
| strClient_ListerType3 || Lister Type 3 ||  
 
|-
 
|-
| strClient_ListerType4 || Lister Type 4 ||
+
| strClient_ListerType4 || Lister Type 4 ||  
 
|-
 
|-
| strClient_RemindersPage || Reminders Page Options ||     In Reminders, add custom HTML code
+
| strClient_RemindersPage || Reminders Page Options || In Reminders, add custom HTML code
 
|-
 
|-
| strClient_LimitTimeTrackerCosting || Limit Time Tracker Costing ||     In Time Tracker, Only show work types that have pricing associated?
+
| strClient_LimitTimeTrackerCosting || Limit Time Tracker Costing || In Time Tracker, Only show work types that have pricing associated?
 
|-
 
|-
 
|}
 
|}
  
== Security Information ==  
+
== Security Information ==  
 
{| class="wikitable" style="width:100%;"
 
{| class="wikitable" style="width:100%;"
 
! style="width:20%" | Db field name
 
! style="width:20%" | Db field name
Line 210: Line 210:
 
! style="width:60%" | Notes
 
! style="width:60%" | Notes
 
|-
 
|-
| intClient_CreatedBy || Created By ||
+
| intClient_CreatedBy || Created By ||  
 
|-
 
|-
| dteClient_DateCreated || Created Date ||
+
| dteClient_DateCreated || Created Date ||  
 
|-
 
|-
| intClient_LastEdited_ByWhom || Last Edited By ||
+
| intClient_LastEdited_ByWhom || Last Edited By ||  
 
|-
 
|-
| dteClient_LastEdited_LastDateTime || Last Edited Date ||
+
| dteClient_LastEdited_LastDateTime || Last Edited Date ||  
 
|-
 
|-
| intClient_Retired_LastByWhom || Retired By ||
+
| intClient_Retired_LastByWhom || Retired By ||  
 
|-
 
|-
| dteClient_Retired_LastDateTime || Retired Date ||
+
| dteClient_Retired_LastDateTime || Retired Date ||  
 
|-
 
|-
| dteClient_LastLoginDateTime || Last Login Date Time ||
+
| dteClient_LastLoginDateTime || Last Login Date Time ||  
 
|-
 
|-
| dteClient_CompanyStartDate || Company Start Date ||
+
| dteClient_CompanyStartDate || Company Start Date ||  
 
|-
 
|-
| dteClient_CompanyEndDate || Company End Date ||
+
| dteClient_CompanyEndDate || Company End Date ||  
 
|-
 
|-
| dteClient_LastPasswordChangeDateTime || Last Password Change Date Time ||     
+
| dteClient_LastPasswordChangeDateTime || Last Password Change Date Time ||  
 
|-
 
|-
| dteClient_LastPresence || Last Presence Date Time ||     
+
| dteClient_LastPresence || Last Presence Date Time ||  
 
|-
 
|-
| dteClient_Password_FirstFailDateTime || Password Fail - First Date Time ||     
+
| dteClient_Password_FirstFailDateTime || Password Fail - First Date Time ||  
 
|-
 
|-
| dteClient_Password_LastFailDateTime || Password Fail - Last Date Time ||     
+
| dteClient_Password_LastFailDateTime || Password Fail - Last Date Time ||  
 
|-
 
|-
 
|}
 
|}
   
+
== Custom User Global Variables ==  
+
== Custom User Global Variables ==  
 
{| class="wikitable" style="width:100%;"
 
{| class="wikitable" style="width:100%;"
 
! style="width:20%" | Db field name
 
! style="width:20%" | Db field name
Line 244: Line 244:
 
! style="width:60%" | Notes
 
! style="width:60%" | Notes
 
|-
 
|-
| strClient_CustomGlobalField_1 || Custom Global Variable 1 ||
+
| strClient_CustomGlobalField_1 || Custom Global Variable 1 ||  
 
|-
 
|-
| strClient_CustomGlobalField_2 || Custom Global Variable 2 ||
+
| strClient_CustomGlobalField_2 || Custom Global Variable 2 ||  
 
|-
 
|-
| strClient_CustomGlobalField_3 || Custom Global Variable 3 ||
+
| strClient_CustomGlobalField_3 || Custom Global Variable 3 ||  
 
|-
 
|-
| strClient_CustomGlobalField_4 || Custom Global Variable 4 ||
+
| strClient_CustomGlobalField_4 || Custom Global Variable 4 ||  
 
|-
 
|-
| strClient_CustomGlobalField_5 || Custom Global Variable 5 ||
+
| strClient_CustomGlobalField_5 || Custom Global Variable 5 ||  
 
|-
 
|-
| strClient_CustomGlobalField_6 || Custom Global Variable 6 ||
+
| strClient_CustomGlobalField_6 || Custom Global Variable 6 ||  
 
|-
 
|-
 
|}
 
|}

Revision as of 19:13, 13 March 2018

Client Functional Security Content Security HR
Link Link Link Link


1 Overview

The primary security table for individual users in bxp is called the "Client" table. This stores the details of users in the bxp system.


Paired with this table is the Security and the HR table. Security manages the functional access to the system linking it with the Id column of the client table. The HR table also links to the Id column of the client table.


Fields from this table are used throughout bxp.


They are listed here for reference purposes for replacement procedures.

2 Field reference

2.1 Account

Db field name On Screen name Notes
strClient_Title
strClient_Firstname
strClient_Surname
intClient_Status

2.2 Primary Contact

Db field name On Screen name Notes
strClient_CompanyStaffIdNumber Company Staff Id Number Comany Staff Id
strClient_Mobile Work Contact Mobile Used to SMS Staff
strClient_Phone Work Contact Email Used to email Staff
intClient_Department Department The Department or Team the Staff works in
intClient_Role Role The role of that staff member
strClient_CostCentre Cost Centre Please enter a cost centre name
strClient_IsChampion Is System Champion Will include the user on all System Champion notifications.
strClient_IsApprovedContact Is Approved Contact Will allow the user submit Change Requests.

2.3 Security Questions

Db field name On Screen name Notes
strClient_SecurityQuestion1 Security Question 1 Self service password, security question 1
strClient_SecurityQuestion2 Security Answer 1 Self service password, security question 1 answer
strClient_SecurityAnswer1 Security Question 2 Self service password, security question 2
strClient_SecurityAnswer2 Security Answer 2 Self service password, security question 2 answer

2.4 Primary Security Details

Db field name On Screen name Notes
strClient_IPRange IP Range If set the account will only be able to log in from this IP. Separate multiples with commas
strClient_ExternalId External System Id For use with the BEAPI
strClient_ExternalKey External System Key For use with the BEAPI
intClient_ForceLogout Force Inactive Logout After [selected] Minutes. For Data Protection usage
strClient_IsStudent External Student Access When IP restricted can user still access courses and conferences.
strClient_UrlRedirect Alternate Login URL Set an alternate destination for the user to be redirected to when they login to bxp
strClient_3rdPartyEngine 3rd Party Engine If importing from or linking to a 3rd party solution, the name of that solution.
strClient_3rdPartyUserId 3rd Party User Id The Id of the user to be used in that 3rd party solution.

2.5 Primary LDAP Details

Db field name On Screen name Notes
strClient_LdapHostAddress Authorised ip addresses IP addresses that are allowed connect to the LDAP server. Seperate multiple by ,
strClient_LdapHostPort LDAP Host Address The Host address of the LDAP server
strClient_LdapBaseDn LDAP Host Port Port the LDAP server will be listening on
strClient_LdapAuthorisedIp LDAP Base Dn The LDAP Servers Base Distinguished Name
strClient_LdapAdminUserName LDAP Admin Username i.e User name for the Read Only admin user created on the LDAP server
strClient_LdapAdminPassword LDAP Admin Password User name for the Read Only admin user created on the LDAP server
strClient_LdapMyUserName LDAP My Username User Name for the bxp users Active Directory account
strClient_LdapMyDomain LDAP My Domain Domain for the bxp users Active Directory account

2.6 Primary VOIP Details

Db field name On Screen name Notes
strClient_VOIP_ServerTechnology Phone Server Technology When IP restricted can user still access courses and conferences.
strClient_VOIP_ServerIP Server IP The IP Address of the phone system
strClient_VOIP_ServerPort Server Port The port the requests are sent to
strClient_VOIP_Extension User Extension The extension for this user
strClient_VOIP_PIN User PIN The PIN code for this user
strClient_AllowiFrame Allow iFrame


2.7 Interface options

Db field name On Screen name Notes
strClient_HTMLVersion HTML Version
strClient_SpeedInterface Speed Interface
strClient_UsePresence Use Presence
strClient_SystemLayout_MainMenu Main Menu
strClient_SystemLayout_SectionMenu Section Menu
strClient_SystemLayout_Page Page
strClient_SystemLayout_BackgroundImage Background Image
strClient_SystemLayout_CSS CSS

2.8 Module Specific

Db field name On Screen name Notes
strClient_ListerOptions Lister Options
strClient_ListerCategories Lister Categories
strClient_ListerType1 Lister Type 1
strClient_ListerType2 Lister Type 2
strClient_ListerType3 Lister Type 3
strClient_ListerType4 Lister Type 4
strClient_RemindersPage Reminders Page Options In Reminders, add custom HTML code
strClient_LimitTimeTrackerCosting Limit Time Tracker Costing In Time Tracker, Only show work types that have pricing associated?

2.9 Security Information

Db field name On Screen name Notes
intClient_CreatedBy Created By
dteClient_DateCreated Created Date
intClient_LastEdited_ByWhom Last Edited By
dteClient_LastEdited_LastDateTime Last Edited Date
intClient_Retired_LastByWhom Retired By
dteClient_Retired_LastDateTime Retired Date
dteClient_LastLoginDateTime Last Login Date Time
dteClient_CompanyStartDate Company Start Date
dteClient_CompanyEndDate Company End Date
dteClient_LastPasswordChangeDateTime Last Password Change Date Time
dteClient_LastPresence Last Presence Date Time
dteClient_Password_FirstFailDateTime Password Fail - First Date Time
dteClient_Password_LastFailDateTime Password Fail - Last Date Time

2.10 Custom User Global Variables

Db field name On Screen name Notes
strClient_CustomGlobalField_1 Custom Global Variable 1
strClient_CustomGlobalField_2 Custom Global Variable 2
strClient_CustomGlobalField_3 Custom Global Variable 3
strClient_CustomGlobalField_4 Custom Global Variable 4
strClient_CustomGlobalField_5 Custom Global Variable 5
strClient_CustomGlobalField_6 Custom Global Variable 6