Skip to main content

Resource Manager Extension

  • Updated

Index

  1. Introduction
  2. How it Works?
  3. Installation
  4. User Manual
  5. Support
  6. Demonstration Videos

 

Introduction

The Resource Manager has been designed to simplify and assist Blip users in creating customized resources within the platform. The creation of these resources is done in a simple and intuitive manner, eliminating the need to work with any JSON.

Despite the significant advantage and the possibility of having resources within the Blip platform to organize, standardize, and create content that can be easily used in the builder, the process of developing a JSON can often be cumbersome, time-consuming, and tiring depending on its size. But have you ever thought that with simple and basic actions, you could create a resource for use in building your intelligent contact without needing to deal with JSON? This is where the Resource Manager comes into play. Now you can rely on it to save time, enhance agility and improve organization. Furthermore, it allows you to import, export, and manage your resources easily and effortlessly.



How does it work?

The Resource Manager extension was developed with the aim of simplifying, assisting, and organizing the construction of resource contents within the Blip platform. It allows you to create various types of content without the need to worry about JSON. Through just a few clicks, the manager will take care of that for you.

The following functionalities are provided:

  • Registration of unique custom resources.
  • Registration of custom resource collections.
  • Possibility to register resources of different types, such as: text, selection, text list, object list, on/off, and files.
  • Import of resources and items using a JSON file.
  • Listing of registered resources.
  • Listing of items for each of the resources.
  • Addition of new items to a resource.
  • Export of items and/or structure of registered resources.

 

Installation

To make use of the Resource Manager extension, you need to access the contract in which you wish to install it. Then, navigate to the Blip Store, open the Extensions tab, and search for "Resource Manager." Once you locate it, activate and install the extension.Once activated and installed, the extension will be ready for use.

 

User Manual

Users with administrator permissions have the capability to perform all functions of the extension, encompassing the registration of customized resources of various types, as well as the import and export of resources, items, and structures.

Upon successful installation and activation of the "Resource Manager" extension, provided that the user possesses administrator privileges, upon accessing it, they will immediately be able to employ the extension and will be greeted with the following interface:




On the initial screen of the extension, all registered resources will be displayed in a list. Through this interface, you will already be able to perform various actions, such as: registering a resource, copying their primary keys, editing them, deleting them, or accessing the data of each one. Additionally, you can import new resources or even use one of them as a reference for registering a new one through exporting. It is important to exercise caution when editing data and, especially, when deleting items, as the actions are permanent. However, don't worry, in this tutorial, we will guide you through each of these actions.

Furthermore, we recommend watching this presentation video of the extension, as it will provide you with a better understanding before proceeding with the usage manual:

Resource and Item Registration

In this stage, you will learn how to register a new resource, customized to your specific needs. Upon creation, it will be displayed in the list of resources, allowing you to access and manage its items. Additionally, you have the option to register new items.

 

Creating Resources

Step 1) On the main screen of the Resource Manager extension, you should click on "Create Resource," as illustrated below:





Once done, you will be able to see a modal where you can register your resource, as shown in the example below:




Now that the modal has appeared for you, it's important to fill it out according to your desired objective.

 

Step 2) Provide the name of your resource in the "Name" field. This name will be used solely for organized visualization.

Step 3) In the "Key" field, input the name of the key you wish to use for your resource. The input in this field will be used to retrieve the content value via the server.

Step 4) After filling out the two previous fields, you will need to select the type of resource to be created. This can vary between a collection (resource collection) or a single (individual resource), as shown in the image:




The process of registering both types is quite similar, but to eliminate any uncertainties, you can gain a better understanding of these two types through the following videos:

 

Collection Type Resource:

Single Type Resource:

Step 5) With that done, you can now input the desired fields for your resource, such as "Title," "Key," and "Type." In this context, the "Title" field will be used for naming purposes only, the "Key" field is utilized to retrieve the content value via the server, and the "Type" field allows you to choose from various field types, including text, selection, text list, object list, on/off, and file. As shown below:


 

How do each of the field types function?

All field types have some distinguishing characteristics, but share a common feature: they can all be utilized.

 

Text Field Type

When choosing to register a resource with a text field type, you can input the desired text within the resource. Later on, you'll be able to use this text within your intelligent contact by referencing the key of the registered resource through the appropriate variable responsible for Blip's resource control. This type inserts text into the JSON.





Selection Field Type

Opting to register a resource with a selection field type allows you to input the desired options within the resource. When you proceed to register an item for the resource, you can then select one of the provided options during creation. This type inserts text into the JSON.


 

List of Text Field Type

When registering a resource with a list of text field type, after registering, simply click on "Access Data," as advised for all resources that require selection and later additions. Once done, click on the edit button. This will open a modal where you can add elements to your list. It's worth noting that this resource type inserts an array of texts into the JSON. If you need to add another element to the list, simply click on "Add."




When you feel ready, simply click the "Done" button, and your list of text will be stored.




Once done, you will soon be able to view your list.


 

Object List Field Type

If you wish to register a resource with an object list field type, you will be inputting an array of objects into the JSON. As soon as you set the type, the modal will expand, also presenting the fields of the object for you to fill in, as shown in the image:


To fill in these details, simply follow the process outlined earlier and have an understanding of the field types. If you want to add another object, just click on "New Field" within the square referring to it, as shown below:


 

On/Off Field Type

The On/Off field refers to a boolean-type field, with values of true or false, active or inactive. By choosing to use it, you will be inserting a boolean value into the JSON, which can be utilized in various ways. For instance, you could use it to determine whether to conduct a satisfaction survey at the end of a conversation or not.





After inputting the necessary information and completing the registration, you should click on "Access Data" for the desired resource. From there, you'll be able to enable or disable the field, resulting in true (enabled) or false (disabled), as shown in the example below:





File Field Type

It's no surprise that there's some effort involved in uploading a file to a drive, then editing it, and finally being able to use it in Blip. However, your troubles are over! When choosing to register a resource with a file field type, you can upload the desired file. Once it's registered, you can use the link directly from within Blip.


After registering the file field type, simply click on "Access Data" for your resource and then click on the pencil icon to edit it.




Right after, a modal will appear where you should click on the button below to upload your file:


As soon as you upload your file, you will have a link to it:





Once done, simply click on "Done," and the file will be registered, and the link will be ready for use.




There you go, now that you are familiar with the resource types, just fill them out correctly to proceed to the next step.

Step 6) Now, with the resource data filled out, simply review the information. If everything looks good, just click on "Done," and your resource will be registered.

Your resource will then be available in the viewing list.





Registering Items

Step 1) To register items in your resource, you need to click on "Access Data" for the desired resource, as shown in the image:


 

Step 2) Once done, simply click on the "Create Item" button:

 



After clicking on "Create Item", you will encounter a registration modal that follows the fields of the resource type you created earlier.

 

Step 3) Fill in the modal fields according to the desired item and click on "Done," as shown in the image below:


Once completed, you will be able to see the registered item in its respective resource.




Importing and Exporting Resources and Items

By following this path, you can import resources and items using a JSON file, which can be constructed by you or even exported from our extension. To assist you, refer to the following tutorial:

Even after watching the video, if you still have any questions, just follow these steps:

 

Importing Resources

Step 1) On the main screen, click on the "Import" button, as shown in the image below:




Step 2) Once you click on "Import," an import modal will appear, as shown in the image:




In this case, you can input your JSON in two ways, as presented: by dragging it into the modal or by clicking the suggested link and selecting the desired JSON.

Step 3) Once you've added the desired JSON, you have two options: "Cancel" and "Done." If you wish to halt the procedure, simply click on "Cancel," as shown in the image:


If you want to proceed with the import and your JSON is in the correct format, click on "Done," as follows:

 

If your JSON is in the correct format, it will be successfully imported, and you will be able to view it.





Importing Items

You can use import files to add new items to your resource. They will be processed and immediately added to your item list.

Step 1) To import items to your resource, you need to click on "Access Data" for the desired resource, as shown in the image:


Step 2) Once done, simply click on the "Import Items" button:





After clicking on "Import Items" you will encounter an import modal. You can drag and drop your JSON into it or click on the displayed link.

Step 3) Place your JSON in the modal, as shown below:


If you've selected the wrong file, you can click on the trash can icon next to it to remove it. However, if your JSON is in the correct format, simply click on "Done" and your items will be added to your resource. See the example below:


 

Exporting Resources

In this step, you will learn how to export resource data to use in another location or even import it into another resource at any time. You can choose to export only the items, only the resource structure, or both. Upon exporting, a JSON file will be created, and a download will start automatically.

Step 1) To export items from your resource, you need to click on "Access Data" for the desired resource, as shown in the image:




Step 2) Once done, simply click on the "Export" button:





Step 3) After clicking on export, you will need to choose what you want to export. You can select from options such as "Items and Structure," "Structure Only," and "Items Only," as shown in the modal below:




After this step, you will be able to see the exported file in your downloads.

 

Extras

In addition to what you have seen in the tutorial, below are some basic examples of buttons also used.

To delete a resource:





To copy keys from a resource:




To edit a resource:




To visit the documentation:


 

Support

If you have any questions or encounter any issues with the extension, please contact us via email at blippartner@sharkdev.com.br or at the number +55 (35) 98802-9321.

 

Demonstrative Videos

You will be able to view demonstrations in the videos below:

 

For more information, visit the discussion on the subject in our community or the videos on our channel. 😃

Related articles