Onboarding ARES Kudo hosted by Graebert

Getting Started with ARES Kudo Hosted by Graebert

To begin working with ARES Kudo Server, hosted by Graebert in a cloud environment, follow these steps:

1. Accessing ARES Kudo Environment:

   • Upon receiving access, log in to the ARES Kudo environment provided by Graebert. This will grant you access to the ARES Kudo platform.

2. File Repositories Setup:

   • Prepare two different file repositories:

     • Customization Files Repository: This repository will store all files related to UI, configurations, plugins, and other customizable settings for ARES..

     • Content Files Repository (CAD Files): This repository will contain CAD files and other related content files that will be used in ARES.

       These repositories can be hosted by Graebert or managed by the customer on their own AWS S3.

3. Integration with S3 Buckets:
   ARES Kudo, hosted by Graebert, is equipped with APIs to connect with S3 buckets associated with the X-API-KEY.

   • Graebert-Hosted S3 Buckets:

     • If your S3 buckets are hosted by Graebert, they will be configured in advance before you receive the X-API-KEY.

   • Customer-Hosted S3 Buckets:

     • Set up the required policies for your AWS S3 buckets.

     • Provide us with the bucket names so we can link them to your X-API-KEY.

4. Using Your Own API Server:

   • Instead of utilizing S3 buckets for content files, ARES Kudo Server offers the flexibility to communicate with your own API server.

   • Your API server can manage reading and writing files from/to the data backend.

   • Refer to the documentation titled "API Server: Connecting ARES Kudo to a data" for detailed instructions on integrating your API server with ARES Kudo.

Cloud Environment

Using ARES Kudo Developer Studio for Cloud Environment

To utilize ARES Kudo Developer Studio in a cloud environment, follow these steps to create a token using the Token generator and pass it as a parameter to access the editor:

1. Generating a Token:

   • Access the Token generator provided by Graebert.Process to request token

   • Use your X-API-KEY to authenticate and generate a session token.

   • Ensure that the parameters required for your use case, such as backend servers and authentication details, are configured appropriately.

   • Generate the token using the Token generator tool.

2. Passing the Token to ARES Kudo Editor:

   • Once you have obtained the token, you need to pass it as a parameter when accessing the ARES Kudo Editor.

   • Use the following URL format to access the editor with the generated token:

     https://editorURL/editor?apitoken={token}

   • Replace editorURL with the URL of the ARES Kudo Editor.

   • Replace {token} with the token generated using the Token generator.

Token Validation and Drawing File Opening in ARES Kudo Editor

In the ARES Kudo Editor for cloud environments, the editor validates the session token internally to ensure security and authenticity. Once validated successfully, the editor retrieves all relevant parameters from the token and proceeds to open the specified drawing file. Here's how the process works:

1. Token Validation:

   • When the ARES Kudo Editor receives a request with a session token, it internally validates the token to ensure its authenticity and validity.

   • The validation process includes checking the integrity of the token, verifying its expiration status, and confirming that it was generated using the correct X-API-KEY.

2. Fetching Parameters from Token:

   • Upon successful validation, the ARES Kudo Editor extracts all necessary parameters from the token.

   • These Parameters may include authentication details, backend server information, user permissions, and other relevant configurations required to access and interact with the drawing file.

3. Opening the Drawing File:

   • With the retrieved parameters, the ARES Kudo Editor proceeds to open the specified drawing file.

   • The editor leverages the information obtained from the token to ensure seamless access to the drawing file while maintaining the security and integrity of the session.

4. User Interaction:

   • Once the drawing file is opened within the editor, users can interact with it as needed.

   • They can perform various actions such as viewing, editing, annotating, and saving changes to the drawing file directly within the ARES Kudo Editor interface.

Accessing ARES Kudo Developer Studio:

1. Open a web browser and navigate to the URL constructed in the previous step.

2. The ARES Kudo Developer Studio should now be accessible with the privileges and configurations associated with the generated token.

3. You can now begin developing and customizing your applications within the ARES Kudo environment.

Check the video below to understand the architecture of Ares Kudo workflow.

Open