crm

Version 4.3 by Kyle Hill on 2025/05/27 11:03

Required .NET Hosting Bundles:
Ensure the following .NET Runtimes are installed:

image-20250527112257-1.png

Testing and Debugging:
  • Check the system event viewer for any errors. Framework related and logs appear here if not successfully written to the logs. This may point to folder permission issues. 
Deployment Considerations:
  • IIS project name should be in the name of the domain in reversed:
    • Format: {{host_name}}
    • Example: za.co.site.uapi
  • Each API under the CRM project should have Its own app pool.
    • Format: {{host_name}}.{{api_name}}.{{version}}
    • Example: za.co.site.uapi.identity.v1
  • Each API under the CRM should be deployed as a virtual application linked to its relative app pool.
  • App pool considerations:
    • .NET CRL Version: No Managed Code
    • Managed Pipeline: Integrated
  • Each API project should be in the root directory of the project.
  • Under the root directory, there is a wwwroot folder, which should contain a blank folder for each of the API projects.
  • Ensure you replace all the connection strings, file paths and branding of the currently client with the new one.  
  • Clear out all the logs for each of the API projects and ensure IIS user has required permission to write to this directory
    • Directory: "za.co.site.uapi\EBSphere.Api.v1.Workflow\logs"
Database Considerations:
  • Some databases are setup to require a reference number when making structural changes to the database:
    • Create a session reference: exec sp_set_session_context 'ReferenceNo', '123456789'
    • The reference number is the ticket number of the project, as found on our Issue log system.
  • Depending on the state of the database, there might be tables, procedures, views and even data that need to be added. Is a list of some of these objects, that need to be present in the database for the CRM to work correctly (Please feel free to added on):
Object TypeNameDependencies
Procedureapi.sp_AddSupplier_Se 
Procedureapi.sp_BankAccountTypes_SelectV2 
Procedureapi.sp_Communication_Add 
Procedureapi.sp_Communication_AddProperty 
Procedureapi.sp_Content_Add 
Procedureapi.sp_Content_AddProperty 
Procedureapi.sp_CreateSupplier 
Procedureapi.sp_CRM_RegisterUser 
Procedureapi.sp_CRM_ResetPassword 
Procedureapi.sp_DocumentCategories_SelectV2 
Procedureapi.sp_Documents_SelectV2 
Procedureapi.sp_GetBBBEE_Levels 
Procedureapi.sp_GetPersonDetailsV2 
Procedureapi.sp_GetSupplierTypes 
Procedureapi.sp_GetUniversalBankBranch 
Procedureapi.sp_MemberBankDetails_SelectV2 
Procedureapi.sp_MemberBeneficiaries_SelectV2 
Procedureapi.sp_MemberClaimStatus_SelectV2 
Procedureapi.sp_MemberCouncilRates_SelectV2 
Procedureapi.sp_MemberNotes_InsertV2 
Procedureapi.sp_MemberNotes_SelectV2 
Procedureapi.sp_MemberNoteVariableGroups_SelectV2 
Procedureapi.sp_MemberNoteVariables_SelectV2 
Procedureapi.sp_MemberPayments_SelectV2 
Procedureapi.sp_MemberPaypoints_SelectV2 
Procedureapi.sp_MemberSalaries_SelectV2 
Procedureapi.sp_MemberSinglePremiums_SelectV2 
Procedureapi.sp_MemberTaxApplications_SelectV2 
Procedureapi.sp_People_SelectV2 
Procedureapi.sp_Scheduler_AddNote 
Procedureapi.sp_Scheduler_AddProperty 
Procedureapi.sp_Scheduler_CompleteActivity 
Procedureapi.sp_Scheduler_CreateProcess 
Procedureapi.sp_Scheduler_CurrentActivities 
Procedureapi.sp_Scheduler_GetActivityActions 
Procedureapi.sp_Scheduler_GetNotes 
Procedureapi.sp_Scheduler_GetProcessProperties 
Procedureapi.sp_SearchPersonDetails 
Procedureapi.sp_SearchPersonMembershipV2 
Procedureapi.sp_Workflow_AddNote 
Procedureapi.sp_Workflow_AddProperty 
Procedureapi.sp_Workflow_CompleteActivity 
Procedureapi.sp_Workflow_CreateProcess 
Procedureapi.sp_Workflow_GetActivityActions 
Procedureapi.sp_Workflow_GetLinkedContent 
Procedureapi.sp_Workflow_GetNotes 
Procedureapi.sp_Workflow_GetProcessProperties 
Procedureapi.sp_Workflow_LinkContent 
Procedureapi.sp_Workflow_Reallocate 
Procedureapi.sp_Workflow_SearchActivities 
Procedureapi.sp_Workflow_SearchProcess 
Procedureapi.sp_Workflow_SearchStreamResources 
Procedureapi.sp_Workflow_SearchStreams 
Procedureapi.sp_Workflow_UpdateProperty 
Proceduredbo.sp_InsertImageToDocDatabase 
Proceduredbo.sp_MaritalStatus 
Proceduredbo.sp_SchedulerAddNote 
Proceduredbo.sp_Update_frmPeople 
Proceduredbo.sp_UserLevels 
Proceduredbo.sp_WorkflowAddNote 
Procedureprg.sp_ProviderParameters_select 
Procedurescr.sp_BankBranches_Member 
Procedurescr.sp_MFGMemberCFLO 
Procedurescr.sp_MFGMemberPaypoints 
Procedurescr.sp_Paypoints 
Procedureweb.sp_UserWebLogin 

 

Tags: TODO