Skip to content

Commit

Permalink
refine draft
Browse files Browse the repository at this point in the history
migrate workspace management into explore section
  • Loading branch information
rpietzsch committed Aug 1, 2023
1 parent 3c0e292 commit 5c88ab5
Show file tree
Hide file tree
Showing 20 changed files with 115 additions and 110 deletions.
1 change: 1 addition & 0 deletions docs/explore-and-author/.pages
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
nav:
- Explore and Author: index.md
- Workspace Selection and Configuration: workspace-configuration
- Graph Exploration: graph-exploration
- Vocabulary Catalog: vocabulary-catalog
- Thesauri Management: thesauri-management
Expand Down
1 change: 1 addition & 0 deletions docs/explore-and-author/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ icon: material/star
hide:
- toc
---

!!! info inline end ""

![Your are here](overview-explore.drawio.png "You are here")
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
92 changes: 92 additions & 0 deletions docs/explore-and-author/workspace-configuration/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
icon: eccenca/application-config
status: new
tags:
- KnowledgeGraph
---

# Workspaces

The specific configuration of the application defines which options are available here, i.e. whether you can select one of several workspaces, access only a default workspace or are allowed to create own workspaces.

## Select a workspace

To select a workspace click on the **user icon** on the right side of the page

![User menu](user.png){ class="bordered" }

Click the drop-down list and click the workspace you want to open.

![Workspace selector](workspace.png){ class="bordered" }

!!! success "Step Result"

The workspace opens and now you can enable or disabled the modules and change modeule configuration as per your requirement.

![Configuration module de-/activation](enable.png){ class="bordered" }

## Configure a workspace

Click on the **user icon** on the right side of the page then click on **Configuration**.

![Configuration module](configuration.png){ class="bordered" }

Click on **Workspace** then select the workspace you want to see the details.

![Select workspace to configure](select-workspace.png){ class="bordered" }

Click on down arrow to expand the **Workspace** and **DI Workspace Configuration** to see the configuration details as shown below.

![Configuration module settings](details.png){ class="bordered" }

## Add a Workspace

Click on the **user icon** on the right side of the page then click on **Configuration**.

![Configuration module](configuration.png){ class="bordered" }

Click on **Workspace** on the left side of the page then click on **Create New Workspace**

![Create workspace](create-new-workspace.png){ class="bordered" }

Type the **Id** and **Label** name then click on **Add**

![Add new workspace](add-workspace.png){ class="bordered" }

!!! success "Step Result"

The workspace created sucessfully and now you can enable or disabled the modules and change modeule configuration as per your requirement.

![Workspace created](enable.png){ class="bordered" }

!!! note

Refer to the system manual of eccenca DataManager to get more information on all the options that can be configured here.

## Delete a workspace

Click on **User Icon** on the right side of the page then click on **Configuration** then click on **Workspace**

![Create workspace](create-new-workspace.png){ class="bordered" }

Select the Workspace from the drop-down you want to delete

![Select workspace to configure](select-workspace-1.png){ class="bordered" }

Click on the **Delete Icon** on the right side of the page.

![Delete selected workspace](delete.png){ class="bordered" }

Click on **Delete**

![Delete confirmation dialog](delete-select.png){ class="bordered" }

!!! success "Step Result"

The workspace has been deleted.

![Deletion result](delete-stepresult.png){ class="bordered" }

!!! note

When you delete a workspace, no graphs or Build projects are deleted.
File renamed without changes
File renamed without changes
File renamed without changes
Binary file removed docs/getting-started/configuration-1.png
Binary file not shown.
Binary file removed docs/getting-started/create-new-workspace-1.png
Binary file not shown.
129 changes: 20 additions & 109 deletions docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,21 @@ eccenca Corporate Memory is a semantic data management software that accelerates

The main features of Corporate Memory include:

- Flexible metadata and schema layer based on knowledge graphs
- Data virtualization and analytics
- Data integration and indexing
- Dataset and vocabulary management
- Thesaurus and taxonomy management
- Big data scalability
- Access control
- Flexible metadata and schema layer based on knowledge graphs
- Data virtualization and analytics
- Data integration and indexing
- Dataset and vocabulary management
- Thesaurus and taxonomy management
- Big data scalability
- Access control

### Minimal requirements

For the best user experience, we recommend to use the newest version of Google Chrome or Mozilla Firefox. Corporate Memory is tested with the following browsers:

- Google Chrome 83 or later
- Mozilla Firefox 78 or later
- Microsoft Edge 83 (on Windows) or later
- Google Chrome 83 or later
- Mozilla Firefox 78 or later
- Microsoft Edge 83 (on Windows) or later

## Login and Logout

Expand All @@ -53,97 +53,9 @@ To log out, open the menu :material-dots-vertical: in the Module bar and click

## Workspaces

A workspace is an endpoint of an eccenca DataPlatform identified by a workspace name and the DataPlatform URL.
The specific configuration of the application defines which options are available here, i.e. whether you can select one of several workspaces, access only a default workspace or are allowed to create own workspaces.


For more information on workspace configuration refer to the system manual of eccenca DataManager.

### Selecting a workspace

To select a workspace click on the **user icon** on the right side of the page

![image](user.png)

Click the drop-down list and click the workspace you want to open.

![image](workspace.png)

!!! Step Result

The workspace opens and now you can enable or disabled the module as per your requirement.

!!![image](enable.png)



### To Know the Workpspace name and configuration


Click on the **user icon** on the right side of the page then click on **Configuration**.

![image](configuration.png)

Click on **Workspace** then select the workspace you want to see the details.

![image](select-wprkspace.png)

Click on down arrow to expand the **Workspace** and **DI Workspace Configuration** to see the configuration details as shown below.

![image](details.png)

### Adding a New Workspace

Click on the **user icon** on the right side of the page then click on **Configuration**.

![image](configuration-1.png)

Click on **Workspace** on the left side of the page then click on **Create New Workspace**

![image](create-new-workspace.png)

Type the **Id** and **Label** name then click on **Add**

![image](add-workspace.png)

!!! Step Result
The workspace created sucessfully and now you can enable or disabled the module as per your requirement.

![image](enable.png)

!!! note

Refer to the system manual of eccenca DataManager to get more information on all the options that can be configured here.


### Deleting a workspace

Click on **User Icon** on the right side of the page then click on **Configuration** then click on **Workspace**

![image](create-new-workspace-1.png)

Select the Workspace from the drop-down you want to delete

![image](select-workspace-1.png)

Click on the **Delete Icon** on the right side of the page.

![image](delete.png)

Click on **Delete**

![image](delete-select.png)

!!! Step Result

The workspace has been deleted.
![image](delete-stepresult.png)

!!! note

When you delete a workspace, the graph data is not deleted.

This section describes the main elements of the graphical user interface of eccenca Corporate Memory.
See the [workspaces](../explore-and-author/workspace-configuration/) section for more details.

## User interface and modules

Expand All @@ -152,19 +64,19 @@ The user interface of Corporate Memory usually consists of two sections:
1. The module bar providing access to the various modules of Corporate Memory and to a menu with further options
1. The main section for operating the software functions

![image](statistic.png)
![Graph statistics view](statistic.png)

Each module provides a set of functionalities and views for specific use cases.
To access a module, click the module name. The active module is highlighted.

By default, Corporate Memory provides the following modules:

- EXPLORE - for Knowledge Graph browsing and exploration, specifically
- [Knowledge Graphs](../explore-and-author/index.md) - a generic and extensible RDF data browser and editor
- [Vocabularies](../explore-and-author/vocabulary-catalog/index.md) - for vocabulary management
- [Thesauri](../explore-and-author/thesauri-management/index.md) - for managing thesauri and taxonomies based on SKOS
- [Queries](../explore-and-author/query-module/index.md) - a SPARQL query interface
- [BUILD](../build/index.md) - for creating and integrating Knowledge Graphs, with specific links to
- EXPLORE - for Knowledge Graph browsing and exploration, specifically
- [Knowledge Graphs](../explore-and-author/) - a generic and extensible RDF data browser and editor
- [Vocabularies](../explore-and-author/vocabulary-catalog/) - for vocabulary management
- [Thesauri](../explore-and-author/thesauri-management/) - for managing thesauri and taxonomies based on SKOS
- [Queries](../explore-and-author/query-module/) - a SPARQL query interface
- [BUILD](../build/) - for creating and integrating Knowledge Graphs, with specific links to
- Projects - the BUILD Projects level
- Datasets - the Datasets across all BUILD Projects
- Workflows - the Workflows across all BUILD Projects
Expand All @@ -176,9 +88,9 @@ By default, Corporate Memory provides the following modules:

Use the provided search field(s) in each module to search for specific keywords or strings in names and labels of resources.

The **EXPLORE** module provides more search fields (e.g. in the Graph box, Navigation box, etc.) where you can limit your search to specific graphs or resources.
The **Knowledge Graphs** module provides more search fields (e.g. in the Graph box, Navigation box, etc.) where you can limit your search to specific graphs or resources.

![image](demograph.png)
![Explore graph sample](demograph.png)

### Settings menu for table views

Expand Down Expand Up @@ -231,4 +143,3 @@ This section provides an overview of icons and their functionality in Corporate
| ---- | ----------- |
| :material-folder: | Object mappings. |
| :material-file: | Value mappings. |

1 change: 0 additions & 1 deletion overrides/.icons/eccenca/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# eccenca icon set

Based on [@eccenca/gui-elements](https://github.com/eccenca/gui-elements/), this directory holds all icons used in eccenca Corporate Memory.

1 change: 1 addition & 0 deletions overrides/.icons/eccenca/application-config.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5c88ab5

Please sign in to comment.