How to create a document on Carbon Editor

1 Document owner
2 Step 1: Creating the document in Carbon Editor
3 STEP 2: Select a Space
4 STEP 3: Export the created document to Ubiquity Dashboard
5 STEP 4: Add the preferred document name and description (optional) to the version details in Ubiquity Dashboard
6 STEP 5: View the document in the hospital admin dashboard

Document owner

Every document has a owner which is recorded in the document metadata as the “owner_id”

When content is created (via Carbon Editor for example) by super admins the Owner_ID is set to ‘Global’.
When content is created by hospitals (via uploading a PDF for example) the Owner_ID is set to the hospitals own unique id.

Perform the following steps if the super admin or hospital admins need to create a document.

Step 1: Creating the document in Carbon Editor

1.1 Log into the idm account using your credentials and click on Applications>Carbon Editor to navigate to the carbon editor platform where all the documents are present.

Image 1.1

STEP 2: Select a Space

2.1. Go to the Carbon editor and click on the space where you want to create the document.

Image 2.1.

2.2 Now, click on the document category under which you want to create a new document

Image 2.2

2.3 In the documents page, click on the “Create” button as shown in the below image to create a new document.

Enter the document name and click on “Save”.

Note: If the document is meant for Super Admin , then please add the procedure title with the name of the document. For example add Hip/Knee or Incisional/Inguinal with the document title

If the document is for a hospital, add the hospital name along with the procedure title for the name of the document.

For example add Hospital A Hip/Hospital A Knee or Hospital A Incisional/Hospital A Inguinal with document title.

Now click on the created document to create new pages inside the document.

On entering the created document, you can create new pages inside the document by clicking on the “Create” button as shown in the below image:

Enter the page name and click on save.

Add the content inside the page and click on “save”.

2.3 Now, click on the drop-down for “Versions & Exports” present on the top of the document and select “View Metadata” as shown in the below image.

Image 2.3

2.4 Once you click, “View Metadata” option, scroll down the page and click on the “Click” button present to enter the “Source_Url” as shown in the below image.

Image 2.4.

2.5 Replace the code here with the below given code and click on “Save” button. - For super admin document

{"owner_id": "global",
"source-url": "",
"content-provider": "",
"original-authors": ""}

Image 2.5

OR

2.5 Replace the Owner_id from “global“ to “hospital/ followed by the unique ID of the hospital” which you would have copied from the super admin dashboard>Administration>Hospitals>Test hospital. Click on “Save”. - For Hospital document

Image 2.5

2.6 Scroll down and update the meta tags if needed. Doing this, you can search the content using tags which has the same name but different content.

In the minimum please add the procedure name, content type, language, and global/hospital tag

Image 2.6

STEP 3: Export the created document to Ubiquity Dashboard

3.1 Click on the “Versions and Exports” button and not the drop-down to export the document as ubiquity.

3.2. Click on “Create Version” button to create a new version.

3.3 Fill in the “Name” and “Description” of the new version. Click on “Save”.

3.4 Click on the “export” button as shown in the below image.

3.5 Click on the “Create Export” button.

3.6 Select the export Type as “Ubiquity”.

3.7 Select “BBraun HTML” as the export theme.

3.8 Select the app which you need the document to be exported for. in this case it is ForPatientApp QA. Click on “Next”.

3.9 Since you are creating a new document, please select the option “Create a new document”. Click on “Next”.

3.10 Use the same document name and click on “Next”.

3.11 The document type would be “Standard” . Click on “Next”.

3.12 Select the document category and click on “Next”.

3.13. Click on the location where the document should appear in the app. Click on “Next”.

3.14. Now click on “Start Export”.

STEP 4: Add the preferred document name and description (optional) to the version details in Ubiquity Dashboard

4.1. Now check for the status “Complete” and click on “View in Ubiquity” button.

Image 4.1

4.2. Performing the above step, it would be navigated to the ubiquity platform as shown in the blow image. To update the Name and description, please click on the “configure” button.

Image 4.2.

4.3. Select “Name and Description” option and fill in the details. Click on “Save” button.
Note: Here you add the name of the document without the procedure details or the hospital name. This name is the one that will show in the app for patients

Image 4.3

4.4. Finally select “Publishing”, Select the “Document Availability” as “Free”. save it. Select the latest version and click on “Publish” button.

Image 4.4

STEP 5: View the document in the hospital admin dashboard

Now log into the super admin dashboard and you will be able to view the created document under Super Admin dashboard >content>documents.

In the hospital admin dashboard, you will be able to view the created hospital document under Hospital Admin dashboard>Content>Documents.

ForPatientApp knowledge base