This article guides you through the Workspace menu in AgentRunner, explaining how to customize your workspace settings to best suit your needs. Whether you're looking to personalize your workspace or configure important settings, this guide will walk you through each step.
Accessing and Navigating the Workspace Menu
The Workspace menu is your central hub for configuring your AgentRunner environment. You can access the workspace menu from anywhere within the AgentRunner platform, except while you're in the agent editor. The workspace menu allows owners and developers to change the workspace name, add a domain, provide descriptions, and define the timezone for the workspace. These customizations help personalize the workspace and configure important settings. The workspace menu is designed for easy navigation and intuitive use, enabling you to quickly adjust settings without disrupting your workflow.
Key Settings in the Workspace Menu
Once you've accessed the Workspace menu, you will find several key settings that you can customize:
Workspace Name: Change the name of your workspace for better identification.
Domain: Add your company or personal website domain.
Short Description: Provide a brief description or slogan for your workspace.
Timezone: Set the timezone to synchronize the time of agent logs.
Long Description: Add a detailed description of your company or your work.
Each of these settings plays a crucial role in personalizing and configuring your AgentRunner workspace.
User Roles and Permissions
It's important to understand that not all users have the authority to modify workspace settings. Only owners and developers are granted the necessary permissions to make changes in the Workspace menu. This ensures that critical settings are not accidentally altered by users without the proper authorization. If you find that you are unable to modify certain settings, verify that you have the appropriate role (owner or developer).
Customizing Workspace Details
The Workspace menu in AgentRunner allows you to tailor your environment by changing the workspace name, adding a domain, providing short and long descriptions, and setting the timezone. These customizations help personalize your workspace.
Changing the Workspace Name
You can modify the name of your workspace to reflect your company or project. To change the workspace name:
Navigate to the Workspace menu.
Locate the "Workspace Name" field.
Enter the new name for your workspace.
Click the "Save changes" button to apply the new name.
Tip: It’s advised to set a name that reflects your company or website for easy identification. Workspace names do not need to be unique, allowing you to use similar names across different workspaces if needed. Outcome: The workspace will now be identified by the new name you provided. This change will be immediately visible throughout the AgentRunner platform, making it easier to distinguish between different workspaces.
Adding Your Domain
Adding your domain helps in branding and can be useful for future integrations. To add a domain to your workspace:
Go to the Workspace menu.
Find the "Domain" field.
Enter your company’s or personal website’s domain.
Save your changes by clicking the "Save changes" button.
Note: Adding a domain is optional. You can add only one domain to a workspace. Removing a domain has no consequences. Outcome: Your workspace will now be associated with the specified domain. This can be helpful for verifying ownership and setting up custom integrations.
Adding Descriptions
You can add both a short and a long description to your workspace to provide more context and information.
Short Description
The short description serves as a quick summary of your workspace. To add a short description:
Access the Workspace menu.
Locate the "Short Description" field.
Enter a slogan, motto, or short sentence describing your workspace.
Click "Save changes" to apply the short description.
Tip: Use a concise and catchy phrase to capture the essence of your workspace. Outcome: The short description will be displayed in various areas of the AgentRunner platform to provide a quick overview of the workspace.
Long Description
The long description allows you to provide more detailed information about your company or your work. To add a long description:
Navigate to the Workspace menu.
Find the "Long Description" field.
Write a detailed description about your company or yourself and your work.
Format the description and add emoticons to personalize it.
Save your changes by clicking the "Save changes" button.
Note: You can format the long description with rich text (e.g., bold, italics, lists, links). Outcome: The long description will be available for users who want to learn more about the workspace and its purpose.
Setting the Timezone
Defining the timezone ensures that agent logs are displayed synchronized. To set the timezone for your workspace:
Go to the Workspace menu.
Find the "Timezone" dropdown menu.
Choose your timezone from the list.
Click the "Save changes" button to save your timezone selection.
Tip: The agent logs will be displayed in the workspace’s timezone. You can modify the timezone as many times as you’d like. Outcome: All agent logs within the workspace will now be displayed in the selected timezone, ensuring consistent time-related data.
Saving and Managing Changes
After making any changes to your workspace settings, it’s essential to save them to ensure they are applied correctly. Additionally, understanding the limitations and impacts of these changes is important for maintaining a smooth workflow.
Saving Changes
After making adjustments to the workspace name, domain, descriptions, or timezone, you must save your changes by clicking the "Save changes" button. This action ensures that all modifications are applied and reflected across the AgentRunner platform. If you neglect to save your changes, they will be lost, and the workspace will retain its previous settings. The "Save changes" button is typically located at the bottom of the Workspace menu.
Outcome: All the changes you’ve made will be saved and applied to your workspace settings. Recommended Visual: A screenshot showing the location of the "Save changes" button within the Workspace menu.
Limitations and Considerations
While the Workspace menu offers significant flexibility in customizing your environment, it’s important to be aware of certain limitations and considerations:
User Roles: Only owners and developers have the necessary permissions to make changes in the Workspace menu. If you do not have these roles, you will not be able to modify the settings.
Domain: You can add only one domain to a workspace. There is currently no support for adding multiple domains.
Frequency of Changes: There are no limitations on how often you can change the workspace name, domain, descriptions, or timezone, provided you have the appropriate permissions.
Impact of Changes: Changing the workspace name has no impact on existing users, links, or integrations. The primary purpose of the workspace name is for identification within the AgentRunner platform.
Note: Changes to the workspace settings are generally immediate, but it’s always a good practice to verify that the changes have been applied correctly. Outcome: You should be able to efficiently manage and customize your AgentRunner workspace without encountering unexpected issues. By understanding these limitations and considerations, you can avoid common pitfalls and ensure a smooth and productive experience.
