X

The Integration blog covers the latest in product updates, best practices, customer stories, and more.

  • January 22, 2020

Configurators - One stop solution for all your dependency configuration needs

Sindhu Suresh
Technical Lead

For those of you already familiar with the blog for Integration dependency configuration, we have something better to offer. The previous blog talks about replacing a connection dependency in the integration, with the another connection resource of the same role using Rest apis. We know how tedious handling rest apis can get, hence we have now come up with a snazzy UI do the same operation. This feature is available at the integration level and it has also been extended to work at Package level.  

Lets take a look at both, Integration Configurator and Package Configurator, in detail in the upcoming sections.

Integration Configurator

Prerequisite

Enable following feature:

  • oic.ics.featureflag.spa.designer (Integration designer pages)

To enable feature flags - Refer to Blog on Enabling Feature Flags in Oracle Integration

The minimum Oracle Integration version required for the feature is 191110.1400.32380.

Key Functionalities

As mentioned earlier, the integration configurator is a friendly UI built on top of the existing REST APIs(mentioned in the previous blog), that help users replace the dependencies in an integration, with some more added functionalities that elevate user experience. The functionalities are : 

  1. View all the dependent resources of an integration in one page 
    • Dependent Resources include Connections, Lookups, Libraries and PGP keys
  2. Edit all the dependent resources of an integration from one page 
    • Clicking on edit should take you to the corresponding edit page of the resource. Example Connection Edit Page, Lookup Edit page etc
    • Edit action is supported for all resources - i,e Connections, Lookups, Libraries and PGP keys
  3. Replace resources in the integration
    • A dependent resource can only be replaced by another resource of same type whose status is 'Configured'. We do not allow replacing with a Draft resource
    • Replace action is supported for Connection and PGP Keys.

Accessing Integration Configurator

There are 2 ways to launch the integration configurator:

  1. During Import of the integration

    While importing an integration, if the user wishes to configure the resources used by the integration, he can click on the 'Import and Configure' button in the Import Integration popup.

  2. From Actions Menu 

User can click on the 'Configure' action from the actions menu on the integration landing page as shown below.

       

 

The configure integration page comes up with information about all the dependent resources on the page. Please find detailed explanation about the numbered items in the image:

  1. Name of the connection/lookup/library resource used in the integration.
  2. If its a connection, then replace it with any of the other configured connection in the system that has the same connection role(Trigger/Invoke/Trigger and Invoke) as existing connection.  In case of PGP key, it will have to same type of PGP key. For example: a Public PGP key can only be replaced by another public PGP key and not a private PGP key.
  3. Other integrations using this resource in the entire instance. 
  4. Edit action for the resource on click of which you can navigate to the edit page of each of the resource, so you can configure it manually, instead of replacing.

 

Package Configurator

If you have understood Integration Configurator, mastering the Package Configurator will be a walk in the park. Package Configurator has the same features as Integration Configurator in addition to the package structure.

Prerequisite

Enable following feature:

  • oic.intg.uiapi.package.configurator  (Enable package configurator feature in UI and REST API )
  • oic.ics.featureflag.spa.designer (Integration designer pages)

To enable feature flags - Refer to Blog on Enabling Feature Flags in Oracle Integration

The minimum Oracle Integration version required for the feature is 200113.1400.33491

Key Functionalities

With the help of package configurator the user will be able to : 

  1. View the dependent resources present in any and all the integrations of a package -
    • Dependent Resources include Connections, Lookups, Libraries and PGP keys.
  2. View the corresponding related information of each of the dependent resource which includes status and usage information. 
    • Status is the status of the resource - Draft, Configured etc
    • The usage information essentially gives us info about how many integrations within the package are using this particular resource
  3. Configure the dependent resources present in any and all the integrations of a package. 

Configuring the dependent resources imply these two actions -  'Edit of the said resource' and 'Replace the resource with another resource'.

  1. Edit 
    • Clicking on edit should take you to the corresponding edit page of the resource. Example Connection Edit Page, Lookup Edit page etc
    • Edit action is supported for all resources - i,e Connections, Lookups, Libraries and PGP keys. 
  2. Replace 
    • Replacing a resource would replace it across all the integrations in a package.
    • A dependent resource can only be replaced by another resource of same type whose status is 'Configured'. We do not allow replacing with a Draft resource.
    • Replace action is supported only for Connection and PGP Keys.

Accessing Package Configurator

You can access the Package Configurator either 

  1.  At the time of import :  
                In the import package popup, the user will now have an option to 'Import and Configure'. Clicking on which will import the package and then redirect you to the package configurator page.

  2. From the action menu: 
              From the package landing page, user can open the action menu and select the Configure option. This will redirect the user to Package Configurator page.
     

Lets take a look at the example below and understand the details of using the package configurator. The package configurator can be broadly classified as having these 3 unique functionalities : 

  1. List of Dependent Resources :
                All the resources used In the package, samples.oracle.ups.package are listed below. We can see that there are 5 Connections, 3 Lookups and 1 Library being used.  We can also see the status of each of resource. 

  2. User Actions supported for each row : 

              On Hover of each resource, user is presented with 2 options-  Edit and Replace (for connections and certificates, and only 1 option if Edit for lookups and libraries).

              On Click Edit, it will take the user to the  corresponding resource's edit page. 

              On Click of replace, in connection row, the user will see a popup containing connections that are the same role as original connection. The user can choose the connection with which you want to replace. Upon choosing, the users changes will be saved in memory so they can move on to making other changes. The changes will be saved only when the user clicks on the Done Button on top right side.

  3. Details section for each row : 

                    Also, you can get more info about any of these dependent resources by clicking on expand button corresponding to the row of dependent resource. It will reveal the details section, which will have the information captured in the screenshot.

                 

 

                          If you have opted to replace a resource, then that information is also persisted in the details section under the header - 'The connection for the integrations in this package was changed from'. The user also has an option to revert the replaced resource to the original by clicking on the 'Revert' link next below the above mentioned header. 

                  

So this has been a brief explanation that will help in using the two Configurators. Hope you enjoy using it as much as we enjoyed building it!!

Be the first to comment

Comments ( 0 )
Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.