Custom Receipt Process Guide (3E) - Persolvent · 2016. 6. 20. · Title: Microsoft Word - Custom Receipt Process Guide (3E) Author: ryanb Created Date: 9/23/2015 8:37:50 AM

ClientPay – 3E Custom Receipt

Copyright (c) 2015 Persolvent

Privileged and Confidential Information ‐ Do Not Distribute

3E Custom Receipt Process – Create guide

This guide will take you through the process of creating custom receipt processes

for both credit and trust receipts. While the pictures depict the credit receipt

modification process, they are also applicable to the trust receipt modification.

Any differences between the two will be noted in the text.




1. Open IDE (NOT STOCK ONE!!!)

2. Create new project

a. Give it name. It can be anything you like. To avoid confusion we suggest having RcptMaster

or TrustReceipt in the name, depending on which object you are modifying.

b. Set Install Type – Production




3. Find RcptMaster object or TrustReceipt object depending on what you are modifying and put it

in you project.

4. Open RcptMaster or TrustReceipt object (double click on it) and add new RELATIONSHIP

ATTRIBUTE







5. Set All Properties as shown on the image. Please note that if you choose Caption Text other

than ‘C_RouteUserRole_WLS’ you will need to change this value in the code in Step 26. This

value also needs to go in the web.config file for the ClientPay web service for the

CreditProcessName and TrustProcessName keys.

6. Add Next code to “Collection Code” Tab of the object and Save the object. This code is the same

regardless of whether you are modifying TrustReceipt or RcptMaster.

Public Enum StepResult Success Failure End Enum <NxProcessMethodAttribute()> _ Public Function InitObject As StepResult If Me.Count > 0 Then Return StepResult.Success Else Return StepResult.Failure End If End Function




7. Close object window and do a build as shown here







8. After build done ‐ close build window and click Publish All




9. Add new process item in you project a. 1 – Right click on process > “Add new process item” b. 2 ‐ Set name (C_ ‐ stays for “Custom”, _WLS – stays for signature) c. 3 ‐ Set Install Type – Production d. 4 ‐ Click OK




10. Set “Base Object ID” Property of your new process to RcptMaster or TrustReceipt object a. 1 – Click small button in “Base Object ID” field b. 2 – Find RcptMaster or TrustReceipt c. 3 – Select RcptMaster or TrustReceipt from list d. 4 – Click OK




11. Set all Other properties as shown here a. Set your Description b. Set ID c. Set Process Title (this is what user will see in 3E UI – you may want to select different names

for credit and trust receipts. The names must be different than the existing Process titles for Credit and trust receipts)

d. Select Worklist Form (similar as Step 10)




12. Set First Step as Method that you added on Step 6

Note: You should see in the list name of the method that you created in Step 6. For some reasons not all the time this method appears (some bugs in 3e…). If you see your InitObject method then all is perfect , select it. If you DON’T see it then some workaround steps will required later. Note that the listed steps in the image will be different for trust receipts.




13. After you added first step > click on it and change ID to INIT

14. Add new Rule on “SUCCESS” a. 1 – right click on “SUCCESS” b. 2 – Add New Rule




15. After you added new rule – Give it ID TRUE

16. After step TRUE add next Step to RcptMaster Page (with green plus sign)




17. Give this step ID – ENTRY

18. After ENTRY – add “Release / Cancell” Output




19. After Release Step Right click on step with “…” and add Save Step

20. Give to new step ID SAVEALL




21. After SAVEALL > SUCCESS > … ‐ add new step ReverseAndReallocate if you are modifying the credit receipt process. Skip to Step 24 if you are modifying the trust receipt process. There is no ReverseAndReallocate step for trust receipts.

22. Give it ID IfReverseReallocate




23. After IFREVERSEREALLOCATE > SUCCESS > … add new step to existing ENTRY

24. After SAVEALL > FAILURE > … add new step to existing ENTRY




25. Add END step to all uncompleted “…” Steps as here

26. Go to Code Tab at the bottom of IDE and find TRUE rule and paste this code for credit receipts:

Function Evaluate() As System.Boolean Return True End Function Public Overrides Function GetNextUser() As System.Guid If Not Me.RcptMaster.C_RouteUserRole_WLS.IsNull Then Return Me.RcptMaster.C_RouteUserRole_WLS.Value Else Return Me.User.UserID End If End Function ** Here is the code for trust receipts **: Function Evaluate() As System.Boolean Return True End Function Public Overrides Function GetNextUser() As System.Guid If Not Me.TrustReceipt.C_RouteUserRole_WLS.IsNull Then Return Me.TrustReceipt.C_RouteUserRole_WLS.Value Else Return Me.User.UserID End If




End Function




27. You should have this process at the end (Trust Receipt appears below) . Click Save and Publish All. Save your Project

Here is what the Trust Receipt flow chart should look like:




28. Add the new process you created to the security tree so that you can give users permissions to use it. First select Security Tree setup from the Select Process dropdown on the dashboard.




Next, select Add Resource and add the Process to the security tree. In this image the two processes that

were created have already been added.




If you were not able to select InitObject as First Step in your process ONLY

1. Go to Utilities3E.exe Application (it will be in the same TE_3E_SHARE folder under the same instance of 3e)

2. Go to File > Loaded Programs




3. Check AppObject XML Editor

4. Open AppObject XML Editor a. 2 – Select Custom Check Box b. 3 – Select Process in 1st dropdown c. 4 – find your process




5. Change name of the Method of First Step to InitObject a. 1 ‐ Expend Step b. 2 ‐ Find 1st Code Step c. 3 – Change Method to be InitObject

6. Hit Ctrl + S to save. You should get Success message and this popup (Click Yes in popup window)

Note: Make sure you closed your process in IDE. If you will not close it then you’ll get error message in Utilities saying something about “Process unavailable”

Documents

Custom Receipt Process Guide (3E) - Persolvent · 2016. 6. 20. · Title: Microsoft Word - Custom Receipt Process Guide (3E) Author: ryanb Created Date: 9/23/2015 8:37:50 AM