11. Application Programming Interface (API) - DBP - Designer Manual

1. 1. A Comprehensive Guide to the Digital Business Platform
2. 2. BPMS System Requirements
- 2.1. 2.1 BPMS Server Requirements
  - 2.1.1. 2.1.1 Install IIS with Required Modules
- 2.2. 2.2 BPMS Designer Machine Requirements and permissions
- 2.3. 2.3 End user browser requirements and permissions
3. 3. Installing the System
- 3.1. 3.1 Installing Modules
4. 4. Admin Console General Features
- 4.1. 4.1 Menu
- 4.2. 4.2 Application Tree
- 4.3. 4.3 Log
- 4.4. 4.4 System information
5. 5. Process
- 5.1. 5.1 Process Design
  - 5.1.1. 5.1.1 Process Design
    - 5.1.1.1. 5.1.1.1 Menu
    - 5.1.1.2. 5.1.1.2 Process toolbox
  - 5.1.2. 5.1.2 Change Process
- 5.2. 5.2 Task
- 5.3. 5.3 Event
6. 6. Forms
- 6.1. 6.1 List of forms
- 6.2. 6.2 Form Designer
- 6.3. 6.3 Form Behavior
- 6.4. 6.4 Form Categories
- 6.5. 6.5 Form Control Actions
- 6.6. 6.7 Dropdown Data Sources
- 6.7. 6.8 Quick Form
- 6.8. 6.9 Auto-Translation of a form
- 6.9. 6.10 Personalize Captions
- 6.10. 6.11 Generate Template Tags
7. 7. Business Logics
- 7.1. 7.1 Rule
- 7.2. 7.2 Action
- 7.3. 7.3 Guard
- 7.4. 7.4 General Features of Actions and Guards
- 7.5. 7.5 General Features of Edit
8. 8. Entity
- 8.1. 8.1 Create entities
  - 8.1.1. 8.1.1 Create attributes
- 8.2. 8.2 Attribute Form
- 8.3. 8.3 Diagram
  - 8.3.1. 8.3.1 General Options
- 8.4. 8.4 Key Point Indicators (KPI)
9. 9. Template
- 9.1. 9.1 Template Management
  - 9.1.1. 9.1.1 Edit and Create Templates
- 9.2. 9.2 Template Logic
  - 9.2.1. 9.2.1 Edit and define the logic of the template
10. 10. Communication
- 10.1. 10.1 Resources
  - 10.1.1. 10.1.1 Reference
  - 10.1.2. 10.1.2 Web Reference
- 10.2. 10.2 Notification
- 10.3. 10.4 Connections
11. 11. Application Programming Interface (API)
- 11.1. 11.1 Define a parameter (AddParameter)
- 11.2. 11.2 Calling a rule (CallRule)
- 11.3. 11.3 Calling Schedule Service (StartJob)
- 11.4. 11.4 Stop Scheduling (StopJob)
- 11.5. 11.5 Sum of two numbers (Arithmetic.Add)
- 11.6. 11.6 Divide two numbers (Arithmetics.Division)
- 11.7. 11.7 Multiply two numbers (Arithmetics.Multiply)
- 11.8. 11.8 Subtract two numbers (Arithmetics.Subtract)
- 11.9. 11.9 Concatenate two Strings (Concat)
- 11.10. 11.10 Search Text (Contains)
- 11.11. 11.11 Add Date (AddDate)
- 11.12. 11.12 Insert current date (CurrentDate) of the DateTime type
- 11.13. 11.13 Add time to date (CurrentDate.Add)
- 11.14. 11.14 Add Day to Date (CurrentDate.AddDays)
- 11.15. 11.15 Add hours to date (CurrentDate.AddHours)
- 11.16. 11.16 Add milliseconds to date (CurrentDate.AddMilliseconds)
- 11.17. 11.17 Add Minute to Date (CurrentDate.AddMinutes)
- 11.18. 11.18 Add months to date (CurrentDate.AddMonths)
- 11.19. 11.19 Add seconds to date (CurrentDate.AddSeconds)
- 11.20. 11.20 Add tick to date (CurrentDate.AddTicks)
- 11.21. 11.21 Add year to date (CurrentDate.AddYears)
- 11.22. 11.22 Compare current date with date (CurrentDate.CompareTo)
- 11.23. 11.23 Take a Date From (CurrentDate.Date)
- 11.24. 11.24 Getting the day out of the date (CurrentDate.Day)
- 11.25. 11.25 Take a day of week (CurrentDate.DayOfWeek)
- 11.26. 11.26 Take a few days from the date (CurrentDate.DayOfYear)
- 11.27. 11.27 Getting the time out of the current date (CurrentDate.Hour)
- 11.28. 11.28 Insert current date (CurrentMiladiDate) in decimal format
- 11.29. 11.29 Insert Current Time (CurrentTime)
- 11.30. 11.30 Difference between two dates (DateDiffGregorian)
- 11.31. 11.31 Insert Day of the Week (DayOfWeek)
- 11.32. 11.32 Convert date decimal to datetime (GetDate)
- 11.33. 11.33 Day of the week (GetDayOfWeekByDate)
- 11.34. 11.34 The day of the week (GetDayOfWeekByNumeric)
- 11.35. 11.35 Sum of 2 times (TimeAdd)
- 11.36. 11.36 Subtraction of 2 time (TimeDiff)
- 11.37. 11.37 Receive Groups (GetAllGroups)
- 11.38. 11.38 Password Comparison (CheckPassword)
- 11.39. 11.39 Assignment to User (AssignStaffToUser)
- 11.40. 11.40 Delete User Assignment (DeleteUserAssignment)
- 11.41. 11.41 Update Unit (UpdateDepartment)
- 11.42. 11.42 Update Group (UpdateGroup)
- 11.43. 11.43 Update Staff (UpdateStaff)
- 11.44. 11.44 Update User (UpdateUser)
- 11.45. 11.45 Insert member in the Group (AddMemberToGroup)
- 11.46. 11.46 Remove member from the Group (RemoveMemberofGroup)
- 11.47. 11.47 Remove User from Group (RemoveMemberOfGroup)
- 11.48. 11.48 Create or Update User (SaveUser)
- 11.49. 11.49 Create or Update an Organizational Unit (saveDepartment)
- 11.50. 11.50 Create or Update Group (saveGroup)
- 11.51. 11.51 Create or Update a Staff (saveStaff)
- 11.52. 11.52 Update User (UpdateUserWithoutPassword)
- 11.53. 11.53 Get current Manager’s ID (ManagersIdOfCurrentStaff)
- 11.54. 11.54 Get a list of current Managers (GetManagersOfCurrentStaff)
- 11.55. 11.55 Get personally identifiable information (GetPrincipal)
- 11.56. 11.56 Get admin ID (GetManager)
- 11.57. 11.57 Get started User Information (MercuryService.StarterUser)
- 11.58. 11.58 Get current User information
- 11.59. 11.59 Get the header side manager information (MercuryService.ManagerOfStarterStaff)
- 11.60. 11.60 Get Started Information (MercuryService.StarterStaff)
- 11.61. 11.61 Getting Starter Side Manager Information (MercuryService.ManagerOfCurrentStaff)
- 11.62. 11.62 Get Current Staff Information (MercuryService.CurrentStaff)
- 11.63. 11.63 Get Managers for User Positions (MercuryService.GetUserManagerByUser)
- 11.64. 11.64 Get Users admin side (MercuryService.GetUserManagerByStaff)
- 11.65. 11.65 Get Group Members (MercuryService.GetUsersByGroupCode)
- 11.66. 11.66 Receive the Organizational Unit (MercuryService.GetDepartmentByStaff)
- 11.67. 11.67 Obtaining Organizational Units for a single User (MercuryService.GetDepartmentByUser)
- 11.68. 11.68 Get the User’s positions (MercuryService.GetUserStaffs)
- 11.69. 11.69 Get the position of the top Manager of one side (MercurySide.GetManagerOfBeforeCEODepartment)
- 11.70. 11.70 Get the post of a higher-level unit manager (MercuryService.GetManagerOfUpperDepartment)
- 11.71. 11.71 Get current User units (MercuryService.CurrentUserDepartment)
- 11.72. 11.72 Get current manager User list (MercuryService.CurrentUserManager)
- 11.73. 11.73 Get current User positions (MercuryService.CurrentUserStaffs)
- 11.74. 11.74 Get Current User (MercuryService.CurrentStaff)
- 11.75. 11.75 Receive admin-side admin ID (MercuryService.GetStaffMangerByStaff)
- 11.76. 11.76 Fetch information from the database (ExecuteQuery)
- 11.77. 11.77 Fetch information from the current database (ExecuteHqlQuery)
- 11.78. 11.78 Get Objects (GetAll)
- 11.79. 11.79 Get the complete object domain (GetDomainObject)
- 11.80. 11.80 Fetch Database Information (ExecuteSqlQuery)
- 11.81. 11.81 Get all database information (ExecuteSqlQueryFromDB)
- 11.82. 11.82 General code tracking system (GenerateTracking)
- 11.83. 11.83 Get Tracking Code (GetTrackingNumber)
- 11.84. 11.84 Send Notification to User (SendByNotification)
- 11.85. 11.85 Send notification to (SendByNotification)
- 11.86. 11.86 Send notification to recipient list (SendByNotification)
- 11.87. 11.87 Send notification to recipient email list (SendByNotification)
- 11.88. 11.88 Send notification to an email (SendByNotification)
- 11.89. 11.89 Create notifications and send to recipients (Send)
- 11.90. 11.90 Create notifications and send to receiver types (Send)
- 11.91. 11.91 Create notifications and send to recipients list (Send)
- 11.92. 11.92 Create a notification and send to recipient email list (Send)
- 11.93. 11.93 Create notification and send to recipient’s email (Send)
- 11.94. 11.94 Send Transaction Type Notice (SendCopy)
- 11.95. 11.95 Event call (RaiseEvent)
- 11.96. 11.96 Call event with specified user (RaiseEvent)
- 11.97. 11.97 Start the process (StartProcess)
- 11.98. 11.98 Start process with the user and the Starter (StartProcess)
- 11.99. 11.99 Start the process automatically (StartProcessOnPersistentObject)
- 11.100. 11.100 Get an object from an entity (GetDomainObject)
- 11.101. 11.101 Create an object from an entity (CreateDomainObject)
- 11.102. 11.102 Create an object from an entity with an identifier (CreateDomainObject)
- 11.103. 11.103 Delete an object from an entity (DeleteDomainObject)
- 11.104. 11.104 Save an object from an entity (SaveDomainObject)
- 11.105. 11.105 Save an object from an object (SaveObject)
- 11.106. 11.106 Get objects of an entity (GetAll)
- 11.107. 11.107 Get Parents Object (GetParentObject)
- 11.108. 11.108 Changing information in the database (CommitTransaction)
- 11.109. 11.109 Get the file from the attachment control (GetFileFromControl)
- 11.110. 11.110 Get the file from the attachment control (GetFile)
- 11.111. 11.111 Search the folder named (GetFolderDefaultForAttachment)
- 11.112. 11.112 Search the folder with the name and id (GetFolderByNameAndParentId)
- 11.113. 11.113 Create folder with name and id (CreateFolderSerialize)
- 11.114. 11.114 Create folder with name and id (CreateFolderSerialize)
- 11.115. 11.115 Get the children of a node (GetAllTreeNodeFromChildObject)
- 11.116. 11.116 Get the children of root (GetAllTreeNodeFromRootObject)
- 11.117. 11.117 Get Tree Roots (GetParentsNode)
- 11.118. 11.118 Get root tree with child object (GetRootObject)
- 11.119. 11.119 Read from excel (ReadOfExcel)
- 11.120. 11.120 Open File or Print (GetWordFormat)
- 11.121. 11.121 Call Web Service Connection (InvokeBPMSService)
- 11.122. 11.122 Calling the Web Service Connection with XMM (InvokeBPMSService)
- 11.123. 11.123 Calling the Web Service with the User and the User (InvokeBPMSService)
- 11.124. 11.124 Calling the Web service with the user and the XML (InvokeBPMSService)
- 11.125. 11.125 X-MEL split into distinct attributes (XmlToProperties)
- 11.126. 11.126 Convert Dictionary to XMM Format (PropertiesToXml)
- 11.127. 11.127 Code Environment
- 11.128. 11.128 Design Environment
12. 12. Business Logic API
- 12.1. 12.1 Reservation Word
- 12.2. 12.2 HQL
- 12.3. 12.3 SQL
- 12.4. 12.4 User
- 12.5. 12.5 Rule
- 12.6. 12.6 Process
- 12.7. 12.7 Domain
- 12.8. 12.8 Task
- 12.9. 12.9 TimeEvent
- 12.10. 12.10 Notification
- 12.11. 12.11 Tracking
- 12.12. 12.12 DataSource
- 12.13. 12.13 DateTime
- 12.14. 12.14 Math
- 12.15. 12.15 Text
- 12.16. 12.16 Point
13. 13. Attachments
- 13.1. 13.1 Microsoft IIS 6 SSL Compatibility Components
- 13.2. 13.2 Setting Permission For sharing BPMApp Folder.
- 13.3. 13.3 MSDTC Services
  - 13.3.1. 13.3.1 Introduction
  - 13.3.2. 13.3.2 Steps to Configure MSDTC Services
- 13.4. 13.4 Externalizing the web form
14. 14. Troubleshooting
- 14.1. 14.1 This configuration section cannot be used at this path
- 14.2. 14.2 Access to the path ‘Rayvarz\BPMS\Temp’ is denied
- 14.3. 14.3 Not able to access temp files by visual studio
- 14.4. 14.4 Error in saving web form when there is an attachment
- 14.5. 14.5 “Invalid Data” Error on deploy any BPM Application

11.1. 11.1 Define a parameter (AddParameter)

APIs are integrated simply and efficiently within the Digital Business Platform.

API insertion is possible in both “code” and “design” methods; insert types of commands in both design and code environments.

10.3.4. 10.4.4 Access

11.1. 11.1 Define a parameter (AddParameter)

11. 11. Application Programming Interface (API)