Skip to content

Create your first use case#

Let’s create an example use case to learn how to do it.

This process is divided into multiple steps, so you don’t need to have all the information at the very first moment.

You can allways modify your use case to complete it with more information as you have it.

These are the steps to add and complete the information of a use case:

  1. Create the use case
  2. Add the business information
  3. Add the scientific approach
  4. Add the technical details

1. Create the use case#

Let’s create an example use case to learn how to do it:

  1. Go to the section Use cases > My use cases through the left side menu.

    My use cases section in the sidebar menu

  2. Then, on the top-right corner, click on the Add new use case button.

    Add use case button

  3. You will get a form to fill the basic information about your use case:

    Add use case form

    Fill in all the required information:

    • Business sector: select any sector, Academic for example.
    • Name: Let’s write “My first use case” here.
    • Description: Write a short descriptive text: “Hello world use case used for learning purposes.”
    • URN: This is a unique URL path to access your use case through the API. Write something like “my-first-use-case”. Don’t use spaces or special characters that shouldn’t be present in URLs, such as these ones: “/”, “&”, “%”, “=”
    • Visibility: is always private to your organization by default.

  4. Finally, click the Add use case button.

After this step, you will be redirected to your use case details page, where you can add additional information.

2. Add the business information#

Once you have created your use case, you can add all the information needed for other users to understand your it, and for the solvers creators to be able to implement solvers for this use case.

The more complete this information, the easier for other users to implement solvers.

In your use case details page, click on the Business information tab and then on the Edit button on the top-right corner of the section.

Add the business information

A dialog window will open:

Add business information dialog

where you can fill the following six sections:

  • Business description
  • Current limitations and expected oportunities
  • Input data description
  • Output data description and representation
  • Best practices / Benchmarks / References to beat
  • Any other additional information

All these fields are allow you to write rich formatted text and also to paste images to better describe the use case.

You can fill some sample texts in them or leave them empty for now.

When you are done, click the Save button to save the content.

Info

You can modify these texts anytime if needed.

3. Add the scientific approach#

Let’s leave this section empty for now, as this is a an example use case.

4. Add the technical details#

In this section you have to describe your use case from a technical point of view.

This section will be mainly visited by the solvers creators to check the specific input and ouput data formats that they must follow. These input and ouput data format use JSON standard.

Again, let’s leave this section empty for now. The default input/ouput format will be used.

What you’ve learned#

And you’re done! Now you know how to add a use case to QCentroid Platform.

You also know that creating a use case and completing all the information takes these steps:

Create the use case

Add the business information

Add the scientific approach

Add the technical details

What’s next#

Create your first solver