conMan documentation

This is task orientated documentation for the Connectathon Manager (conMan)  application.

Note that at the time of writing, conMan does not work in the Brave browser. Chrome is recommended.

The URL for the May 2021 connectathon is: http://conman.clinfhir.com/connectathon.html?event=con27

A test instance you can play with is: http://conman.clinfhir.com/connectathon.html?event=hl7online 

General tasks

Logging into conman

Registering interest / attendance in a track

Finding a test server

Adding a new test server

Registering a test result

Track lead tasks

Adding a new track

List track details

Adding a scenario to a track

Scenario roles

General tasks

Logging into conman

To log into conMan, navigate to the application (). If you have already logged in on this browser, then you will be immediately logged in - no further action is required. (You can logout using the logout icon in the upper right of the navbar.

Otherwise, you will be presented with a login dialog.

If you have already logged in before (perhaps on a different machine) then start to type your name into the user name box which will present a filtered list of users. You can select your name when it appears.

If this is your first time, then click the ‘Register new person’ link. You can then enter your user name (email is best). Click the login button when done. The login will be remembered on this browser - next time you load conMan you will be logged in immediately,

Note that there is no password required - login is really just a way of recording personal preferences - it’s an honesty based system.

Registering interest / attendance in a track

To register your interest in a specific track, click the ‘People’ tab in the top part of the screen. This will display a list of all users registered to the app.

Find your own login name / email in the list and click the ‘Edit’ link that appears to the right.

The dialog that appears allows you to select the primary track and any other tracks of interest.

To add a Track of interest click the ‘Add’ link to the right, then select the track from the drop down that is displayed.  

You can have as many Tracks of interest as you want - but only a single primary track.

Selecting tracks doesn't affect the operation of conman at all - it’s simply a way for track leads to see who is participating or interested in their track. The list of participants in each track is displayed in the track details page, and also in the Participation report tab

Don’t forget to click the ‘Update Person’ button to update the details.

Finding a test server

conMan maintains a list of test servers to make it easier for clients to find a server that supports functionality they are interested in.

There are 2 places where test servers are shown in conMan.

The track details tab has a subtab headed ’servers’ that has a list of all servers where the author of the server entry has indicated that the server is appropriate for that track. Details can be viewed from this list, and the author can make changes.

The Servers tab has a list of all servers recorded. The list displays:

To the right is a link that will display the full details of the server, including the contact person. If you are the contact person for this server, then you can edit the contents (including the track that the server can be used in) - otherwise the view is read-only.

There is also a link to add a new server.

When the track details are displayed in the first tab, there is a sub tab that will show the servers associated with that track. These are set in the server edit option (see next entry) - they are a subset of the complete list from the servers tab.

Adding a new test server

To add a new server, click the ‘New Server’ link at the top of the servers list. A dialog is displayed into which details of a server can be entered. All servers must return a CapabilityStatement with a call to [host]/metadata.

The following fields can be entered.

The name and url are required.

It is also possible to indicate which tracks a server is intended to support. This information will appear in the server listing as well as in the track details.

These can be updated in the ‘Associated tracks’ tab of the serve edit dialog.

Registering a test result

Track lead tasks

Adding a new track

To add a new track, click the ‘Add new Track’ link that is displayed below the list of tracks in the track details tab. The following key fields can be entered:

At the bottom of the screen is a tabset with the following tabs:

Json - a representation of the internal track definition.

After adding the track, it can subsequently be edited by the track lead by clicking the edit icon alongside the track name in the track details tab.

List track details

Selecting a track in the Track details tab will display the details of that track in the right pane. This is a summary of the details when editing the track, plus any servers that are associated with it.

If there's a details page specified in the track, then there’s a link to it in the page as well. There is also an iframe that can show the contents if the sire permits.

Adding a scenario to a track

A track can have multiple scenarios. It’t not really necessary to include them in conMan, unless you are using it to record the outcome of testing - in which case it is quite useful.

To add a scenario to a track, select the track in the track details tab, then click the ‘Add a new scenario’ link that is displayed part way down the right side.

There are a number of aspects of the scenario that you can add depending on the level of detail you want recorded. General a description of the scenario is useful, in addition you can add:

Scenario roles

If you are intending to use conMan to record the outcome of testing, then adding roles is required (as each participant in a test needs to be in a role). To add a role:

  1. Select the roles tab of the scenario
  2. Enter the name of the role into the text box
  3. Indicate whether it is a client or a server
  4. Click add

Remember that a role is not a specific server (or client) - rather it describes how a client & server interact with each other. Quite often, only a single server and client role is required.