Application - com.hornbill.elearning


Entities

The following entities are defined for this application

AccountStatus

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.

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.

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
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
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.

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

Favorite

There are no operations or events defined for the 'Favorite' entity.

Groups

There are no operations or events defined for the 'Groups' entity.

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.

ProCapCustomQuestion

The following operations are defined for the 'ProCapCustomQuestion' entity.

Operation Description
add_json Add progressive capture custom questions with answers

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.

RelatedContainer

There are no operations or events defined for the 'RelatedContainer' entity.

Roles

There are no operations or events defined for the 'Roles' entity.

Site

There are no operations or events defined for the 'Site' entity.

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
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
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.

TrainingCourseHistory

There are no operations or events defined for the 'TrainingCourseHistory' entity.

TrainingCourseModuleQuestions

There are no operations or events defined for the 'TrainingCourseModuleQuestions' entity.

TrainingCourseModules

The following operations are defined for the 'TrainingCourseModules' entity.

Operation Description
Delete Operation used to Delete Course Modules
MoveModulePosition Move a Modules posion

TrainingCourses

The following operations are defined for the 'TrainingCourses' entity.

Operation Description
deactivate This operation will deactivate a currently active course so it can be modified
export This operation will export a Training Course with all modules and questions.
get Used to get the latest section of a course
getList Operation is used to return list of Courses for the User / Service / Customer Portals, Only Subscribed and Public (Active) courses are returned.
import This operation is used to import a previously exported course
progress Operation will Progress the Course based on the latest active module, any required questions must be passed in for validation.
start Used to start a Training Course a user is Subscribed to or is Public

TrainingCourseSubscriptions

There are no operations or events defined for the 'TrainingCourseSubscriptions' 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.

Operations

The following general operations are defined for the 'com.hornbill.elearning' 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
adminInitaliseData global Used by the Admin App to get all the initial data need on first lost.
coreInitaliseData global For internal use only - Used by the Core Web App to get all the initial data need on first lost.
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
getSitesList global Get a list of Sites
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
guestInitaliseData global Used by the Guest App to get all the initial data need on first lost.
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
shrGetTimestamp global This flowcode returns a new calculated timestamp value based on the input parameters provided.
updateActivityStream global For internal use only - Unified access to the following APIs PostImage AcitvityPostImage ActivityPostMessage PostMessage
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.elearning' 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.elearning' 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.elearning' application. You can click on each event to see detailed information about that event.

Event Source Description

Powered by Hornbill, for more information click here. (page served by Esp.hornbill.ServerService, 8.0.0.2865.)