TABLE OF CONTENTS

• Creating a Workspace
  • Creating a workspace through CafeX UI
  • Creating a workspace through Workspace Creation Service
    • Step 1: Configuring workspace fields
    • Step 2: Updating the default value for the field
    • Step 3: Configuring the service name
    • Step 4: Assembling the link to be shared
• Passing URL Parameters to an existing workspace

CafeX Workspaces function as containers within an App, designed to store and manage data and content for specific groups and activities. Each Workspace belongs to a single App, allowing for the effective organization of content. By organizing content into separate Workspaces, you can ensure that different teams or activities within the same App are managed effectively.

Creating a Workspace

There are two primary methods  to create a workspace in CafeX:

1. Through the CafeX UI: This method allows users to manually create a Workspace directly within the CafeX platform.
2. Through the Workspace Creation Service: This method provides a more streamlined process, allowing users to create a Workspace via a generated link without needing to navigate through the CafeX Platform. This approach is particularly useful when you want to simplify the user experience or when other applications, such as IVR systems or job queues, need to initiate the creation of the Workspace.

Creating a workspace through CafeX UI

To create a workspace through the CafeX UI:

1. Navigate to the App Overview page.
2. Click the Create a Workspace button located at the lower left-hand side of the screen.
3. Enter the necessary Workspace details. If you have already configured Workspace fields, be sure to specify their values.
4. Check the Advanced options to apply advanced settings to the Workspace.
5. Optionally, activate the Private toggle to restrict Workspace access.
6. Click Create Now.

Upon creation, the platform will direct you to the Workspace Overview page.

Creating a workspace through Workspace Creation Service

The Workspace Creation Service provides an effective alternative for creating Workspaces. This service allows for the creation of Workspaces via an authenticated URL that takes parameters and passes them to the App. This is particularly useful when you want to simplify user access, enable users to quickly access the App, or when external applications need to initiate Workspace creation. 

Prerequisite: Ensure that the App and Environment have already been created before following the instructions below. For guidance on how to do this, refer to Adding a new App  and Adding an Environment articles.

Creating a workspace through the Workspace Creation Service involves the following steps:

1. Configuring workspace fields
2. Updating the default value for the field 
3. Configuring the service name
4. Assembling the link to be shared

Step 1: Configuring workspace fields

Workspace fields serve as the URL parameters that will be passed to create the Workspace. Configure a workspace field as described in the Workspace Fields article.

Step 2: Updating the default value for the field

When a Workspace is created using a URL parameter, the value passed will populate the default value for the corresponding field.

To update the default value:

1. Navigate to the App Builder > Designer editor and select the component associated with the field you want to modify.
2. In the Appearance and Configuration tab, click Configuration.
3. Under Fields, locate the field you want to modify and click to expand its properties. 
4. For Default value, specify the value in the following format: {{workspaceLabels.yourField}}, where yourField is the name of the Workspace field you created in Step 1.
    

Step 3: Configuring the service name

The service name is a unique identifier that appears in the URL shared with users. It helps distinguish this particular app among others on the platform. 

To configure a service name:

1. Navigate to the App Overview page and click Templates.
2. Locate the Basic Workspace template and click the Edit () button.
   
3. Click the Show information panel icon () at the top right-hand corner of the screen.
4. Click Configure. 
5. Click the Configure Workspace button.
    
6. Under Workspace Creation Service, specify the Service Name.
    
7. Click Update.

Step 4: Assembling the link to be shared

The final step involves putting together the URL that will be shared with users. The link format is as follows:

https://app.cafex.com/be/api/create/workspace/{service-name}/{environment}?{workspace-field=value}

• Replace {service-name} with the service name configured in Step 3.
• Replace {environment} with the name of the targeted environment.
• Replace {workspace-field=value} with the Workspace field configured in Step 1 and its value that is to be passed.

For example, 

https://app.cafex.com/be/api/create/workspace/spacecraft-search/PROD?spacecraft=orion

Passing URL Parameters to an existing workspace

You can include dynamic query parameters to pass additional data into the application. These parameters must be prefixed with p_ to be recognized by the system. These parameters will be accessible in the application using the expression {{app.urlParams.paramName}}.

For example,

https://app.cafex.com/be/api/create/workspace/spacecraft-search/PROD?spacecraft=orion&p_mission=apollo

In this case:

• The spacecraft parameter is passed as a Workspace field.
• The p_mission parameter is passed dynamically and can be referenced in the app using {{app.urlParams.mission}}.