edxTools

Help

Not finding what you are looking for? Feel free to contact EDX Support.

Table of Contents

Overview

EDX Overview

Top

How does EDX work?

EDX is an online clearinghouse for historical and present-day data, which is coordinated from a wide-variety of sources to serve as a research and rapid response tool for energy-related data. This is accomplished with help from users. EDX leverages a crowd-sourcing approach, relying on interaction from users to both contribute new content to the system and help direct future functionality and capabilities for the system by providing feedback to the EDX Support Team.

Users have the ability to contribute 1) data or tools resulting from their own research efforts, as well as 2) key links to externally hosted data that they think are important for others to be able to find and utilize going forward. When users contribute data or an external link, they are asked to provide key metadata for those data including attributes, characteristics, and keywords (ACKs). This metadata is entered into EDX databases and serves as the building blocks for EDX. The ACK information is utilized to compile search results, which will allow others to search and use the information. All data and items submitted are reviewed for general accuracy and completeness prior to being approved for release. Once a contribution is approved, it is made available to the public for search and download/review.

In addition, the EDX Support Team fields all user feedback about the current functionality of EDX, addressing any bugs or issues with EDX’s current performance, as well as accepting suggestions from users on desired functionality.


Overview

Contributing to EDX

Top

What can be contributed to EDX?
Who can contribute to EDX?

Data, datasets, tools, and apps should be contributed to EDX by the primary owner or author of the submission, or “co-author” who has the primary author’s permission. It is the contributor's responsibility to ensure that all team members are aware the data is being contributed to EDX if developed by a group/team.

Any registered user can nominate a link to publicly hosted data or information for inclusion in EDX. The goal of nominating a link to externally hosted data is to help NETL-affiliated researchers efficiently access important data resources, including data sources that have been utilized by NETL-affiliated teams in the past.Any registered user can nominate a link to publicly hosted data or information for inclusion in EDX.


Overview

Attributes, Characteristics, and Keywords

Top

What are ACKs?
Are ACKs different than metada?

EDX collects metadata about all submissions, referring to this metadata as ACKs. ACKs are the attributes, characteristics, and keywords (ACKs) of the data or external links stored in the EDX databases. The ACKs serve as the building blocks for EDX and are utilized to compile search results.

No, ACKs are metadata and are utilized to compile the search results that are returned by EDX. The EDX team has made the metadata/ACK submission process streamlined and efficient for EDX users. Generally, most users can complete an ACK for a new contribution in less than 5 minutes.


Overview

Large File Upload

Top

How do I upload files 10 Gigabytes or larger to EDX?
Can EDX handle large file uploads?
Can EDX handle large file downloads?

The 10 GB file limitation is a standard file size limitation at present for large files uploaded and downloaded online. If users have datasets larger than 10 GB there is an alternative work flow that supports addition of their dataset to the EDX database and servers.

Please fill out the contribution ACK form with all of the information as you would with any other submission. However, on the second page of the contribution ACK form, in the “Resource” and “Name” textboxes, please insert the following text: “LARGE DATA FILE PENDING UPLOAD”. Once your contribution has been submitted, please contact EDXSupport@netl.doe.gov and include the title of your EDX submission and a brief overview of the large files contents. The EDX Support Team will work with you to get the data into EDX.


Overview

Data Review Process

Top

How is data reviewed?

Data/dataset submissions go through a 2-step review process, while link submissions go through a 1-step review process. For data, there is a pre-review, where the data is reviewed to determine if it is affiliated with NETL supported research and if so, if the appropriate information about that support was provided. For both data and links, the final review step involves a review by an appropriate subject matter expert to ensure the general appropriateness and completeness of the contribution, particularly the information completed in the ACK. Once a submission has been approved through the review process, it is added to EDX where it can be searched and downloaded.

The quality of each dataset is not endorsed by EDX or NETL. See NETL disclaimers for more information.

If you question the quality of data within EDX, please contact EDXsupport@netl.doe.gov.

Once a dataset or link is added to the EDX database, users who download or use the data can leave feedback about the data/link using a standard 5-star rating system and commenting process. This informal peer-review assists users searching for data and alerts the EDX Support Team to any concerns or issues with accepted contributions.


Overview

Data Restrictions

Top

Is it possible to restrict access to my data to a set group of users?

There are two ways to restrict release of data through EDX.

  1. EDX's Collaborative Workspaces allow NETL-affiliated research teams to set up secure, private working environments for individual research teams/groups. The Collaborative Workspaces utilize role-based security and are intended to allow multi-organizational research teams to work on draft/working data products in a secure, online space. See the EDX Quick Guide for more information about Collaborative Workspaces.
  2. Data can also be restricted to EDX during the final data product contribution to the EDX database. In this process the contributor is asked two questions in the ACK that might limit or restrict distribution of the dataset:
  • Does the dataset have any licensing restrictions? This allows NETL-affiliated researchers to share via EDX commercial or other licensed (e.g. NDA etc) data and restrict it to a select group of users.
  • Is there a release date restriction? If so, how long does that restriction last? This helps to ensure that data is delivered to EDX during a project’s funded performance period (ensuring that NETL receives the data) and offers the research team that developed the data the chance to restrict it from public release while they publish, pursue IP, etc. The period of restriction should be tailored to the need of a given dataset on a case-by-case basis.


Overview

Inviting Others to Register for EDX

Top

Is there a template I can use to send out a mass e-mail to my work group inviting them to sign up for an account on EDX?

If you would like to use a template to send out a mass e-mail to your work group, Please click on the "Refer a Friend" button in the upper right or contact EDX Support at EDXSupport@netl.doe.gov.


Overview

Additional Help

Top

Who do I contact for any questions about EDX access or capabilities?
Why can't I find what I am looking for?

EDX content is comprised solely of data and links contributed to the system and shared with the public by users like you. If you cannot locate a file, there could be a variety of reasons, including the file has been removed by request of the original submitter or the file is under review by the EDX Support team. Alternatively, if the key words provided by the contributor are incomplete, your search may be challenged. Try modifying your search parameters to see if the file you are looking for is returned. If it is not, please contact EDX Support at EDXSupport@netl.doe.gov.

For any additional questions regarding access or capabilities please contact EDX Support at EDXSupport@netl.doe.gov


Overview

Activity

Top

What is Activity?

The activity feed provides a running log of actions that have occurred within the Collaborative Workspace.


Account Settings

EDX Username

Top

How do I recover my username?

Contact EDX Support at EDXSupport@netl.doe.gov


Account Settings

EDX Password

Top

How do I reset my password?

Go to the Log-in Page and click the "Forgot your password?" button. Enter your username and an email notification will be sent to you.


Account Settings

E-Mail Address

Top

How do I update my email address information?

Contact EDX Support at EDXSupport@netl.doe.gov


Account Settings

Contact Information

Top

How do I edit my contact information?

Your contact information can be edited on the Edit Profile page. This page can be accessed at the top right of each page next to the user’s avatar.


Collaborative Workspaces

Collaborative Workspace Overview

Top

What is a Collaborative Workspace?
Who can create a Collaborative Workspace?
Can I share private files with a unique members on EDX?
Can anyone see what I have in a Collaborative Workspace?

Collaborative Workspaces, the private side of EDX, supports DOE and NETL’s ongoing research efforts. This is a growth area for EDX. The system’s private side offers users a secure environment for collaboration and includes a growing suite of resources, tools, and other capabilities to support efficient and timely execution of research by NETL-affiliated research teams.

Only EDX members with {@netl.doe.gov} or {@contr.netl.doe.gov} e- mail addresses can create a Collaborative Workspace. However, any registered member of EDX can be added to a Collaborative Workspace.

  1. Collaborative Workspaces were created to support ongoing research and make it easy for teams to “publish” their products when the team is ready to share.
  2. Collaborative Workspaces provide a secure environment where NETL affiliated research teams can access and share resources needed for ongoing research. Collaborative Workspaces foster collaboration with team members inside and outside NETL (See Member Management).
  3. Within Collaborative Workspaces, registered EDX users can quickly and efficiently create private sharing environments and invite any registered user they want to their private workspace.
  4. When entering a Collaborative Workspace, users will see the same basic dashboard. Each workspace contains; submissions, activity, calendar, forum, folders, library, and Slate.
  5. Collaborative Workspaces can be used for single file transfers, like an ftp service, or for group collaboration.


Collaborative Workspaces

Recover a Deleted Collaborative Workspace

Top

I have accidentally deleted my Collaborative Workspace. Is there a way to recover it?

If you have accidentally deleted a Collaborative Workspace it can only be recovered by contacting EDX Support at EDXSupport@netl.doe.gov.


Collaborative Workspaces

Collaborative Workspace Member Management Overview

Top

What is member management?

Collaborative Workspaces provide a secure environment where NETL affiliated research teams can access and share resources needed for ongoing research. Collaborative Workspaces foster collaboration with team members inside and outside NETL (See Add Members to a Collaborative Workspace).


Collaborative Workspaces

Add Members to a Collaborative Workspace

Top

Does EDX have role-based security in its Collaborative Workspaces?
Need help adding new CW members?
Can I assign user roles in a CW?

Collaborative Workspaces offer the ability to add members to a secure, private sharing environment. Administrators can add additional members and assign privileges based on unique predefined user roles.

  1. Collaborative Workspace Administrators can add other members to their Collaborative Workspace by clicking the “Members” button, and then clicking the “Add Member” button.
  2. To search for registered users to add to your workspace, simply type the user’s first and last name and select the appropriate username. The username will appear below the search box.
At this point the Administrator can define the new member’s role level:
  1. Member – (Read Only Access) Members can only view/download submissions. They cannot add/edit/delete submissions, folders, or add/remove users.
  2. Editor – (Read/Write Access) Editors can add/edit/delete submissions and folders, but cannot add/remove users.
  3. Admin – (Full Access) Admins can add/edit/delete submissions and folders. Admins can also add/remove users.

  • Administrators can add as many members as they want to the Collaborative Workspace.
  • Administrators can also add multiple members assigned to the same member role. Simply search and click on the members or separate the member usernames by clicking enter, tab, or comma.
  • When all of the members have been selected hit the “add” button and the new members are added to the private sharing environment. The new members will receive an E-mail notification that they have been added to the Collaborative Workspace. Based on their assigned role level, members will have immediate access and use of the workspace.


Collaborative Workspaces

Change Collaborative Workspace Member Role

Top

Can I change user roles in a CW?

Collaborative Workspace Administrators can edit the member roles in their Collaborative Workspace by clicking the “Members” button, and then clicking the “Edit” button next to the member that needs their role changed.

  1. Select the new role from the drop-down list.
  2. Click on “Save”.
  3. The member’s role has now been updated.


Collaborative Workspace Submission

Collaborative Workspace Submission Overview

Top

What is a Collaborative Workspace submission?

Collaborative Workspace submissions are only shared with members of the designated Collaborative Workspace.


Collaborative Workspace Submission

Create a New Collaborative Workspace Submission

Top

How do I create a new Collaborative Workspace Submission?

Only EDX members with {@netl.doe.gov} or {@contr.netl.doe.gov} e- mail addresses can create a Collaborative Workspace. However, any registered member of EDX can be added to a Collaborative Workspace.

  1. Navigate to the Collaborative Workspace that you would like to create a new submission in.
  2. Click on the “+ Submission” button.
  3. Submissions require the completion of a 3 page metadata form (Attributes, Characteristics, and Keywords – ACK).
  4. Provide the appropriate information on page 1 of the ACK form.
  5. Click the “Next Add Data” button.
  6. Data can be added as an html link, api, or a file.

  7. Adding data as an html link
    • Provide the html link (url) in the resource field.
    • Provide any additional information as needed.

    Adding an API
    • Click on the “API” button.
    • Provide the html link (url) in the resource field.
    • Provide any additional information as needed..

    Uploading a file
    • Click on the “Upload Files” button.
    • Drag and drop your files into the window.
    • Provide any additional information as needed.

  8. At any time on page 2 of the ACK form you can click the “Save and Add Another” button to add additional resources.
  9. When you have completed page 2 of the ACK form click the “Next Additional Info” button.
  10. Provide any additional info needed on page 3 of the ACK form.
  11. Click “Finish” and your submission will be added to your Collaborative Workspace.


Collaborative Workspace Submission

Add New Resources to a Collaborative Workspace Submission

Top

How do I add new resources to a Collaborative Workspace Submission?

EDX allows an Editor or Administrator of a Collaborative Workspace the ability to add new resources to a Collaborative Workspace Submission.

  1. Navigate to the Collaborative Workspace that you would like to add a new resource to.
  2. Click on the Submission that you would like to add a new resource to.
  3. In the “Edit Resources” menu on the left click on the “Add New Resource” button.
  4. Add the new resource(s).
  5. Click “Add”.
Your new resource will be added to your submission.


Collaborative Workspace Submission

Edit a Collaborative Workspace Submission

Top

How do I edit a Collaborative Workspace submission?

EDX allows an Editor or Administrator of a Collaborative Workspace the ability to edit a Collaborative Workspace Submission.

  1. Navigate to the Collaborative Workspace that you would like to edit a submission in.
  2. Click on the Submission that you would like to edit.
  3. Click on the “Edit” button.
  4. Provide the information you would like to edit/modify/change.
  5. Click “Finish”.
Your submission will be updated with the edited content.


Collaborative Workspace Submission

Edit a Collaborative Workspace Resource

Top

How do I edit a Collaborative Workspace Resource?

EDX allows an Editor or Administrator of a Collaborative Workspace the ability to edit a Collaborative Workspace Resource.

  1. Navigate to the Collaborative Workspace that you would like to edit a resource in.
  2. Click on the Submission that contains the resource you would like to edit.
  3. In the “Edit Resources” menu on the left click on the resource you would like to edit.
  4. Provide the information you would like to edit/modify/change.
  5. Click “Save”.
Your resource will be updated with the edited content.
Your updated resource will now be the default version of the resource but you will always have access to previous versions.


Slate

Slate Overview

Top

What is Slate?

Slate allows designated members of a Collaborative Workspace to create custom wiki-style pages.


Slate

Create a New Slate Page

Top

How do I create a new slate page?

  1. To create a new Slate page click on the “Slate” tab.
  2. If no Slate pages exist for the Collaborative Workspace click on the “create one now” button.
  3. Users that are proficient with mark-down language or HTML can immediately begin to edit their new Slate page.
  4. For the less technical users, EDX provides a Slate template page.
  5. Click on the “Go to Slate Template page” button.
  6. Click on the “Use Template” button.
  7. Users must provide a title for their new Slate page.
  8. Users can edit the source code, and the page is immediately available for preview below.
  9. When users are finished editing, they can provide a reason why they made the edits and click the “save” button.
  10. The new Slate page becomes the default landing page for the Slate tab.
  11. Users may edit the page any time, or they can roll back to a previous version of the page.
  12. To edit a Slate page simply click on the “edit” button, make the appropriate changes, provide a reason for the changes and click “save”.
  13. To roll back to a previous version of the page click on the “history” button, locate the previous version you’d like to restore, and click restore.
Please note that any Slate Page can be designated as the default landing page for the Collaborative Workspace


Slate

Load Slate Page by Default

Top

How do I make a slate page load by default?
Can I make my Collaborative Workspace landing page be one of my slate pages?

Administrators of a Collaborative Workspace can assign any Slate Page as the default landing page for a Collaborative Workspace.

  1. Click on “Administrative Actions”.
  2. Click on “Edit Workspace”.
  3. Click on “Slate Settings”.
  4. Select “Yes” for “Load Slate Page by Default”.
Please note this only allows the slate page to load by default. To select the appropriate page to load by default please review the Assign Default Slate Page.


Slate

Assign Default Slate Page

Top

How do I assign a default slate page?

  1. Click on the “Slate” tab.
  2. Click on “All Pages” in the left menu column.
  3. Identify the page that you would like to make the default landing page and click on “Make Default”.
Please note any time a user accesses the Collaborative Workspace from the Workspaces tab it will load the Default Slate Page


Slate

Slate File Upload

Top

How do I upload files to Slate? Can I search for Slate files?

  1. Slate offers users the ability to perform a quick file upload.
  2. Click on the “Slate File Upload” button.
  3. Slate’s file storage system is for quick, small file transfers such as Word documents and PowerPoint presentations. These files are not indexed and are only visible on the specific Collaborative Workspace's Slate Files page. In other words, you cannot search EDX and find Slate files.
  4. Click on the “Browse” button and locate the file you want to upload.
  5. Select the file and click “upload”.
  6. The new file is loaded to the “Slate Files” page. Members of the Collaborative Workspace can download the Slate files at any time. In addition, members with the appropriate credentials can delete the Slate files at any time.
  7. In addition, the slate file is given a unique url that can be shared with other members of the Collaborative Workspace.
Please note: Slate files are not indexed and are only visible on the specific Collaborative Workspace's Slate Files page. In other words, you cannot search EDX and find Slate files.


Calendar

Calendar Overview

Top

What is the Calendar?

Collaborative Workspaces have a unique calendar that allows appropriate members the ability to create new calendar events and export the calendar to their preferred email account.


Calendar

Create a Calendar Event

Top

How do I create a calendar event?

  1. Click on the “Calendar” tab.
  2. Click on the “Administrative Actions” button and select “New Event” from the drop-down list.
  3. Provide the details of your event and click on “Add Event”.
  4. Your event will be added to your Collaborative Workspace calendar.


Calendar

Edit a Calendar Event

Top

How do I edit a calendar event?

  1. Click on the “Calendar” tab.
  2. Click on the event that you would like to edit.
  3. Click on the “Edit Event” button at the bottom of the page.
  4. Provide the updated information and click on “Save Event”.
  5. Your event will be added to your Collaborative Workspace calendar.


Calendar

Delete a Calendar Event

Top

How do I delete a calendar event?

  1. Click on the “Calendar” tab.
  2. Click on the event that you would like to delete.
  3. Click on the “Delete” button at the bottom of the page.
  4. You will be asked if you want to delete the event.
  5. Click “OK”.
Your event will be deleted from your Collaborative Workspace calendar.


Calendar

Bulk Calendar Changes

Top

How do I make bulk changes to a series of reoccurring EDX calendar events?

If you need to make changes to more than one calendar event within the same series, it is encouraged to delete the series of reoccurring events by selecting one of the dates and choosing “Delete All Events” button. This will delete all events in the series so that you can recreate the reoccurring event with the needed changes. If you would like to change details of a single event within the series, simply select that event and click the “Edit” button in the lower left of the calendar event details page and make your changes. Note that this will only update the information for that single event within the series.


Calendar

Export a Collaborative Workspace Calendar

Top

How do I export a Collaborative Workspace Calendar?

  1. Click on the “Calendar” tab.
  2. Click on the “Export Calendar” button.
  3. Once exported, a user can choose to open the calendar in their preferred e-mail or save the calendar as an .ics file.
  4. If saved as an .ics file the user can import the file into their preferred e-mail address.


Forum

Forum Overview

Top

What is a forum?

The forum allows members to communicate within their Collaborative Workspace.

  • Members can create a thread based upon a topic.
  • Other members of the Collaborative Workspace can reply to the topic.
  • The forum will record all responses and is always accessible within the Collaborative Workspace.
  • Users can also use the forums to store key links associated with the Collaborative Workspace.


Forum

Create a New Forum Thread

Top

How do I create a new forum thread?

  1. Click on the “Forum” tab.
  2. Click on “New Thread”.
  3. Provide a Title and post your content in the text box.
  4. Click “Post” and the thread will be posted in the Forum.


Forum

Respond to a Forum Post

Top

How do I respond to a forum post?

  1. Click on the “Forum” tab.
  2. Select the post that you want to respond to.
  3. Click “Post”.
  4. Provide the content you would like to post.
  5. Click “Post” and the reply will be posted in the Forum.


Folders

Folders Overview

Top

What are folders?

Collaborative Workspace users can use Folders to organize Collaborative Workspace resources.


Folders

Create a New Folder

Top

How do I create a new folder?

  • Members with the appropriate user role can create a new folder by selecting the Folders tab.
  • The member will then be prompted to provide a name for the new folder, check the root directory, and click on the “create” button.
  • The new folder will be created on the root directory of the Collaborative Workspace.
  • Users can create as many folders and sub-folders as they wish.
  • Users can also change the folder name, move datasets from one folder to another, move folders from one directory to another, and delete folders.

Please note that permissions are not set for each folder. All members of the Collaborative Workspace have access to all folders and sub-folders of the Collaborative Workspace.


Folders

Rename a Folder

Top

How do I rename a folder?

  1. Click on the “Folders” tab.
  2. Right-click on the folder to change its name.
  3. Type in the new folder name.
  4. Click Ok.
  5. The folder will be updated with the new name.


Folders

Delete a Folder

Top

How do I delete a folder?

  1. Click on the “Folders” tab.
  2. Right-click on the folder that you would like to delete.
  3. Click “Delete Folder”.
  4. The folder will be deleted.


Folders

Move Submissions from One Folder to Another Folder

Top

How do I move submissions from one folder to another folder?

  1. Click on the “Folders” tab.
  2. Click on the submission you would like to move.
  3. Drag and drop the submission into the folder you would like to move it to.
  4. The submission will now reside in the new destination folder.


Folders

Move Folders to Another Folder

Top

How do I move folders to another folder?

  1. Click on the “Folders” tab.
  2. Click on the folder you would like to move.
  3. Drag and drop the folder into the folder you would like to move it to.
  4. The folder will now reside in the new destination folder.


Library

Library Overview

Top

What is a library?

Library allows you to organize public submissions into a downloadable library.


Library

Add a Public Submission to a Workspace Library

Top

How do I add a public submission to a Workspace Library?

  1. On the submission page click on the blue “Add to my Library” button.
  2. Select the appropriate Collaborative Workspace from the drop-down list.
  • (Option #1) If you already have an existing Library you would like to add the submission check the “add to Existing Library” box.
  1. Select the appropriate Library from the drop-down list.
  2. Click the “Add to Workspace” button.
  3. Your submission will be added to your designated Collaborative Workspace Library.
  • (Option #2) If you do not have an existing Library you would like to add the submission to type the name of the new library in the “New Library Name” field box.
  1. Click the “Add to Workspace” button.
  2. Your submission will be added to your newly created Collaborative Workspace Library.


Library

Add a Public Submission to a Personal Library

Top

How do I add a public submission to a personal library?

  1. On the submission page click on the blue “Add to my Library” button.
  • (Option #1) If you already have an existing Library you would like to add the submission to select the appropriate Library from the drop-down list.
  1. Click the “Save in Selected Library” button.
  2. Your submission will be added to your designated Personal Library.
  • (Option #2) If you do not have an existing Library you would like to add the submission to type the name of the new library in the “New Library Name” field box.
  1. Click the “Add to New Library” button.
  2. Your submission will be added to your newly created Personal Library.


Library

Bulk Download From a Library

Top

How do I download multiple files from my library?

  1. Navigate to the Library you would like to perform a multi-file download from.
  2. To download the entire Library click on the “Download Library” button.


Library

Removing Submissions from a Library

Top

How do I remove submissions from my library?

  1. Navigate to the Library you would like to perform a multi-file download from.
  2. To remove a submission from your Library click on the “Delete” button next to the submission you would like to delete.


EDX Help Videos

EDX Search Video

Top

What is EDX Search? (Video)

Note: EDX is always evolving, therefore, some features in the tutorial videos may not accurately align with the current user interface. If you have any questions locating a feature described in the video, please contact us at EDXsupport@netl.doe.gov.


EDX Help Videos

EDX Contribute Video

Top

How do I contribute to EDX? (Video)

Note: EDX is always evolving, therefore, some features in the tutorial videos may not accurately align with the current user interface. If you have any questions locating a feature described in the video, please contact us at EDXsupport@netl.doe.gov.


EDX Help Videos

EDX Collaborative Workspace Video

Top

What are Collaborative Workspaces [CW]? (Video)

Note: EDX is always evolving, therefore, some features in the tutorial videos may not accurately align with the current user interface. If you have any questions locating a feature described in the video, please contact us at EDXsupport@netl.doe.gov.


EDX Help Videos

EDX Tools Video

Top

What are EDX Tools? (Video)

Note: EDX is always evolving, therefore, some features in the tutorial videos may not accurately align with the current user interface. If you have any questions locating a feature described in the video, please contact us at EDXsupport@netl.doe.gov.


EDX Help Videos

EDX Slate Video

Top

What is Slate? (Video)

Note: EDX is always evolving, therefore, some features in the tutorial videos may not accurately align with the current user interface. If you have any questions locating a feature described in the video, please contact us at EDXsupport@netl.doe.gov.


EDX Help Videos

EDX Groups Video

Top

What are EDX Groups? (Video)

Note: EDX is always evolving, therefore, some features in the tutorial videos may not accurately align with the current user interface. If you have any questions locating a feature described in the video, please contact us at EDXsupport@netl.doe.gov.