Application - com.hornbill.servicemanager
Entities
The following entities are defined for this applicationAccountStatus
There are no operations or events defined for the 'AccountStatus' entity.
Achievement
The following operations are defined for the 'Achievement' entity.
| Operation | Description |
|---|---|
| addAchievement | For internal use only - This flowcode operation awards an achievement to the specified user. |
AchievementImage
There are no operations or events defined for the 'AchievementImage' entity.
Assessment
The following operations are defined for the 'Assessment' entity.
| Operation | Description |
|---|---|
| getAssessment | Load questions and answers for an assessment |
AssessmentAnswers
There are no operations or events defined for the 'AssessmentAnswers' entity.
AssessmentQuestions
There are no operations or events defined for the 'AssessmentQuestions' entity.
AssessmentTypes
There are no operations or events defined for the 'AssessmentTypes' entity.
Asset
The following operations are defined for the 'Asset' entity.
| Operation | Description |
|---|---|
| addAsset | This flowcode operation is a component operation for the following flowcodes: addAssetComputer, addAssetComputerPeripheral, addAssetMobileDevice, addAssetNetworkDevice, addAssetPrinter, addAssetSoftware, addAssetTelecoms. |
| deleteAsset | This flowcode oepration deletes an asset from the system. |
| deleteAssets | Delete a list of Assets |
| getImageInfo | This flowcode load the info related to the asset image. If the asset has no image then return the info for the relevant asset type |
| linkAsset | This flowcode operation links an asset to another asset, request or other system entity. |
| linkAssets | This flowcode operation links an asset to another asset, request or other system entity. |
| loadAssetData | This flowcode load the asset data stored in the DB |
| loadLinkedEntities | This flowcode load the entities linked to the asset and their count |
| loadOptions | This flowcode loads the basic information required for the asset form, including the list of possible countries |
| searchAssetGlobal | Intended to be used by the global search feature in Collaboration. Each asset classes is searched in order to find the best results. |
| unlinkAsset | This flowcode operation unlinks an asset from another asset, request or other system entity. |
| updateAsset | This flowcode operation is a component operation for the following flowcodes: updateAssetComputer, updateAssetComputerPeripheral, updateAssetMobileDevice, updateAssetNetworkDevice, updateAssetPrinter, updateAssetSoftware, updateAssetTelecoms. |
AssetsBasic
The following operations are defined for the 'AssetsBasic' entity.
| Operation | Description |
|---|---|
| addAssetBasic | This flowcode operation creates an asset of class 'AssetSoftware'. |
| updateAssetBasic | This flowcode operation updates an asset of class 'AssetSoftware'. |
AssetsComputer
The following operations are defined for the 'AssetsComputer' entity.
| Operation | Description |
|---|---|
| addAssetComputer | This flowcode operation creates an asset of class 'AssetComputer'. |
| updateAssetComputer | This flowcode operation updates an asset of class 'AssetComputer'. |
AssetsComputerPeripheral
The following operations are defined for the 'AssetsComputerPeripheral' entity.
| Operation | Description |
|---|---|
| addAssetComputerPeripheral | This flowcode operation creates an asset of class 'AssetComputerPeripheral'. |
| updateAssetComputerPeripheral | This flowcode operation updates an asset of class 'AssetComputerPeripheral'. |
AssetsLinks
There are no operations or events defined for the 'AssetsLinks' entity.
AssetsMobileDevice
The following operations are defined for the 'AssetsMobileDevice' entity.
| Operation | Description |
|---|---|
| addAssetMobileDevice | This flowcode operation creates an asset of class 'AssetMobileDevice'. |
| updateAssetMobileDevice | This flowcode operation updates an asset of class 'AssetMobileDevice'. |
AssetsNetworkDevice
The following operations are defined for the 'AssetsNetworkDevice' entity.
| Operation | Description |
|---|---|
| addAssetNetworkDevice | This flowcode operation creates an asset of class 'AssetNetworkDevice'. |
| updateAssetNetworkDevice | This flowcode operation updates an asset of class 'AssetNetworkDevice'. |
AssetsPrinter
The following operations are defined for the 'AssetsPrinter' entity.
| Operation | Description |
|---|---|
| addAssetPrinter | This flowcode operation creates an asset of class 'AssetPrinter'. |
| updateAssetPrinter | This flowcode operation updates an asset of class 'AssetPrinter'. |
AssetsSoftware
The following operations are defined for the 'AssetsSoftware' entity.
| Operation | Description |
|---|---|
| addAssetSoftware | This flowcode operation creates an asset of class 'AssetSoftware'. |
| updateAssetSoftware | This flowcode operation updates an asset of class 'AssetSoftware'. |
AssetsTelecoms
The following operations are defined for the 'AssetsTelecoms' entity.
| Operation | Description |
|---|---|
| addAssetTelecoms | This flowcode operation creates an asset of class 'AssetTelecoms'. |
| updateAssetTelecoms | This flowcode operation updates an asset of class 'AssetTelecoms'. |
AssetsTypes
The following operations are defined for the 'AssetsTypes' entity.
| Operation | Description |
|---|---|
| addType | This flowcode operation adds a new asset type. If an asset type with same name in the same class already exists then return an error message. |
| deleteType | This flowcode operation deletes an asset type. If there are assets or requests currently associated with the asset type then teh system will not be able to delete it. |
| getImageInfo | This flowcode load the info related to the asset image. If the asset has no image then return the info for the relevant asset type |
| getTableMetaData | This flowcode operation returns a list of common and extended detail asset properties. |
| updateType | This flowcode operation updates an existing asset type. If an asset type with same name in the same class already exists then return an error message. |
AssetSubstate
The following operations are defined for the 'AssetSubstate' entity.
| Operation | Description |
|---|---|
| createAssetSubstate | Create an Asset Substate |
| deleteAssetSubstate | Delete a Product |
| getSubstatesMap | This flowcode return the asset substates gruped by stateID |
| updateAssetSubstate | Update the information for a substate |
Attachment
The following operations are defined for the 'Attachment' entity.
| Operation | Description |
|---|---|
| addAttachmentToEntity | Add an attachment to an entity |
| removeAttachmentFromEntity | Remove an attachment from an entity |
BoardCards
The following operations are defined for the 'BoardCards' entity.
| Operation | Description |
|---|---|
| moveCard | This operation allows you to move a card to a new position within a list, or a position in another list, on a board |
| smAddCard | FlowCode that will add a comment to the top of the board list. |
| smAddCommentCard | FlowCode that will add a comment to the top of the board list. |
| smArchiveCard | Archive a card from a board |
| smEditCommentCard | FlowCode that will add a comment to the top of the board list. |
| smMoveCard | Move cards on a board |
BoardMembers
The following operations are defined for the 'BoardMembers' entity.
| Operation | Description |
|---|---|
| browse | This returns a set of records |
| create | This associates an entity to a board |
| delete | This will remove the board member record |
| update | This will update the membership record with new can modify value |
Boards
The following operations are defined for the 'Boards' entity.
| Operation | Description |
|---|---|
| addBoardComment | This operation allows you to add a comment onto a board |
| addBoardRequest | This operation allows you to add a request onto a board |
| addCardToBoard | This flowcode is responsible for adding either single or multiple Requests to a specific Board. It handles the addition, un-archiving and the detection of cards assigned to a particular board. |
| removeCardFromBoard | This flowcode is responsible is responisble for deleting (archiving) a particular card in a board |
| smAddListToBoard | This flowcode is responsible for adding a new List to a specific Board |
| smBoardLogs | Flowcode to get the total count of board card logs and display boards logs in sets of 10 |
| smDeleteList | This flowcode is responsible for deleting a specific List from a specific Board |
| smEditList | This flowcode is responsible for editing the List of a specified Board |
| smGetBoardItems | This flowcode is responsible for getting all the Board Data items for the currently selected Board |
| smGetUserBoards | This flowcode returns the list of boards, and whether the user has right to edit |
Bookmark
There are no operations or events defined for the 'Bookmark' entity.
BookmarkCategory
There are no operations or events defined for the 'BookmarkCategory' entity.
BookmarkHistory
There are no operations or events defined for the 'BookmarkHistory' entity.
Catalogs
The following operations are defined for the 'Catalogs' entity.
| Operation | Description |
|---|---|
| delete | This operation deletes a Catalog and it's associated translations. |
| getCatalogs | This operation returns the Catalogs against a particular Service. |
| getCurrentProgressiveCapture | This flowcode is repsonsible for getting the current Progressive Capture data |
| getVisibleCatalogs | This operation returns the Catalogs against a particular Service that are configured to be visible by Request Type. This operation is intended for the User App. |
| reorderCatalogs | This flowcode is responsible for re-arranging the Catalogs according to their specified Request Type |
| selfserviceGetVisibleCatalogs | This operation returns the Catalogs against a particular Service that are configured to be visible by Request Type. This operation is intended for the Portals. |
CatalogSubscriptionExclusions
The following operations are defined for the 'CatalogSubscriptionExclusions' entity.
| Operation | Description |
|---|---|
| catalogSubscriptionGet | This operation returns a list of a Catalog's subscribers. |
| excludeAll | This operation excludes all subscribers of a Service from a Catalog. |
| manage | This operation allows a Service user to control a Service subscriber's subscription to a Catalog. |
| revert | This operation reverts a Catalog's subscription back to mirror the Service's subscription (i.e. removes all exclusions). |
ChangeRequests
The following operations are defined for the 'ChangeRequests' entity.
| Operation | Description |
|---|---|
| logChangeRequest | This flowcode operation logs a Change Request using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the change before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided. |
| schedule | Schedule a Change Request |
| unSchedule | Operation to unschedule the Change request |
Charts
The following operations are defined for the 'Charts' entity.
| Operation | Description |
|---|---|
| smReorderCharts | Re-order your Service Manager dashboard charts |
Colleagues
The following operations are defined for the 'Colleagues' entity.
| Operation | Description |
|---|---|
| getColleagueManager | This operation returns Id of a colleague's manager. |
Contact
The following operations are defined for the 'Contact' entity.
| Operation | Description |
|---|---|
| GetContainerId | Get the container id (Organisation) for the specified contact. |
| addContact | DEPRECATED (use addContactNew) |
| addContact3 | For internal use only - Add a New Contact This version 3 uses Organisation instead of container but still updates the containers data structure |
| addContact4 | For internal use only - Add a New Contact |
| addContactNew | For internal use only - Add a New Contact |
| archiveContact | For internal use only - This flowcode is responsible for accepting one or more contactIds and changing their status from active to archived |
| changeOrg | For internal use only - Change the Contact's Organisation |
| guestUpdateProfile | This flowcode allows an authorised guest to update only there own contact record |
| removeOrg | For internal use only - Remove the Contact's Organisation |
| sendSystemNotification | Send notification to user |
| unarchiveContact | Updates the status of teh contact to be Active. Note that if the contact had access to the portal, this will not enable back to that state. |
| updateContact | DEPRECATED (Use updateContactNew) |
| updateContact3 | For internal use only - Update Contact |
| updateContact4 | For internal use only - Update Contact |
| updateContactNew | DEPRECATED - Use updateContact3 or changeOrg instead - For internal use only - Update Contact |
Contact_extra
There are no operations or events defined for the 'Contact_extra' entity.
Contact_notes
There are no operations or events defined for the 'Contact_notes' entity.
ContactAccess
There are no operations or events defined for the 'ContactAccess' entity.
ContactOrgRequests
The following operations are defined for the 'ContactOrgRequests' entity.
| Operation | Description |
|---|---|
| changeCancelRequestSetting | Create or change the cancellation request permission for Contacts |
| changeOrgRequestSetting | Create a connection record |
Container
The following operations are defined for the 'Container' entity.
| Operation | Description |
|---|---|
| addChild | For internal use only |
| addContainer | This is the description text for this flowcode operation |
| getChildren | This is the description text for this flowcode operation |
| getChildrenCount | This is the description text for this flowcode operation |
| getContainer | For internal use only |
| getRelatedContainers | This is the description text for this flowcode operation |
| removeChild | This is the description text for this flowcode operation |
| removeContainer | This is the description text for this flowcode operation |
| removePermission | This is the description text for this flowcode operation |
| setPermission | This is the description text for this flowcode operation |
| updateContainer | This is the description text for this flowcode operation |
ContainerPermissions
There are no operations or events defined for the 'ContainerPermissions' entity.
ContainerType
There are no operations or events defined for the 'ContainerType' entity.
Country
There are no operations or events defined for the 'Country' entity.
CustomList
There are no operations or events defined for the 'CustomList' entity.
EntityAttachments
The following operations are defined for the 'EntityAttachments' entity.
| Operation | Description |
|---|---|
| attachFile | Attach a file to the EntityAttachments |
| removeAttachment | Remove an attachment from the case |
| updateDescription | Update description of attachments |
Faqs
The following operations are defined for the 'Faqs' entity.
| Operation | Description |
|---|---|
| deleteFaq | This flowcode is responsible for deleting either a particular FAQ translation of a particular FAQ or the entire FAQ and all its translations |
| getFaqs | This operation returns the Faqs that belong to a Service. |
| updateFaqViewCount | This flowcode is responsible for updating the particular FAQ View Count |
FaqsFeedback
The following operations are defined for the 'FaqsFeedback' entity.
| Operation | Description |
|---|---|
| faqFeedback | This flowcode is responsible for updating a particular FAQs feedback i.e. Liking, Disliking or removing your Feedback |
Favorite
There are no operations or events defined for the 'Favorite' entity.
GenericFilter
The following operations are defined for the 'GenericFilter' entity.
| Operation | Description |
|---|---|
| smDeleteFilter | Delete a View |
| smGetCustomFilters | Get a list of Views for a user |
| smGetCustomFilters2 | Get a list of Views for a user |
Groups
There are no operations or events defined for the 'Groups' entity.
Impact
There are no operations or events defined for the 'Impact' entity.
Imports
There are no operations or events defined for the 'Imports' entity.
ImportsHistory
There are no operations or events defined for the 'ImportsHistory' entity.
Incidents
The following operations are defined for the 'Incidents' entity.
| Operation | Description |
|---|---|
| logIncident | This flowcode operation logs an Incident using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the incident before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided. |
| selfserviceLogIncident | This flowcode operation logs an Incident using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the incident before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided. |
| update | This flowcode update a request attachment |
KnownErrors
The following operations are defined for the 'KnownErrors' entity.
| Operation | Description |
|---|---|
| logKnownError | This flowcode operation logs a Known Error using the provided parameters. Firstly it calls the component flowcode operation logRequest to log the incident before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided. |
Location
There are no operations or events defined for the 'Location' entity.
MessageClientTemplate
The following operations are defined for the 'MessageClientTemplate' entity.
| Operation | Description |
|---|---|
| add | Add Template |
| delete | Delete a template includding shared records |
| get | Returns a template based on an ID |
| update | Update Template |
MessageClientTemplateShare
The following operations are defined for the 'MessageClientTemplateShare' entity.
| Operation | Description |
|---|---|
| add | Add Shares to the template |
| addOrUpdate | Adds or Updates a sharing to a template. This asumes the sharing is one only for each template. Will replace if exists and if is "personal" it will remove the sharing record |
OrganizationContacts
There are no operations or events defined for the 'OrganizationContacts' entity.
Organizations
The following operations are defined for the 'Organizations' entity.
| Operation | Description |
|---|---|
| addToTimeline | Add to Org Timeline |
| archive | For internal use only - Archive an Organisation. If it has an activity stream, will post to the timeline. |
| unArchive | For internal use only - UnArchive an Organisation. If it has an activity stream, will post to the timeline. |
Priority
The following operations are defined for the 'Priority' entity.
| Operation | Description |
|---|---|
| addPriority | This operation adds a new Priority record. |
| calculatePriorityFromMatrix | This flowcode uses the supplied Impact and Urgency parameters to calculate the Priority based on the Priority Matrix. |
| deletePriority | This operation will delete a Priority record along with it's related records such as Timers. |
| smMovePriority | This flowcode operation updates the Priority order numbers of priorities in the system when they have been moved or re-ordered |
PriorityTimerEvents
There are no operations or events defined for the 'PriorityTimerEvents' entity.
PriorityTimers
The following operations are defined for the 'PriorityTimers' entity.
| Operation | Description |
|---|---|
| addTimer | Create a Timer associated to a priority |
Problems
The following operations are defined for the 'Problems' entity.
| Operation | Description |
|---|---|
| logProblem | This flowcode operation logs a Problem using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the problem before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided. |
| update | This flowcode update a request attachment |
ProCapCustomQuestion
The following operations are defined for the 'ProCapCustomQuestion' entity.
| Operation | Description |
|---|---|
| add_json | Add progressive capture custom questions with answers |
Products
The following operations are defined for the 'Products' entity.
| Operation | Description |
|---|---|
| addProduct | Create a Product |
| deleteProduct | Delete a Product |
| updateProduct | Update the information for a Product |
ProfileConnections
There are no operations or events defined for the 'ProfileConnections' entity.
ProfileContacts
There are no operations or events defined for the 'ProfileContacts' entity.
ProfileContactTypes
There are no operations or events defined for the 'ProfileContactTypes' entity.
Profiles
There are no operations or events defined for the 'Profiles' entity.
ProfileStatus
There are no operations or events defined for the 'ProfileStatus' entity.
ProgressiveCapture
The following operations are defined for the 'ProgressiveCapture' entity.
| Operation | Description |
|---|---|
| getAssetSites | This flowcode operation gets details of all sites that are associatd to the specified asset(s) based on the search criteria provided. |
| getCustomerSite | This flowcode operation gets details of the specified customer's site. |
| getSites | This flowcode operation gets details of all sites based on the search criteria provided. |
| getUserCompanySites | This flowcode operation gets details of all sites for all companies for the specified user based on the search criteria provided. |
PublishedRequests
The following operations are defined for the 'PublishedRequests' entity.
| Operation | Description |
|---|---|
| retirePublishedRequest | This flowcode is responsible for setting the status of a Published Request to 'draft' when a request is either cancelled or closed |
| updatePublishedRequestWorkaround | This flowcode is responsible for updating the Published Request's workaround when the workaround is either edited or deleted |
Questions
The following operations are defined for the 'Questions' entity.
| Operation | Description |
|---|---|
| queryExec | This flowcode return a request's connection |
| translate | This flowcode is reponsible for translating question and answers in the current session language |
RelatedContainer
There are no operations or events defined for the 'RelatedContainer' entity.
RelatedRequests
There are no operations or events defined for the 'RelatedRequests' entity.
RelationshipEntities
The following operations are defined for the 'RelationshipEntities' entity.
| Operation | Description |
|---|---|
| add | This flowcode link one entity to a number of other entities by using the relationship link passed in input |
| delete | This flowcode link one entity to a number of other entities by using the relationship link passed in input |
| deleteEntity | Delete a single entity from the table RelationshipEntities |
| update | This flowcode link one entity to a number of other entities by using the relationship link passed in input |
| updateTimeline | This flowcode update an entity timeline. At the moment only Requests and Asset are supported. |
RelationshipLinks
The following operations are defined for the 'RelationshipLinks' entity.
| Operation | Description |
|---|---|
| add | This operation creates a Relationship Link. A Relationship Link consists of two Relationship Types. |
| delete | This operation deletes a Relationship Link, if it is not in use by one or more Relationship Entities. |
| deleteAll | This operation deletes one or more Relationship Link. |
| update | This operation updates an existing Relationship Link. |
RelationshipTypes
The following operations are defined for the 'RelationshipTypes' entity.
| Operation | Description |
|---|---|
| delete | This operation deletes a Relationship Type, if it is not in use by one or more Relationship Links. |
Releases
The following operations are defined for the 'Releases' entity.
| Operation | Description |
|---|---|
| logRelease | This flowcode operation logs a Release using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the release before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided. |
| schedule | Schedule a Release |
| unSchedule | Operation to unschedule the Release |
ReportCategories
The following operations are defined for the 'ReportCategories' entity.
| Operation | Description |
|---|---|
| getReportCategories | This flowcode operation gets details of all report categories. |
| getReportCategory | This flowcode operation gets details of the specified report category along with details of all reports that match the search criteria within that category. |
ReportFavourites
The following operations are defined for the 'ReportFavourites' entity.
| Operation | Description |
|---|---|
| favouriteReport | This flowcode operation favourites the specified report for the user invoking the action. |
| getFavouriteReports | This flowcode operation gets details of the user's favourite reports, based on the search criteria provided. |
| unfavouriteReport | This flowcode operation unfavourites the specified report for the user invoking the action. |
ReportHistory
The following operations are defined for the 'ReportHistory' entity.
| Operation | Description |
|---|---|
| add | This flowcode adds a record in the history table for reports (h_sm_reports_history) |
| addDocumentRevision | This flowcode updates historic report run records with the correct document ID and revision |
ReportInstances
The following operations are defined for the 'ReportInstances' entity.
| Operation | Description |
|---|---|
| getReportInstances | This flowcode operation gets details of the user's report instances, based on the search criteria provided. |
Reports
The following operations are defined for the 'Reports' entity.
| Operation | Description |
|---|---|
| getRecentReports | This flowcode operation gets details of the most recently run reports, based on the search criteria provided. |
| getReport | This flowcode operation gets details of the specified report. |
ReportSchedule
The following operations are defined for the 'ReportSchedule' entity.
| Operation | Description |
|---|---|
| create | Create a schedule for the report to be run |
| delete | Removes the scheduled job, report configuration, and sm schedule info |
| getSchedule | This returns the schedule information for the report/instance for the user |
| run | Run the scheduled flowcode, and save PDF in DM if required, and send PDF via email if allowed |
| update | Update the scheduled job |
RequestApprovers
The following operations are defined for the 'RequestApprovers' entity.
| Operation | Description |
|---|---|
| update | This operation can be used to update a Request's Approvers record. This includes removing, adding or confirming an Authorisers List. |
RequestAssessments
The following operations are defined for the 'RequestAssessments' entity.
| Operation | Description |
|---|---|
| create | This operation creates an empty request assessment (e.g. an impact assessment) record ready for completion |
| get | This flowcode load the assessment for a request |
| update | This operation updates a request assessment (e.g. an impact assessment) record with the answers and outcome of the assessment |
RequestAttachments
The following operations are defined for the 'RequestAttachments' entity.
| Operation | Description |
|---|---|
| add | Takes a JSON string of attachments that already exist on the server and apply these to a request |
| delete | This flowcode delete a request attachment |
| read | This operation returns request attachment data for a specific request |
| update | This flowcode update a request attachment |
RequestBPMEvt
The following operations are defined for the 'RequestBPMEvt' entity.
| Operation | Description |
|---|---|
| addEvent | This operation creates a BPM event for a Request. |
RequestConnections
The following operations are defined for the 'RequestConnections' entity.
| Operation | Description |
|---|---|
| addConnections | This operation add one or more Connections to a Request. |
| queryExec | This flowcode return a request's connection |
| removeConnection | This operation removes a Connection from a Request. |
RequestFeedback
The following operations are defined for the 'RequestFeedback' entity.
| Operation | Description |
|---|---|
| addFeedbackTimer | This operation creates a feedback timer for a Request. If a feedback timer for the Request already exists, the Id is returned. |
| deleteFeedbackTimer | This flowcode for delete feedback timer |
| queryExec | This flowcode return a request's connection |
| timerEventFeedbackExpired | This flowcode used for global timer event (OnTimerEvent) |
RequestHistoricEmail
There are no operations or events defined for the 'RequestHistoricEmail' entity.
RequestHistoricUpdateAttachments
There are no operations or events defined for the 'RequestHistoricUpdateAttachments' entity.
RequestHistoricUpdates
The following operations are defined for the 'RequestHistoricUpdates' entity.
| Operation | Description |
|---|---|
| read | This operation returns request historic update data for a specific request |
RequestLastActivity
There are no operations or events defined for the 'RequestLastActivity' entity.
RequestMembers
The following operations are defined for the 'RequestMembers' entity.
| Operation | Description |
|---|---|
| addRequestMember | This operation associates one or more members to a Request. |
| removeRequestMember | This operation removes one or more members from a Request. |
Requests
The following operations are defined for the 'Requests' entity.
| Operation | Description |
|---|---|
| BPMEventProcess | This operation processes a BPM event, which signals the closing of a request. |
| SLMEventProcess | This flowcode is called from a request timer escalation event to determine which escalation actions need to be performed (email/assignment/priority increase etc) and call the appropriate flowcodes to perform each of those actions |
| SLMEventProcessAssign | Called from the SLMEventProcess flowcode, this flowcode will assign a request to the specified group and/or analyst and return the assignment description which can be used for timeline entries |
| SLMEventProcessBMBoard | Called from the SLMEventProcess flowcode, this flowcode will assign a request to the specified group and/or analyst and return the assignment description which can be used for timeline entries |
| SLMEventProcessBoard | Called from the SLMEventProcess flowcode, this flowcode will assign a request to the specified group and/or analyst and return the assignment description which can be used for timeline entries |
| SLMEventProcessEmail | Called from the SLMEventProcess flowcode, this flowcode will email notification of the request escalation to the appropriate request owner/manager and return a description of those emailed which can be used for timeline entries |
| SLMEventProcessPriority | This flowcode handles the increase of request priority as called from priority events |
| addIndexDocument | This flowcode will create a new index document in either the HornbillITSMHistoric or HornbillITSMTimeline index |
| addQuestions | This operation allows you to add questations |
| addRequestFeedback | Add customer feedback for reqeust |
| allowTaskCompletion | This operation determines if a User is allowed to action on a Task. This will be used by 'OnAllowTaskActionOverride' Entity system event. |
| applyEmail | This flowcode operation applies an email's contents to a request's timeline. If content is supplied, that is used. If only the emailId is supplied, then there will be a lookup to get the email's contents, including any email attachments. |
| assign | This operation assigns a Request to a team or a team member. |
| attachFileFromServer | This attaches a file from the server to a request |
| attachFileFromSession | Attach a file from the current session |
| attachFilesFromServer | This attaches a file from the server to a request |
| attachFilesFromSession | Attach a file from the current session |
| canAccessRequest | This operation checks if the logged-on user is allowed to access a Request. |
| cancelRequest | This operation cancels a Request. |
| changeCustomer | This operation updates the Customer section against a request. |
| closeRequest | This operation updates the status of a Request to closed. |
| createCallBack | This flowcode operation creates a callback on a scheduled date and time for a Request, where required. |
| emailRequestResolution | This operation sends an email to the customer of a Request, containing the resolution details of a Request. It uses the template that is configured in app.email.template.request.resolutionDetails Application Setting. |
| escalateRequest | This operation escalates a Request with a new Priority. |
| getActivityStreamAccessToken | This operation returns the details of a Request. This includes a count of data for each expandable section within a Request. |
| getOwnershipDetails | This flowcode return a request's connection |
| getRequestRecord | This operation returns the details of a Request and , optionally, the related entities |
| getVisibilityLevel | This flowcode operation checks the logged in user's status (guest/owner/team member/request member/follower/customer/public) against a specific request and returns the corresponding system visibility. |
| guestAttachFile | Allow a trusted guest to attach a file to a request. DEPRECATED - Use selfserviceAttachFileFromSession instead. |
| guestAttachFileFromSession | This flowcode operation attaches a file to a request from a guest session. DEPRECATED - Use selfserviceAttachFileFromSession instead. |
| guestCanViewRequest | DEPRECATED - use selfserviceCheckRequestVisibleToUser instead. This flowcode operation determines a guest's rights to view and edit a request. |
| guestGetFeedbackTimer | This flowcode return a request's connection |
| guestGetFileAttachmentInfo | This operation is now deprecated. Please use "selfserviceGetAttachmentInfo" operation instead. |
| guestGetTimelineAccessToken | This flowcode operation gets the request access token for the specified request. |
| guestLogRequest | DEPRECATED - use selfserviceLogRequest instead. This Flowcode logs a Request on behalf of a guest contact using the provided parameters. It updates the Request Timeline and spawns a BPM Process if a Service ID is provided. |
| holdRequest | This flowcode places a request On Hold and pause any Timers that are associated. |
| holdRequestTimer | Pause the Request timer(s) |
| linkRequests | This operation is now deprecated. Please use "add" operation in "RelationshipEntities" Entity instead. |
| logRequest | This flowcode operation is a component operation for the following flowcodes: logIncident, logServiceRequest, logProblem, logRelease and logChangeRequest. It handles all of the common components for logging any type of request by evaluating optional progressive capture forms such as team, category and priority before logging the request. Once the request is logged it assoicates any members (if required) and also links the new request to additional requests (again if required). |
| logRequest2 | This flowcode operation is a component operation for the following flowcodes: logIncident, logServiceRequest, logProblem, logRelease and logChangeRequest. It handles all of the common components for logging any type of request by evaluating optional progressive capture forms such as team, category and priority before logging the request. Once the request is logged it assoicates any members (if required) and also links the new request to additional requests (again if required). |
| logRequestBPM | This flowcode operation spawns a Bpm Process using the supplied Request and Service Id's. |
| lookupCustomerEmail | This operation is now deprecated. Please use "userProfileGet" mathod in "session" service instead. |
| markFix | Mark the Resolution/Fix timer |
| markResponse | Mark the response timer |
| markTimerMissed | This marks a request as having missed its timer |
| onTimelineUpdate | This flowcode should be called whenever a timeline update post or comment is performed against a request timeline, and will add a document for the update to the HornbillITSMTimeline index. |
| rejectFeedback | This updates the request removing the feedback |
| removeAttachments | This flowcode deletes attachments from a specified request. |
| removeTimers | This flowcode script will remove the timers - including system timers - associated with a request |
| reopenRequest | This flowcode will attempt to reopen the request, checking whether it is currently resolved/closed first, increasing the reopen count and updating the request |
| resolveLinkedRequest | This operation provides configurable options to resolve Linked Requests in a Request. |
| resolveRequest | This flowcode will attempt to resolve the request, checking whether activities need to be resolved first, marking fix times, and attempting to resume the BPM |
| searchHistoricUpdates | This flowcode operation searches request historic updates for the lucene search query provided. |
| searchRequests | This flowcode operation searches requests for the search query provided. |
| searchTimeline | This flowcode operation searches request historic updates for the lucene search query provided. |
| selfserviceAttachFileFromSession | This flowcode operation attaches a file to a request. |
| selfserviceCancelRequest | This operation updates the status of a Service Request to Cancelled for a selfservice user, and cancels any associated workflow and activities. |
| selfserviceCheckRequestVisibleToUser | This operation checks if a Portal user can view the details of a Request. |
| selfserviceCloseRequest | This operation updates the status of a Request to closed for a selfservice user. |
| selfserviceGetAssetsList | This flowcode returns asset information for use in the portals progressive capture asset form |
| selfserviceGetAttachmentInfo | This operation provides you with information on a file attachment that is associated to a Request. This operation is only for the Portals. |
| selfserviceGetTimelineAccessToken | This flowcode operation gets the request access token for the specified request. |
| selfserviceLogRequest | This flowcode operation logs an Incident using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the incident before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided. |
| selfserviceMarkUnread | This operation marks a Request as unread for Self Service users. |
| selfserviceReopenRequest | This flowcode will attempt to reopen the request, checking whether it is currently resolved/closed first, increasing the reopen count and updating the request |
| selfserviceRequestLastModified | This flowcode is responsible for updating the last modified date for a specific request |
| selfserviceSmGetAssetTypes | This flowcode operation gets the linked asset types for a specified request. |
| selfserviceSmGetAssets | This flowcode operation gets the linked attachments for a specified request. |
| selfserviceSmGetAttachments | This flowcode operation gets the linked attachments for a specified request. |
| selfserviceSmGetDetails | This flowcode operation gets the request details and all related request details for a specified request. |
| selfserviceSmGetReqDetails | This flowcode operation gets the request details and all related request details for a specified request. |
| selfserviceSmUpdateStatus | This flowcode is used to update the request status from a customer update |
| selfserviceUpdateTimeline | Posts to the activity stream |
| sendMessage | This is a defunct email flowcode - smSendMessage should be used. |
| setupRequestStageExpiry | This operation prepares the expiry of a BPM stage for a given period of time. |
| smGetAssetTypes | This flowcode operation gets the linked asset types for a specified request. |
| smGetAssets | This flowcode operation gets the linked attachments for a specified request. |
| smGetAttachments | This operation returns the attachments for a Request. |
| smGetDetails | This flowcode operation gets the request details and all related request details for a specified request. |
| smGetFullActivityStream | This flowcode operation gets the activity stream for a specified request. |
| smGetLinkedReq | This flowcode operation gets the linked request details for a specified request. |
| smGetReqBoards | This flowcode return a request's connection |
| smGetReqDetails | This operation is now deprecated. Please use "smGetReqDetails" operation intead. |
| smGetReqDetails2 | This operation returns the details of a Request. This includes a count of data for each expandable section within a Request. |
| smGetReqEntitiesOwners | This operation returns the owners of a Request's entities. These entities include Request's Service owner, Linked Services owners and Linked Assets Owners where available. |
| smGetRequests | Returns the total request count matching the supplied filter criteria and a limited number of request results |
| smGetTeamsUserSupportsRequestWith | Return a list of teams that the user is a member of, that are supporting this request |
| smNotification | This operation sends Hornbill and/or email notification for Service Manager features. |
| smNotificationAssignment | This flowcode operation notifies the owner of the request that the request has been assigned to them via both Hornbill and email notifications. |
| smNotificationAssignmentTeam | This flowcode operation notifies the team members of the team that the request has been assigned to via both Hornbill and email notifications. |
| smNotificationAutoresponder | This flowcode operation notifies the owner of the request that a new request has been logged or an existing request has been updated by email via both Hornbill and email notifications. |
| smNotificationAutoresponderTeam | This flowcode operation notifies the team members of the team that is assigned to the request that a new request has been logged or an existing request has been updated by email via both Hornbill and email notifications. |
| smNotificationCancel | This flowcode operation notifies the owner of the request that the request has been cancelled, via both Hornbill and email notifications. |
| smNotificationCancelTeam | This flowcode operation notifies the team members of the team that a request has been cancelled via both Hornbill and email notifications. |
| smNotificationCustomerPortalUpdate | This flowcode operation notifies the owner of the request that the request has been updated by its customer via both Hornbill and email notifications. |
| smNotificationCustomerPortalUpdateTeam | This flowcode operation notifies the team members of the team that the request has been assigned to that the request has been updated by its customer via both Hornbill and email notifications. |
| smNotificationLinkedReqResolveAction | This operation can send a User App Notification and an Email Notification to the owner of a request, to inform that a request has been resolved or closed. |
| smNotificationLinkedReqResolveActionTeam | This operation can send a User App Notification and an Email Notification to the team that a request belongs to, to inform that a request has been resolved or closed. |
| smNotificationMembersAdded | This flowcode operation notifies the owner of the request that the request has had a new member(s) added, or the team members of the team that the request has been assigned to that the request has had a new member(s) added via both Hornbill and email notifications. |
| smNotificationMembersAddedRecipient | This flowcode operation notifies the new request members that they have been added as a member to the request via both Hornbill and email notifications. |
| smNotificationMembersAddedTeam | This flowcode operation notifies the owner of the request that the request has had a new member(s) added, or the team members of the team that the request has been assigned to that the request has had a new member(s) added via both Hornbill and email notifications. |
| smNotificationSendEmail | This operation sends an email notification to specified recipient(s). |
| smNotificationSendEmailDirect | This flowcode operation sends an email notification to the specified recipient. |
| smNotificationSendEmailDirect2 | This operation sends an email notification to the supplied recipient(s) using the direct message option. |
| smNotificationSubStatusUpdate | This flowcode operation notifies the owner of the request that the request sub-status has been updated via both Hornbill and email notifications. |
| smNotificationSubStatusUpdateTeam | This flowcode operation notifies the team members of the team that the request sub-status has been updated via both Hornbill and email notifications. |
| smNotifyEmailCustomer | This flowcode operation sends an email to the customer of a request. It allows you to define the mailbox that the email will be sent from as well as the email template that will be used. |
| smNotifyTaskAuthoriser | This flowcode operation sends an email notification to a task authoriser |
| smPortalGetServices | This operation returns a Service's details. |
| smResumeBPM | This operation resumes the BPM of a Request. |
| smSLMEscalateEmailCustomer | Send the request resolution by email |
| smSLMEscalateResolutionTimer | This will escalate the resolution timer of a request to the new service levels timer |
| smSLMEscalateResponseTimer | This will escalate the response timer of a request to the new service levels timer |
| smSLMEscalateServiceLevel | This is used to amend the service level for a request |
| smSLMGetServiceLevel | This flowcode processes configured SLM rules for a service and returns the id of the relevant service level to apply to the request |
| smSLMGetServiceLevelAgreement | This flowcode processes configured SLM rules for a service and returns the id of the relevant service level agreement to apply to the request |
| smSLMGetServiceLevelProcessCondition | This flowcode processes the Rule Conditions configured against the chosen service using the data within the request |
| smSLMGetServiceLevelProcessValue | This flowcode processes the value of a Rule Condition configured against the chosen service using the data within the request |
| smSLMSetServiceLevel | Sets the Service Level for a request |
| smSLMStartResolutionTimer | This flowcode creates service based service level resolution timers and escalation events for a given request |
| smSLMStartResponseTimer | This flowcode creates service based service level response timers and escalation events for a given request |
| smSendMessage | This flowcode operation sends an email to the specified primary, cc and bcc recipients from within a request. |
| smSendSystemNotification | This operation is now deprecated. Please use "event::postMessage" API instead. |
| smUpdateReqTimeline | This operation is now deprecated. Please use "updateReqTimeline" operation instead. |
| smUpdateStatus | This flowcode is used to update the Status of a request and optionally update the Sub-status. You can choose whether to update the timeline, set the visibility of the timeline post and choose to set an indefinite or fixed off-hold time if updating the request status to 'On Hold' |
| smUpdateSubstatus | This flowcode validates and updates a request sub-status |
| takeFixTimerOffHold | Resume a Resolution/Fix timer |
| takeRequestOffHold | This flowcode takes a request off hold, can be called directly or via timer event |
| takeResponseTimerOffHold | Resume a Response timer |
| update | Update the primary and extended fields of a request |
| updateLinkedRequestsTimeline | This operation is used to post into the Timeline of Requests that are linked to a Request. |
| updateParentReqTimeline | This operation posts an update to a Parent Request's Timeline when resolving or closing Linked Requests. |
| updateProperties | This flowcode updare the request properties |
| updateReqTimeline | This flowcode adds an entry to the specified request's timeline. |
| updateRequest | This operation is now deprecated. Please use "markResponse" operation instead. |
| updateResolutionDetails | This operation updates the resolution details of a Request. |
| updateTimeline | This operation is now deprecated. Please use "updateReqTimeline" operation instead. |
The following events are defined for the 'Requests' entity.
| Event | Description |
|---|---|
| OnAllowTaskActionOverride | Entity system event handler for OnAllowTaskActionOverride |
| OnGetActivityStreamAccessToken | Returns visibility for request activity stream when access token is requested. |
| OnRecordAdded | Entity system event handler when new record is added |
| OnRecordUpdated | Entity system event handler when record is updated |
RequestsExtended
There are no operations or events defined for the 'RequestsExtended' entity.
RequestSLMArchive
The following operations are defined for the 'RequestSLMArchive' entity.
| Operation | Description |
|---|---|
| browse | This will return archived service level records for a request |
| create | Create an archive of the Service Level |
RequestSLMEvt
The following operations are defined for the 'RequestSLMEvt' entity.
| Operation | Description |
|---|---|
| addRequestEvent | This flowcode stores the details of SLM events for a given request |
| createRequestSLMEvents | Create SLM Events for a Request |
| smAddRequestEvent | This flowcode stores the details of SLM events for a given request |
| smCreateEscalationSLMEvents | This flowcode creates service based service level events for a request |
| smCreateRequestSLMEvents | This flowcode creates service based service level events for a request |
RequestSLMTargets
The following operations are defined for the 'RequestSLMTargets' entity.
| Operation | Description |
|---|---|
| create | Create a request service level target entry |
| update | Update a request service level target entry |
RequestStatusHistory
The following operations are defined for the 'RequestStatusHistory' entity.
| Operation | Description |
|---|---|
| addStatusHistory | This flowcode operation records details of a request assignment. |
RequestTimers
The following operations are defined for the 'RequestTimers' entity.
| Operation | Description |
|---|---|
| addRequestTimer | This will create a timer. If the timer already exists, it will return the ID of the existing timer |
| guestAddRequestTimer | Allow trusted guests to post to the timeline of a Request |
ResponseTimes
There are no operations or events defined for the 'ResponseTimes' entity.
Roles
There are no operations or events defined for the 'Roles' entity.
RoutingRuleTemplates
The following operations are defined for the 'RoutingRuleTemplates' entity.
| Operation | Description |
|---|---|
| addRoutingRuleTemplate | This operation creates a Routing Rule template. |
| deleteRoutingRuleTemplate | This operation deletes a Routing Rule template. |
| updateRoutingRuleTemplate | This operation updates an existing Routing Rule template. |
SearchHistory
The following operations are defined for the 'SearchHistory' entity.
| Operation | Description |
|---|---|
| create | Log a new entry in the search history |
| update | Update the search term with the service ID |
ServiceBulletin
The following operations are defined for the 'ServiceBulletin' entity.
| Operation | Description |
|---|---|
| deleteServiceBulletinImage | This flowcode is repsonsible for deleting the image against the specified bulletin |
| getServiceBulletin | This flowcode is responsible for getting all the Bulletins against a particular service |
| reorderServiceBulletinItems | This flowcode is responsible for re-arranging the Bulletins relative to their Service |
ServiceFeedbackQuestionInputs
The following operations are defined for the 'ServiceFeedbackQuestionInputs' entity.
| Operation | Description |
|---|---|
| getFeedbackQuestionInputDetails | This flowcode to get feedback question inputs |
| reorderFeedbackQuestionInputs | This flowcode is responsible for re-arranging the Feedback Question Inputs according to their specified Request Type |
ServiceFeedbackQuestions
The following operations are defined for the 'ServiceFeedbackQuestions' entity.
| Operation | Description |
|---|---|
| getFeedbackQuestionDetails | This flowcode to get feedback questions |
| getFeedbackQuestions | Get Feedback Questions |
| reorderFeedbackQuestions | This flowcode is responsible for re-arranging the Feedback Questions according to their specified Request Type |
ServiceLevelAgreements
The following operations are defined for the 'ServiceLevelAgreements' entity.
| Operation | Description |
|---|---|
| create | This flowcode operation creates a new service level agreement |
| read | Get a list of service level agreements |
| update | This flowcode operation updates an existing service level. |
ServiceLevelAgreementService
The following operations are defined for the 'ServiceLevelAgreementService' entity.
| Operation | Description |
|---|---|
| smAddServiceLevelServiceEntry | This flowcode adds 1 or more links between a service level and a service |
| smDeleteServiceLevelServiceEntry | This flowcode makes checks as to where a chosen service level is in use and will remove the service level from the service and make appropriate updates to rules to maintain data integrity |
| smReorderServiceLevels | This flowcode operation updates the service level order numbers in the system when they have been moved or re-ordered for visual purposes |
ServiceLevelRules
The following operations are defined for the 'ServiceLevelRules' entity.
| Operation | Description |
|---|---|
| create | This flowcode creates a service level rule |
| delete | This flowcode deletes a service level rule |
| read | This flowcode returns rules for selecting a service level |
| update | This flowcode updates a service level/service level agreement rule |
ServiceLevels
The following operations are defined for the 'ServiceLevels' entity.
| Operation | Description |
|---|---|
| smCreateServiceLevel | This flowcode operation creates a new service level. |
| smUpdateServiceLevel | This flowcode operation updates an existing service level. |
ServiceLevelServiceLevelAgreement
The following operations are defined for the 'ServiceLevelServiceLevelAgreement' entity.
| Operation | Description |
|---|---|
| reorder | This flowcode operation updates the service level order numbers in the system when they have been moved or re-ordered for visual purposes |
ServiceLevelTargetEvents
The following operations are defined for the 'ServiceLevelTargetEvents' entity.
| Operation | Description |
|---|---|
| smAddServiceLevelTargetEvent | This flowcode adds service level target events |
| smGetServiceLevelTargetEvents | This flowcode gets service level target events for a specific target |
| smUpdateServiceLevelTargetEvents | This flowcode updates service level target events |
ServiceLevelTargets
The following operations are defined for the 'ServiceLevelTargets' entity.
| Operation | Description |
|---|---|
| smGetServiceLevelTargets | This flowcode returns service level targets related to a specfic service level |
ServiceRequestConfiguration
There are no operations or events defined for the 'ServiceRequestConfiguration' entity.
ServiceRequestDetails
The following operations are defined for the 'ServiceRequestDetails' entity.
| Operation | Description |
|---|---|
| updateServiceRequestForm | This flowcode is reponsible for creating / updating the Service Request Details Form record |
ServiceRequests
The following operations are defined for the 'ServiceRequests' entity.
| Operation | Description |
|---|---|
| logServiceRequest | This flowcode operation logs a Service Request using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the service request before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided. |
| selfserviceLogServiceRequest | This flowcode operation logs a Service Request using the provided parameters. Firstly it calls the component flowcode operation logRequest to actually log the service request before updating the record with any extended table details. Finally it spawns a bpm process if a service id has been provided. |
Services
The following operations are defined for the 'Services' entity.
| Operation | Description |
|---|---|
| deleteService | This operation is now deprecated. Please use "smOnServiceDelete" operation in Services Entity and "translateDelete" global operation instead. |
| getBpmList | This operation is now deprecated. Please use "bpm::workflowUserGetList" API instead. |
| getSupportTeamServices | This operations provides a list of Services that a Customer is subscribed to and the User's Team(s) supports. |
| selfserviceGetServices | This flowcode is responsible for returning all the Services depending on the currently logged in user and the Portal Mode |
| smAddSupportTeam | This flowcode operation associates a team with an service. |
| smCreateService | This operation is now deprecated. Please use "smCreateService2" operation instead. |
| smCreateService2 | This operation creates a new Service. |
| smDropSupportTeam | This flowcode operation removes the relationship between a service and a team. |
| smOnServiceCreate | This flowcode is responsible for creating related service data when a new service has been successfully created |
| smOnServiceDelete | This will remove the service's related data |
| smSelfServiceGetService | This operation is now deprecated. Please use "selfserviceGetServices" operation instead. |
| smSetStatus | Set the status of a Service |
| smUpdateServicePortalVisibility | This flowcode is responsible for updating the Service Portal Visibility value against a specific service and all its respective translations |
| smUpdateServiceRequestTypeVisibility | This operation updates the visibility (i.e. hide or show) of a Service by Request Type. |
ServiceStatus
There are no operations or events defined for the 'ServiceStatus' entity.
ServiceSubscriptions
The following operations are defined for the 'ServiceSubscriptions' entity.
| Operation | Description |
|---|---|
| add | This operation allows a Service user to add a subscriber to a Service. |
| remove | This operation allows a Service user to remove a subscriber from a Service. |
ServicesUsers
The following operations are defined for the 'ServicesUsers' entity.
| Operation | Description |
|---|---|
| Create | Create an entity ServicesUsers |
| Delete | Create an entity ServicesUsers |
| DeleteByRelType | This flowcode delete the users associated to the service based on relType. For example, we want to delete the service owner or the service delegates |
| Update | Create an entity ServicesUsers |
| UpdateUsers | This flowcode update the service users (which can be owners or delegates) . It remove the old ones and add the new ones. The new users are passed as list of "user" in the input params, where each user is a json object with properties id and name |
| getUsersByService | Load owner and delegate for a service. We assume that there is max 1 owner and 1 delegate per service, no multiple owners or multiple delegates |
ServiceTeams
The following operations are defined for the 'ServiceTeams' entity.
| Operation | Description |
|---|---|
| getUserServiceTeams | This flowcode operation gets a list of teams that support the services that the user is subscribed to. |
SharedViews
The following operations are defined for the 'SharedViews' entity.
| Operation | Description |
|---|---|
| getSharedViews | This Flowcode is used to get Shared Views for a particular Custom Filter. |
Site
There are no operations or events defined for the 'Site' entity.
SLC
There are no operations or events defined for the 'SLC' entity.
Snippet
The following operations are defined for the 'Snippet' entity.
| Operation | Description |
|---|---|
| addSnippet | Create a Snippet |
| deleteSnippet | Delete a Snipper |
| updateSnippet | Update a Snippet |
SnippetShare
There are no operations or events defined for the 'SnippetShare' entity.
Statuses
The following operations are defined for the 'Statuses' entity.
| Operation | Description |
|---|---|
| read | This flowcode returns sub-status levels which can be filtered by language, service, request type and parent status |
Task
The following operations are defined for the 'Task' entity.
| Operation | Description |
|---|---|
| AttachFile | For internal use only - Attach a file to the task entity |
| deleteTask | For internal use only - Delete a task |
| entityAttachGetInfo | Get access to file attachments for this entity |
| getAttachments | View the attachments for a Task |
| getEntityTasks | Return tasks assigned to specific entity |
| getNewTasks | For internal use only - Load tasks from notifications |
| removeFile | For internal use only - Remove an attached file |
Task_categories
There are no operations or events defined for the 'Task_categories' entity.
Task_notes
There are no operations or events defined for the 'Task_notes' entity.
TaskBoard
The following operations are defined for the 'TaskBoard' entity.
| Operation | Description |
|---|---|
| addBoard | For internal use only - Create new board |
| addDefaultBoard | For internal use only - Adding default board and defining task lists |
| getBoard | For internal use only - Read board data |
| getBoardTasks | For internal use only - Flowcode return specified board lists with tasks |
| queryBoards | For internal use only - return boards belonging to user (query is taking user from session) |
| updateBoard | For internal use only - Update board data |
TaskBoardList
The following operations are defined for the 'TaskBoardList' entity.
| Operation | Description |
|---|---|
| addBoardList | For internal use only - adding new list to board |
| deleteBoardList | For internal use only - Delete specified list |
| filterBoardListTasks | For internal use only - return filtered tasks, for more secure searching (only tasks that user can see) to filtered data are added from session user id and roles |
| filterBoardListTasks_ | For internal use only - return filtered tasks, for more secure searching (only tasks that user can see) to filtered data are added from session user id and roles |
| filterTasks | For internal use only - return filtered tasks, will filter from list one by one and return results in same order |
| getBoardList | For internal use only - Return single list row |
| getBoardListTasks | For internal use only - Return list tasks that are assigned manually |
| getListTasks | For internal use only - Loading tasks one by one for all specified input id, checking every list for type (filter or manual) and calling specific query depends on it. At end return json stringified array of lists with tasks. |
| queryBoardLists | For internal use only - return lists belonging to user |
| updateBoardList | For internal use only - Updating board list record |
| updateListPositions | For internal use only - Updating lists position in order of appear in array |
TaskBoardListTask
There are no operations or events defined for the 'TaskBoardListTask' entity.
TaskTemplate
The following operations are defined for the 'TaskTemplate' entity.
| Operation | Description |
|---|---|
| add | Adding new template |
| get | Return template |
| remove | Remove template |
| update | Updating template |
Team
There are no operations or events defined for the 'Team' entity.
TeamAssignment
The following operations are defined for the 'TeamAssignment' entity.
| Operation | Description |
|---|---|
| addTeamAssignment | This flowcode operation records details of a request assignment. |
TeamMemberAssignment
The following operations are defined for the 'TeamMemberAssignment' entity.
| Operation | Description |
|---|---|
| insertUpdate | This flowcode is responsible for inserting and updating request assignment restrictions for team members |
| toggleAll | This flowcode is responsible for updating all of the request assignment restrictions for team members |
TeamUsers
There are no operations or events defined for the 'TeamUsers' entity.
Templates
The following operations are defined for the 'Templates' entity.
| Operation | Description |
|---|---|
| createTemplate | Create a Template |
Timers
There are no operations or events defined for the 'Timers' entity.
UserAccount
The following operations are defined for the 'UserAccount' entity.
| Operation | Description |
|---|---|
| getTeams | Flowcode Operation using the supplied Customer User Id to retrieve the user's Container Id and Customer Name |
UserEntityList
There are no operations or events defined for the 'UserEntityList' entity.
UserServiceFavourites
The following operations are defined for the 'UserServiceFavourites' entity.
| Operation | Description |
|---|---|
| smPortalsAddFavourite | This flowcode is responsible for adding a particular Service as the currently logged in User's favourite |
| smPortalsDeleteFavourite | This flowcode is responsible for deleting a particular Service as the currently logged in User's favourite |
| smPortalsGetFavourites | This flowcode is responsible for getting all the Favourite Services related to the currently logged in User |
Vendors
The following operations are defined for the 'Vendors' entity.
| Operation | Description |
|---|---|
| addVendor | Create a Vendor |
| deleteVendor | Delete a Vendor |
| updateVendor | Update information for a Vendor |
Versions
The following operations are defined for the 'Versions' entity.
| Operation | Description |
|---|---|
| addVersion | Create a Version |
| deleteVersion | Delete a Version |
| updateVersion | Update information for a Version |
Operations
The following general operations are defined for the 'com.hornbill.servicemanager' application. You can click on each operation to see detailed information about that operation.
| Method | Source | Description |
|---|---|---|
| addEveryoneToRole | global | For internal use only - Add all users to the specified role |
| addEveryoneToWorkspace | global | For internal use only - Add all users to the specified workspace |
| addHistory | global | For internal use only - Add a historic bookmark for the page visited |
| addMembersToWorkspace | global | For internal use only - Add users, groups or members to a specified workspace |
| adminAssignUsersToGroup | global | For internal use only - Add all users to the specified role |
| adminAssignUsersToGroupbyGroupAndRole | global | This is the description text for this flowcode operation |
| adminAssignUsersToRole | global | For internal use only - Add all users to the specified role |
| adminAssignUsersToRolebyGroupAndRole | global | This is the description text for this flowcode operation |
| adminBpmAddTemplate | global | This is the description text for this flowcode operation |
| adminBpmDeleteTemplate | global | This is the description text for this flowcode operation |
| adminBpmGetTemplate | global | This is the description text for this flowcode operation |
| adminBpmGetTemplatesForList | global | get bpm templates for app returing just id, name, type and grouping |
| adminBpmGetTemplatesTable | global | Get BPM templates for a given app |
| adminDatabaseListCreateRecord | global | create record in h_sys_dblists |
| adminDatabaseListDeleteRecord | global | deleterecord in h_sys_dblists |
| adminDatabaseListGetListValues | global | Get db list and then get list values for it |
| adminDatabaseListUpdateRecord | global | create record in h_sys_dblists |
| adminInitaliseData | global | Used by the Admin App to get all the initial data need on first lost. |
| appCoreInitaliseData | local | This loads application data to be used in the setup of the application |
| appHomeInitialiseData | local | This flowcode is responsible for getting all the relative Service Bulletins for a user, against all their subscribed services (Users) and populating the Hornbill Home View slides |
| bmCardFormat | local | This operation returns the default card format for a Request card in the Board Manager App. |
| checkAppRightsGranted | local | This operation determines if a User is granted the right to an Application Right in Service Manager app. If more than one Application Right is supplied, the operation will determine if at least one of the supplied Application Rights are granted. |
| cnvDurationToSeconds | local | This flowcode parses a duration value into its components for later manipulation |
| cnvSecondsToDuration | local | Converts a value in seconds to the corresponding duration value |
| convertRichTextToPlainText | local | Takes rich text and converts it to plaintext |
| coreHomeInitialiseData | global | Calls all applications and requests slides and home data |
| coreInitaliseData | global | For internal use only - Used by the Core Web App to get all the initial data need on first lost. |
| devAppCreateAssessmentType | local | This operation creates an Assessment Type called 'Impact' when updating the Service Manager App. |
| devAppCreateIndex | local | Makes sure that the Service Manager indexes exists |
| devAppCreateProfiles | local | This will make sure the profiles have their code stems - REQUEST/CLOSURE |
| devAppDisableSMBoards | local | This disables SM boards for new installs |
| devAppSimpleLists | local | Make sure that each simple lists exists |
| devAppUpdateRoles | local | Used to apply the default and necassary roles for the Service Manager application 123 |
| devAppUpdateServiceRequestTypeVisibility | local | This operation enables Request Type visibility for all existing Services in an instance. Please note that this operation is not standalone and should NOT be run by a user; it is a one-time run only by the OnDevAppUpdate Event. |
| getCoWokers | global | DEPRECATED - please use getCoworkersList |
| getCoWokersList | global | DEPRECATED - Please use getCoWorkersList |
| getCoWorkers | global | DEPRECATED - please use getCoworker |
| getCoWorkersList | global | For internal use only - Get a list of Co-workers |
| getContacts | global | DEPRECATED - use get contactsList |
| getContactsList | global | For internal use only - Get a list of contacts |
| getContactsList4 | global | For internal use only - Get a list of contacts |
| getContactsListByOrgFilter | global | For internal use only - Get filtered and paged list of organisations |
| getEmailList | global | DEPRECATED - For internal use only - Used to get email list (Paged) and count of emails. |
| getEmailList2 | global | For internal use only - Used to get email list (Paged) and count of emails |
| getEmailUnreadCounter | global | For internal use only - Returns the unread email counter for all shared mailboxed bellonging to the logged in user |
| getOrganisations | global | DEPRECATED - use getOrganisationList |
| getOrganisationsList | global | For internal use only - Get filtered and paged list of organisations |
| getPlaintextEmail | local | Get an email's context as plaintext. This flowcode will fetch the email and check for a plaintext version first. If this is found, it's parsed to remove any tags found and then returned. If no plaintext is found, the HTML content is parsed and returned. |
| getPriorityFromMatrix | local | Get the priroty by checking the impact and urgency against the configured matrix |
| getRoutingRuleTemplate | local | This operation gets the configurations of a Routing Rule template. |
| getSitesList | global | Get a list of Sites |
| getSystemSetting | local | This operation returns value of "api.xmlmc.queryExec.maxResultsAllowed" System Setting. |
| getUnreadCountersForPosts | global | DEPRECATED - For internal use only - Get unread counters for a list of activity Id |
| getUserBasicNotificationConfig | global | For internal use only - Returns user event configuration |
| getUserGuestRecord | global | This operation returns a customer's details, depending on whether they are a co-worker or a contact. |
| getUserMemberships | global | Returns the List of My Roles and Groups as URNs includding the same user URN |
| getUsersIManage | global | For internal use only - Returns the List of Users I manage based on Groups |
| getVisibility | local | Send the Service Manager terminology and you will get the appropriate activity stream visibility back |
| guestInitaliseData | global | Used by the Guest App to get all the initial data need on first lost. |
| hornbillRaiseIncident | local | This operation is intended for system use only. |
| knowledgeSearch | local | This flowcode is responsible for querying various entities and returning the relevant search results |
| knowledgeSearchSelfService | local | This flowcode is responsible for querying various entities via the portals and returning the relevant search results |
| portalsGlobalSearch | local | This flowcode is responsible for querying the portals and returning the relevant search results |
| postToTimeline | global | Make safe post to social object timeline, checking if user is following, if not doing it for him and unfollow. |
| sendMessage | global | Send message to specific urn array |
| shrGetCustomerDetails | local | This operation returns a customer's details, depending on whether they are a co-worker or a contact. |
| shrGetTimestamp | global | This flowcode returns a new calculated timestamp value based on the input parameters provided. |
| shrGetVisibility | local | This flowcode converts the supplied ITSM visibility names into System visibilities. |
| smGetReport | local | Run an in-app reporting stored query |
| translateAddLanguage | local | This Global Flowcode is responsbile for adding a new translation against a currently existing entity |
| translateCreate | local | This Global Flowcode is responsbile for create a new unique translation for an entity |
| translateCreateDefault | local | This Global Flowcode is responsible for creating the default language version for an entity |
| translateData | local | This Global Flowcode is responsbile for translating the provide summary and description data from the source language to the target language using the Google Translate API |
| translateDelete | local | This Global Flowcode is responsbile for deleting either speicifc entity's translation or the whole entity and all its children translations |
| translateGetEntityDetails | local | The global flowcode is responsible for getting all the relevant entity translation details |
| translateGetLanguageOptions | local | This Global Flowcode is responsible for returning all languages the current entity has already been translated in as well as the other remaining languages that are available |
| translateUpdate | local | This Global Flowcode is responsible for updating a currently existing entity's translation record |
| translateUpdateFeature | local | This flowcode is responsible for updating a translatable entities specific features e.g. Services: h_available (portal visibility). Statuses: h_allow_use_on_auto_update |
| updateActivityStream | global | For internal use only - Unified access to the following APIs PostImage AcitvityPostImage ActivityPostMessage PostMessage |
| updateAppSettings | local | Migrate app settings from an old value to a new one. Also possible to migrate between apps using this flowcode on upgrade. |
| userUpdateProfile | global | Used by the Service Portal to update a basic user / users profile |
The following general BPM operations are defined for the 'com.hornbill.servicemanager' application. You can click on each operation to see detailed information about that operation.
| Method | Source | Description |
|---|
The following general Auto Responder (AR) operations are defined for the 'com.hornbill.servicemanager' application. You can click on each operation to see detailed information about that operation.
| Method | Source | Description |
|---|
The following general events are defined for the 'com.hornbill.servicemanager' application. You can click on each event to see detailed information about that event.
| Event | Source | Description |
|---|