Use a Workflow to Update Learner Details

Note: Refer to Videos for a video describing the steps featured in this online documentation.

The following example describes how a workflow can be used with REST Services to update learner data.

Note: Refer to REST Services for further information and to ebs REST Documentation for descriptions of each service documented.

To update learner data with a workflow:

  1. Open the relevant learner record using Learner Search and make a note of their Person Code.

    Learner Search

  2. Copy the Web service host URL institution setting (on the General (Cross System) screen).

    Note: The URL of your REST Services documentation is stored in the Web service host URL setting on the General (Cross System) screen in Institution Settings.

  3. Navigate to your REST services session by pasting the Web service host URL into a browser’s address bar, appending the URL with /docs (that is: http://<web service host URL>/docs).

    Note: Refer to Use the Try It Out Functionality for further information about authorising your account.

  4. Authorise your REST services session.

  5. Click the Tribal Toolbox tab in the REST section of Workflow Builder.

    Tribal Toolbox tab

  6. Click Save.

    Your workflow sequence will now include the following activities in order:

    • HttpGetRequest - authenticates use of the REST Service

    • TrackingMessageActivity - the authenticated tracking activity status output

    • TrackingMessageActivity - the Result GET tracking activity output

    • ConvertStringtoJson - converts the return message from the authentication output into the JSON format

    • GetJsonFieldValue - retrieves the token from the ConvertStringtoJson activity in the JSON format

    • HttpPutRequest - specifies the relevant update criteria and REST Service

    • TrackingMessageActivity - the update people tracking activity status output

    • TrackingMessageActivity - the Response tracking activity output

    Full sequence for updating learner details

    Your sequence will now include the following variables:

    • PostStatus - HttpStatusCode

    • PostResponse - String

    • GetREST - String

    • Status - HttpStatusCode

    • token - String

    • AuthorisationJsonResponse - JObject

    Variables

    You can now trigger the workflow and use the User Tracking tab to ensure that the learner is updated.

    User Tracking tab

    Note: You can use Learner Search to verify that the update was successful.

    Learner Details

Back to top