Four Session Developer Guide - February 2024

February 2024

We presented these four training sessions in February 2024. The sessions cover troubleshooting ShareDo issues, extending ShareDo, creating custom components using the IDE, and ShareDo in a Box.

Use the Table of Contents to jump to the recording you want to review. To make it easier to jump to the chapter you want to review, open the recording on YouTube using the Watch on YouTube link in each video. You can drag the time slider on a recording here to achieve the same result.

Troubleshooting in ShareDo 

Developer Guide Session 1 of 4

In this video, the first in a series of four, recorded in February 2024, Stu shows us how to troubleshoot ShareDo issues. He takes us through basic diagnostics, common issues, and a couple behind-the-scenes tools useful for troubleshooting.

The console commands Stu shows near the end of the video are the following:

$ui.debugWidgetNames()
$ui.whyCanISee()
$ui.debugSecurity()
$datacomposer.browseCurrent()
$datacomposer.browseEntityId(“workitem”, “{guid}”)

Chapters

00:00 Introduction
01:31 Agenda
02:29 Basic diagnostics
05:25 Search indexes
10:30 Execution engine
16:14 Incoming email
23:26 Notifications (end of basic diagnostics)
24:55 System config
28:14 Common issues
36:18 'Hidden' tools useful for troubleshooting. This section includes the console commands listed above.
43:20 Widget names
46:52 Future developments for diagnostics: 1 ShareDo in a Box. 2 SEQ log diagnostics.
52:33 Questions

Overview of extending ShareDo

Developer Guide Session 2 of 4

This is the second of four training sessions showing, from a developer's perspective, an overview of what you can extend within ShareDo, the tools involved, and how to do it.

Chapters

00:00 Introduction 
00:56 Agenda
01:48 Tools overview
03:10 Tools: Workflow / Events
03:40 Tools: IDE
04:13 Tools: Code plugin
05:05 Tools: Authentication
06:05 Custom UI overview
08:13 Custom UI: Form Builder
09:08 Custom UI: IDE Widgets
10:15 Custom UI: IDE Aspects5 Workflows/Actions overview
14:49 Workflows/Actions: JS Blocks / Calculated Fields
18:08 Workflows/Actions: Reusable Actions
19:55 External API calls (webhooks)
21:12 API call to the Code Plugin
22:23 API calls via Proxy or Code Plugin
23:54 Demo: talking to external systems. Authentication, linked services, and code scaffolding.
29:56 Public API
31:44 Code Extensions - ODS External Search / Pipeline Action
33:50 Demo: Code Extensions
36:35 Summary and Final questions
43:11 help.sharedo.co.uk demo (Calculated Fields / Lists)
45:00 Form Builder question/demo
49:30 Data Composer/Workflow question/demo
55:08 Portal Editor/Widget question/demo

Using the IDE to build custom components

Developer Guide Session 3 of 4

This is the third in a series of four training videos for developers. It deals with using the ShareDo IDE to build custom widgets, workflow actions, and blades. The video also shows integrations with these custom-built components.

All the code samples, fake APIs, and a ShareDo solution package from today's session are available on GitHub here: https://github.com/sharedo-tech/forum2024-02-S3.

Chapters

00:00 Introduction
00:20 Session Overview
02:08 Tech forum orientation - where this video fits in the series
03:31 Using the IDE to build widgets
05:06 Demo: building a 'Risk' widget
10:45 The IDE
12:35 Public APIs and their documentation
13:13 Walking through what the scaffold code does
29:38 Scaffold: agent
31:41 Scaffold: designer
38:15 Data composer
40:59 View the widget, error, and troubleshooting
49:18 Make it look better
52:45 See the styling changes
54:03 Make it autocomplete - and shows $ui.events.debugBroadcasts()
59:33 What is a workflow
01:04:15 Demo workflow in the IDE / action factory / manifest
01:15:02 Triggering the workflow
01:17:38 Summary
01:18:16 Integrations / sample API / security / linked service proxy
01:25:38 Linked services
01:28:11 Shared secret
01:30:39 Demo: integration auth
01:32:57 Demo: using the service we just created
01:37:24 Using the IDE to build custom blades
01:43:13 Demo: custom workflow actions:45:51 Visual Form Builder (coming soon)
01:49:53 Wrapping up: what did we cover?
01:50:44 Q&A (none)

Beyond the IDE

Developer Guide Session 4 of 4

This is the fourth and final in a series of developer training videos. It demonstrates ShareDo in a Box and extending ShareDo with plugins.

Chapters

00:00 Introduction.
00:42 Brief Introduction.
02:20 What is ShareDo in a box?
07:35 Caveats and limitations.
11:40 ShareDo in a Box: Installation video.
26:14 Demo: Working on existing config.
33:11 Extending ShareDo: Beyond the IDE. Ways to do it.
36:00 What is a plugin?
42:33 Why use a plugin?
47:22 Disadvantages of working with plugins.
52:06 Lifecycle of developing a plugin.
54:40 Integrations that require a VPN.
56:00 Demo: Porting from the IDE.
01:02:22 Demo: Building a more complex example.
01:04:24 Step 1: Creating the plugin.
01:10:46 Step 2: UI
01:18:37 Step 3: Backend services.
01:39:10 Step 4: Service registration.
01:43:28 Step 5: Startup task.
01:51:34 Summary of what we covered.
01:53:00 Questions?