Skip to content

Commit

Permalink
Added Connectors (written by Marten)
Browse files Browse the repository at this point in the history
  • Loading branch information
hvroege committed Feb 19, 2016
1 parent 4f13440 commit ed34ff2
Showing 1 changed file with 51 additions and 13 deletions.
64 changes: 51 additions & 13 deletions docs_simplifier/simplifierConnectors.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,55 @@
Connectors
==========
A Connector is a script written by you or another community member. These scripts connects functionality from other websites or applications to Simplifier.net.
You can view your active connectors, shop for new connectors, or create or edit your own connectors via the Portal page.
Simplifier Connectors
=====================

Simplifier allows users to create a connection to other applications. Think about sending a StructureDefinition to an Example generator, a TestScript resource to a server test application, a ValueSet to an terminology server etc.

Subscribe to a connector
------------------------

If you want to make use of an already available connector, you can personally "subscribe" to one. To do this, please follow these steps:

1. Log In on https://simplifier.net
2. Go To you portal, by clicking on "portal"in the menu, or go to the following link: https://www.simplifier.net/ui/User/Index
3. Click on "Connectors" in the portal menu
4. Go to "shop" to find a list of connectors
5. Find the connector you want to use and click on "subscribe".

Create a connector
------------------

1. Log In on https://simplifier.net
2. Go To you portal, by clicking on "portal"in the menu, or go to the following link: https://www.simplifier.net/ui/User/Index
3. Click on "Connectors" in the portal menu
4. Go to "create/edit"
5. Go to "create connector"
6. Fill in the metadata of your connector under the properties tab
7. Use the "Script" tab to write the actual Script. **Note:** You have to write your script using Javascript.

Example:

.. code-block:: Javascript
window.location.href = "http://example.com/createExample?profile={endpoint}&callbackurl={returnUrl}";
This script sends the FHIR endpoint of the resource to example.com. Example.com can then retrieves the profile and creates an example instance.

8. Once you have created your connector, the Simplifier administrator gets notified. The administrator can either approve the connector or turns it down. If your connector is approved, it will be available in the shop.

Use a connector
---------------

Each connector specifies one or multiple resources is can be used with. You can see this in the shop or if you already subscribed, on your personal connector page. If you have subscribed to a connector, you can use the connector on each resource of the type specified there under the "connectors" tab.


| Example:
|
| For example, if you have subscribed to a resource which generates an example for StructureDefinitions, you can access that connector on each StructureDefinition.
| Once you click on it, the connector sends a request to open this specific resource from Simplifier




Shop for Connectors
-------------------
In the Connectors Shop you can see a list of all available connectors. This list shows the Name, Description, Owner, Direction, and Resource Type of the Connector. To Subscribe to the Connector you want, simply press the Subscribe button.

Create/Edit Connectors
----------------------
On the Connectors - Create and Edit page you will see a Create Connector button and a list of your Connectors.

Using the Create Connector button or clicking an existing Connector will open the Connector Details page where you can enter or edit the Name, Description, Direction, and Resource Type.
To build or edit your script, click the Script Editor.

**Note**: All scripts will go through a proliferation process and will not be usable without the approval of a Simplifier.net Admin.

0 comments on commit ed34ff2

Please sign in to comment.