| ... |
... |
@@ -1,15 +1,20 @@ |
| 1 |
|
-Required .NET Hosting Bundles: |
|
1 |
+===== **Required .NET Hosting Bundles:** ===== |
| 2 |
2 |
|
| 3 |
3 |
* [[.NET 6 Hosting Bundle>>https://dotnet.microsoft.com/en-us/download/dotnet/6.0]] |
| 4 |
4 |
|
|
5 |
+===== **Ensure the following .NET Runtimes are installed:** ===== |
| 5 |
5 |
|
| 6 |
|
-Ensure the following .NET Runtimes are installed: |
| 7 |
|
- |
| 8 |
8 |
[[image:image-20250527112257-1.png]] |
| 9 |
9 |
|
| 10 |
10 |
|
| 11 |
|
-Deployment Considerations: |
|
10 |
+===== **Testing and Debugging:** ===== |
| 12 |
12 |
|
|
12 |
+* 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. |
|
13 |
+ |
|
14 |
+===== ===== |
|
15 |
+ |
|
16 |
+===== **Deployment Considerations:** ===== |
|
17 |
+ |
| 13 |
13 |
* IIS project name should be in the name of the domain in reversed: |
| 14 |
14 |
** Format: ~{~{host_name}} |
| 15 |
15 |
** Example: za.co.site.uapi |
| ... |
... |
@@ -16,13 +16,92 @@ |
| 16 |
16 |
* Each API under the CRM project should have Its own app pool. |
| 17 |
17 |
** Format: ~{~{host_name}}.~{~{api_name}}.~{~{version}} |
| 18 |
18 |
** Example: za.co.site.uapi.identity.v1 |
|
24 |
+* Each API under the CRM should be deployed as a virtual application linked to its relative app pool. |
|
25 |
+* App pool considerations: |
|
26 |
+** .NET CRL Version: No Managed Code |
|
27 |
+** Managed Pipeline: Integrated |
| 19 |
19 |
* Each API project should be in the root directory of the project. |
| 20 |
20 |
* Under the root directory, there is a wwwroot folder, which should contain a blank folder for each of the API projects. |
| 21 |
21 |
* Ensure you replace all the connection strings, file paths and branding of the currently client with the new one. |
| 22 |
22 |
* Clear out all the logs for each of the API projects and ensure IIS user has required permission to write to this directory |
| 23 |
|
-** Directory: za.co.site.uapi\EBSphere.Api.v1.Workflow\logs |
| 24 |
|
-* |
| 25 |
|
- |
|
32 |
+** Directory: "//za.co.site.uapi\EBSphere.Api.v1.Workflow\logs//" |
| 26 |
26 |
|
|
34 |
+===== ===== |
| 27 |
27 |
|
|
36 |
+===== **Database Considerations:** ===== |
|
37 |
+ |
|
38 |
+* Some databases are setup to require a reference number when making structural changes to the database: |
|
39 |
+** Create a session reference: (% style="color:#2980b9" %)//exec//(%%)// sp_set_session_context 'ReferenceNo', '123456789'// |
|
40 |
+** The reference number is the ticket number of the project, as found on our Issue log system. |
|
41 |
+* 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//): |
|
42 |
+ |
|
43 |
+|=Object Type|=Name|=Dependencies |
|
44 |
+|Procedure|api.sp_AddSupplier_Se| |
|
45 |
+|Procedure|api.sp_BankAccountTypes_SelectV2| |
|
46 |
+|Procedure|api.sp_Communication_Add| |
|
47 |
+|Procedure|api.sp_Communication_AddProperty| |
|
48 |
+|Procedure|api.sp_Content_Add| |
|
49 |
+|Procedure|api.sp_Content_AddProperty| |
|
50 |
+|Procedure|api.sp_CreateSupplier| |
|
51 |
+|Procedure|api.sp_CRM_RegisterUser| |
|
52 |
+|Procedure|api.sp_CRM_ResetPassword| |
|
53 |
+|Procedure|api.sp_DocumentCategories_SelectV2| |
|
54 |
+|Procedure|api.sp_Documents_SelectV2| |
|
55 |
+|Procedure|api.sp_GetBBBEE_Levels| |
|
56 |
+|Procedure|api.sp_GetPersonDetailsV2| |
|
57 |
+|Procedure|api.sp_GetSupplierTypes| |
|
58 |
+|Procedure|api.sp_GetUniversalBankBranch| |
|
59 |
+|Procedure|api.sp_MemberBankDetails_SelectV2| |
|
60 |
+|Procedure|api.sp_MemberBeneficiaries_SelectV2| |
|
61 |
+|Procedure|api.sp_MemberClaimStatus_SelectV2| |
|
62 |
+|Procedure|api.sp_MemberCouncilRates_SelectV2| |
|
63 |
+|Procedure|api.sp_MemberNotes_InsertV2| |
|
64 |
+|Procedure|api.sp_MemberNotes_SelectV2| |
|
65 |
+|Procedure|api.sp_MemberNoteVariableGroups_SelectV2| |
|
66 |
+|Procedure|api.sp_MemberNoteVariables_SelectV2| |
|
67 |
+|Procedure|api.sp_MemberPayments_SelectV2| |
|
68 |
+|Procedure|api.sp_MemberPaypoints_SelectV2| |
|
69 |
+|Procedure|api.sp_MemberSalaries_SelectV2| |
|
70 |
+|Procedure|api.sp_MemberSinglePremiums_SelectV2| |
|
71 |
+|Procedure|api.sp_MemberTaxApplications_SelectV2| |
|
72 |
+|Procedure|api.sp_People_SelectV2| |
|
73 |
+|Procedure|api.sp_Scheduler_AddNote| |
|
74 |
+|Procedure|api.sp_Scheduler_AddProperty| |
|
75 |
+|Procedure|api.sp_Scheduler_CompleteActivity| |
|
76 |
+|Procedure|api.sp_Scheduler_CreateProcess| |
|
77 |
+|Procedure|api.sp_Scheduler_CurrentActivities| |
|
78 |
+|Procedure|api.sp_Scheduler_GetActivityActions| |
|
79 |
+|Procedure|api.sp_Scheduler_GetNotes| |
|
80 |
+|Procedure|api.sp_Scheduler_GetProcessProperties| |
|
81 |
+|Procedure|api.sp_SearchPersonDetails| |
|
82 |
+|Procedure|api.sp_SearchPersonMembershipV2| |
|
83 |
+|Procedure|api.sp_Workflow_AddNote| |
|
84 |
+|Procedure|api.sp_Workflow_AddProperty| |
|
85 |
+|Procedure|api.sp_Workflow_CompleteActivity| |
|
86 |
+|Procedure|api.sp_Workflow_CreateProcess| |
|
87 |
+|Procedure|api.sp_Workflow_GetActivityActions| |
|
88 |
+|Procedure|api.sp_Workflow_GetLinkedContent| |
|
89 |
+|Procedure|api.sp_Workflow_GetNotes| |
|
90 |
+|Procedure|api.sp_Workflow_GetProcessProperties| |
|
91 |
+|Procedure|api.sp_Workflow_LinkContent| |
|
92 |
+|Procedure|api.sp_Workflow_Reallocate| |
|
93 |
+|Procedure|api.sp_Workflow_SearchActivities| |
|
94 |
+|Procedure|api.sp_Workflow_SearchProcess| |
|
95 |
+|Procedure|api.sp_Workflow_SearchStreamResources| |
|
96 |
+|Procedure|api.sp_Workflow_SearchStreams| |
|
97 |
+|Procedure|api.sp_Workflow_UpdateProperty| |
|
98 |
+|Procedure|dbo.sp_InsertImageToDocDatabase| |
|
99 |
+|Procedure|dbo.sp_MaritalStatus| |
|
100 |
+|Procedure|dbo.sp_SchedulerAddNote| |
|
101 |
+|Procedure|dbo.sp_Update_frmPeople| |
|
102 |
+|Procedure|dbo.sp_UserLevels| |
|
103 |
+|Procedure|dbo.sp_WorkflowAddNote| |
|
104 |
+|Procedure|prg.sp_ProviderParameters_select| |
|
105 |
+|Procedure|scr.sp_BankBranches_Member| |
|
106 |
+|Procedure|scr.sp_MFGMemberCFLO| |
|
107 |
+|Procedure|scr.sp_MFGMemberPaypoints| |
|
108 |
+|Procedure|scr.sp_Paypoints| |
|
109 |
+|Procedure|web.sp_UserWebLogin| |
|
110 |
+ |
|
111 |
+ |
| 28 |
28 |
|