Capsules - FAQ

See the answers for questions related to Capsules.
To help you to make the most out of the use of Capsules, we've gathered the most frequently asked questions about this new Digibee HIP Platform resource.

What are Capsules?

Capsules are a new and great Digibee feature, part of the Digibee HIP Platform.
Digibee Capsules are reusable components that can be used or created by any user of the Platform by applying the same visual development model designed in the pipeline creation, providing a reusable, secure, validated and evolving business logic.
A Capsule allows the flow integration to be published in the components palette to be used at another time, in a simplified and even faster way.

What features are resolved by the Capsules?

The essence of the Digibee Capsule is to present sets of ready, tested and validated integrations for the market to have a better internal or external connection in a documented way. It allows a company to modernize its IT and its partner companies to use offers with security and simplicity.
Think, for example, of an organization where there’re several relevant data flows for all areas - authentication, customer inquiry, stock inquiry, among others. For these flows it’s possible to create pipelines that distribute the services, but it’s also necessary to document, catalogue and maintain the deployed pipeline.
Making flows from any part of a pipeline more accessible allows you to set broader business goals. That's why we've created this functionality that brings flows together and makes them reusable and self-documented just like our core components. That way, the flows become easier to use and well-known throughout your organization - all it takes is to directly consult the component palette.
The Capsules have the core components of the Digibee HIP Platform, which means, they have all the features delivered by them.

How are the Capsules built?

The Capsules can be built by the organization itself, that defines all the parameters, the data flow and business within the context of your project in a documented way. The Capsules can also be created by Digibee and its partners and made available for use.
When the client builds the Capsule, it can define parameters, documentation and interface, on top of being able to provide use guidance. The freedom to build the Capsules comes with all these features and the documentation remains inside the component itself.

Can I use the Capsule in my ecosystem of partners and customers?

Yes. It’s possible to have Capsules with ready integration between the system of a company and its partner. The Capsules can also be reused for other partners with similar use cases.
For example, a bank can use a ready-to-use micro-credit Capsule with the POSs of different pharmacy chains.

Is the Capsule secure to share my sensitive data with?

Yes. Digibee Capsules and Platform have a myriad of features to protect your data in transit and at rest when they’re under our responsibility.
For being embedded within an organization's pipeline, the Capsules are executed in isolation, even within your own organization. In addition, the Capsules are executed in a shared environment and never individual.

Are the Capsules compatible with the information demand of my legacy?

Yes. The Capsules are built from the core components of the Digibee HIP Platform, which are used in the pipelines - all its features are registered inside them.

Do Capsules help in the migration of systems to the cloud?

Yes. When a cloud migration process takes place, it’s very important to have coexistence strategies with on-premise. By incorporating the Capsules in this strategy, it’s possible, for example, to develop solutions that register data on premise, in the cloud or both.
In addition, Digibee has a great variety of Capsules of native cloud solutions at your disposal.

Do Digibee Capsules provide support to broaden my business system?

Yes. Digibee has a Delivery team, specialized in Capsules, and will support all clients during the construction and development process of projects for each organization, including the creation of public Capsules (made according to the company's request).

What’s the Capsules use limit in my pipelines?

The Platform doesn't impose a quantitative limit of components that can be used in the pipeline, whether they are core or Capsules. However, the pipeline has limits such as amount of concurrent executions, timeout and controlled capacity in the deployment when SMALL, MEDIUM or LARGE is chosen.

How many Capsules can be created?

You can create as many Capsules as you need.

Why is it necessary to inform a Capsule output contract?

As the Capsules are reusable components in pipelines, we use the JSON Schema specification output contract to ensure that the pipelines have clarity and security of response information.
In addition, the output contract also supports the automation of the Capsule versioning (see the answer to the question How does the Capsules versioning and maintenance work? How can I guarantee that my business will not be affected?).

How do I use Accounts inside the Capsules?

Accounts are functionalities used by core components (such as SAP, for example) to perform authentication on endpoints. To use an Account, just find the list of Accounts in the pipeline canvas, which come directly from the Realm and are managed in the Settings > Accounts menu.
In the Capsules, this functionality has a small difference in relation to the pipeline that will use it, since Accounts and pipelines aren’t always in the same Realm of construction. Therefore, it’s necessary to previously define a list of Accounts Placeholders. This list can be defined in the Capsules screen by clicking on:
Screen Settings > Accounts tab
In the screen described above will be defined the Accounts with Label and the description to guide on the type of Account that should be selected within the pipeline canvas.

How can I identify which Capsules are created by Digibee?

The Capsules created by Digibee are identified with the Certificated icon (check symbol in blue). See below how to identify it:

What are the differences between the Capsules and the Libraries?

The Libraries were a trial version created by Digibee to learn about the concept of reuse in the Digibee HIP Platform. The Capsules contemplate all the learning collected in the experience with the Libraries and are available in these modes:
  • Edition
  • Versioning
  • Strategy for the use of Accounts
  • Documentation
  • Parameterizing configurations form

Can Capsules be published for other clients?

No. The Capsules have a myriad of permissions that are managed by Digibee. These permissions determine which users can make a Capsule public.

Can customer partners publish public Capsules?

No. This configuration isn’t available yet, but is being evaluated for future opportunities.

Are Capsules with the same functionality being used by different clients/companies restricted?

Yes. Capsules are restricted to each company that’s using them.

How does the Capsules versioning and maintenance work? How can I guarantee that my business will not be affected?

To ensure reliability in the Capsules updates, Digibee has adopted a versioning control composed of 3 levels. When the versions need to be updated, the Digibee HIP Platform analyzes a Capsule automatically and determines which will be the values of the levels.
These are the 3 versioning levels:
  • Major: Capsule version when a configuration item (input or output) is removed or becomes mandatory. This version is also applicable when the Capsule contract is totally modified. The direction for this version is made automatically by the Platform itself.
  • Minor: Capsule version when a configuration item (input or output) is added or becomes optional. This change isn’t considered "Major" yet.
  • Fix: version of the Capsule when minor changes are made in the pipelines that use it. This change isn’t considered "Major" or "Minor".
It’s important to know that these changes will only be made if the version going through the change has already been published. For example, if you create a Capsule, it will initially receive the version "1.0.0". As long as it’s not published, this version will never be modified when updates are made to it.
After the publication of the Capsule, the version "1.0.0" will be defined as not editable. Then, when a new update is made in the same Capsule, the Platform will analyze what has been changed to determine if the version number will be added in the Major, Minor or Fix version.

How does the process of updating the Capsules in my pipelines work?

The Digibee Integration Platform never makes direct changes to the structure or information of deployed pipelines. Therefore, we never affect a pipeline without an authorized user in your organization doing a new deployment.
As we need to help in the simplified distribution of the Capsules, we adopted the following strategy:
By including a Capsule in your pipeline, you are associating it with the "Major" or "Minor" version of the Capsule (as quoted in the example of question How does the Capsules versioning and maintenance work? How can I guarantee that my business will not be affected?).
But if you ask yourself where the "Fix" version went, know that a pipeline always automatically receives the most recent "Fix" version when a new deployment is made or when the test mode is run on the canvas pipeline screen. As mentioned earlier, the "Fix" version is changed only when the change doesn’t impact the pipeline. Pipelines aren’t affected or updated by "Major" or "Minor" versions of a Capsule that is part of their compositions. To use this Capsule, an Integration Analyst responsible for the pipeline must perform the application manually.

What does it mean to publish a Capsule?

When the construction of a Capsule is finished, it must be published so that it becomes accessible on the pipeline canvas screen. To perform this action in the list of Capsules, follow these steps:
  • Access the Capsule Menu;
  • Click on the rocket icon or on the Capsule Canvas screen;
  • Click on the Publish button;
  • Click on the Save button.
Note: if none of the above options is displayed, consult your company's access manager and request the inclusion of the permission CAPSULE:UPDATE:PUBLISH.

Is there a governance process for Digibee Capsules?

Yes. All open components go through the quality and security processes that guarantee the same standards applied to the core components of the Digibee HIP Platform.

How do I control the access to the Capsules within my organization?

We have created a set of permissions dedicated to this functionality, through which you can control the specific functions, allowing complete management of your Capsules life cycle.
These are the permission divisions:
  • Creative permissions
CAPSULE:CREATE:HEADER - allows the registration of new headers to be used in the creation of Collections.
CAPSULE:CREATE:GROUP - allows the registration of new groups to be used in the creation of Capsules.
CAPSULE:CREATE - allows the creation of new Capsules and Collections.
  • Editing Permissions
CAPSULE:DELETE - allows the archiving of existing Capsules.
CAPSULE:UPDATE - allows the edition of existing Capsules.
  • Special Permissions
TEST-MODE:EXECUTE:CAPSULE - allows the execution of tests in Capsules in the Capsules screen.
CAPSULE:UPDATE:PUBLISH - allows the publication of Capsules to be used by other users.
  • Reading Permissions
CAPSULE:READ - allows the visualization of the Capsules in the Capsule Menu.
CAPSULE:READ:GROUP - allows the visualization and choice of a group to register a new Capsule.
CAPSULE:READ:HEADER - allows the visualization and choice of a header for registering a new collection.
CAPSULE:READ:CONSUMER - allows the use of Capsules inside the pipeline canvas.

Why can't I use Object Store and Digibee Storage inside a Capsule?

These components are native resources of your Realm. Therefore, they're automatically authorized for being in the controlled context of the Realm. Since a Capsule can be built to be used by other Realms, it's not possible to authorize the access to data from these components inside the Capsule.