Working with Admin Portal

Understand how to use webMethods.io Embed Admin portal to deploy smart integrations to your application website.

Accessing the Admin Portal

The webMethods.io Embed Admin portal allows you to integrate with your website or application.

To access the webMethods.io Embed Admin portal, log in to your webMethods.io Integration tenant account, click on the App Switcher icon, and select webMethods.io Embed from the list of options that appear.

You are redirected to the webMethods.io Embed Admin dashboard.

At the top of this dashboard, you can see seven main menus:

Now let’s understand these menus in detail.

Environment

webMethods.io Embed provides two types of environments that you can set for your Embed Admin: Sandbox and Production. Using the drop-down icon given below the Environment menu, you can switch between these environments and manage their respective settings.

Projects

You can create custom workflows under your Embed Admin projects, submit those projects as solutions on Embed Admin, and publish those solutions on to your application, to make them available to some or all app users. Users can then import any of these solutions to their personal account and use them as per their requirements.

The Projects menu lets you do the following:

Creating or updating projects

To create a new project, perform the following steps:

  1. Click on the + New Project button.

    You are prompted to provide a name for the project and add/select tag(s) you want to associate with the project.

  2. Click Create once you have entered the details.

    This creates a new project in your webMethods.io Embed Admin account.

You can now start creating Workflows within this project and can make changes to the pre-existing project workflows. All the configurations such as certificates, triggers, webhooks, parameters, associated with your project workflows are listed under the Configurations tab.

Creating and publishing solutions

You can submit your existing projects as solutions to webMethods.io Embed Admin and publish those solutions on your application to enable them for your users.
To do so, perform the following steps:

  1. Locate the card associated with the project you want to submit as a solution, and click on the vertical ellipsis icon in the top-right corner. From the list of options that appear, click the Create Solution option.

    Note: Only projects containing workflows with either a webhook or service trigger can be published as a solution.

    A Create Solution dialogue box appears on screen.

  2. Enter the relevant details to create a solution.

    If your workflow contains a webhook, an additional checkbox field Add as Command appears in the Create Solution window.

    Commands are webhook-enabled workflows which are used to create interactive bots.

    Solution Name: Provide a suitable name for the solution.

    Reuse Associated Project’s Tags: Select this checkbox if you want to preserve the tags assigned to this project and reuse them for the solution.

    Tags: Add/select tag(s) you want to assign to this solution.

    Add as Command: Select this checkbox if you want to add this solution as a command.

    Publish Now: Select this checkbox if you want to automatically publish the solution (or command) to Sandbox environment after creation. If you select this checkbox, you will need to provide input for the following field:

    • Select Bot(s) to which this solution should be added: Select the bot(s) to which you want to add this solution.

    • Description: Provide a short description for the bot.
  3. Click create to create the solution.
Based on the inputs provided, this either creates a solution/command or creates and publish the solution/command.

Updating existing solutions

You can also update the details of an existing solution.
To do so, perform the following steps:

  1. Locate the solution and click on the vertical ellipsis icon. From the list of options that appear, click the Update Solution option.

    A new dialogue box appears where you can make relevant updates to your solution.

  2. Provide updated values for the applicable fields of the solution.
  3. Click Update to update the details of the solution.

Solutions

The Solutions tab lets you view and manage the existing solutions of your webMethods.io Embed Admin portal.

This page contains a list of the existing solutions (published and unpublished) along with the following details:

You can also use the search field located at the top-right corner of the page to search solutions by their names or filter out solutions using tag(s) by clicking the filter icon.

Managing solution versions

Each time you update an existing solution, a new version of that solution is created. You can access all the versions associated with any particular solution by clicking on the solution name.

This redirects you to the Versioning screen.

This screen contains the following columns:

Managing user deployments

Each time a solution is instantiated by a user, an instance of that solution is created against their name and is added to the Users tab. From here, you can view which user has instantiated a particular solution how many times and delete user instance associated with a solution.

This page contains the following columns:

Monitor

The Monitor menu lets you track and monitor the overall Workflow and FlowService execution status, and user activities of your Embed Admin portal. The Monitor screen has two tabs:

Note: Any time stamp displayed in webMethods.io Embed is based on the user’s registered time zone specified in Software AG Cloud. Note that not all the time zones in Software AG Cloud are supported in webMethods.io Embed. If a time zone in Software AG Cloud is not supported, then the time stamp in webMethods.io Embed defaults to the Pacific Standard Time (PST) time zone. To change the time zone for a user profile, using the App Switcher, go to My Cloud and in Software AG Cloud, click My Cloud > Administration. On the Administration page, edit the user profile. Under Locale Information, select the required time zone. Save the changes, log out, and then again log in to see the changes.

Execution Results

The Execution Results tab provides a quick overview of the statistics associated with the Workflow executions and FlowService executions (if enabled) along with their respective execution logs.

Let’s understand the options available under Execution Results.

Dashboard

Note: This option is visible only for tenants where FlowServices feature is enabled.

The Dashboard option offers you a consolidated view of all Workflow and FlowService execution status for the selected time period along with a graphical representation for the same.

You can fetch the execution data for a specific duration by selecting the relevant time frame option given on the top-right corner of the screen.

You can also view the detailed execution logs for each successful/failed Workflow and FlowService by clicking on the relevant figures as shown below:

This takes you to a new screen where you can click the relevant Workflow or FlowService name to view the detailed execution log associated with it.

Workflow Execution

The Workflow Execution option lets you view and monitor workflow execution-related data in a detailed graphical format.

You can click on the workflow name to view the detailed execution information of a workflow.

Additionally, you can download the workflow execution logs by clicking the Export Logs button.

FlowService Execution

The FlowService Execution option lets you view and monitor FlowService execution-related data in a detailed graphical format.

Note: This option is visible only for tenants where FlowServices feature is enabled.

Just like Workflow Execution panel, here you can click the name of the executed FlowService to view the detailed execution logs associated with it.

Additionally, you can download the FlowService execution logs by clicking the Download Logs button.

General

The General tab allows you to view, track, and monitor your webMethods.io Embed tenant activities through the Audit Logs and view the current month’s transaction usage statistics for your transaction-based tenants. It has following options:

Audit Logs

The Audit Logs tab lets you view the records of all activities performed by the Embed Admin tenant users. It keeps track of the tasks and changes performed by the users of your tenant. It maintains a history of all the actions that are performed within the tenant, including details such as the type of action performed, user performing the action, and time.

Activity Logs

The Activity Logs tab lets you view the sequence of all the activities related to the workflows and FlowServices of your account. The log records include details such as the timestamp, project name, title, execution details, execution status, as well as an option to view the detailed log.

To view log associated with any workflow or FlowService, click relevant the View Log button.

Here, you can click the Webhook/Trigger Payload key to view the webhook/trigger payload used in the workflow.

You can also export the execution logs of a specific workflow, by clicking the Export Logs button.

Settings

The Settings menu lets you configure the webMethods.io Embed Admin settings. When you click on the Settings menu, you can see the various configuration options which enable you to create and manage plans, users, connectors, bots, and admin settings for your webMethods.io Embed Admin portal.

Let’s look at these options in detail.

Plans

The Plans tab lets you create custom plans for your application users. There are two types of plans:

  1. Individual: The Individual plan lets you define the total number of transactions an individual user can execute. This plan can then be assigned to one or more users.

    For example, suppose a user plan ‘Plan 1’ has a transaction limit of 100 transactions. When you assign this plan to user A and user B, they both can execute up to 100 transactions each.

    Using Plans tab, you can create multiple Individual plans.

  2. Group: A Group plan can contain one or more users. The ‘Group’ plan lets you define the total number of transactions that can be executed by a number of users belonging to the same group.

    For example, suppose a Group plan, ‘Plan 2’ has a transaction limit of 200 transactions. When you assign this plan to 5 users, all of them can jointly execute up to 200 transactions.

    Moreover, all users added under the same group plan can access each other’s assets (integrations, connections, etc.) in the embedded application.

    Using Plans tab you can create multiple Group plans.

Adding new plans

To add a new plan, perform the following steps:

  1. Click on the Add Plan button at the top-right corner of the Plans screen.

    A new window will appear.

  2. Provide the details for a new plan.

    Name: Provide a unique name for the plan.

    Plan Code: Provide a unique ID for the plan.

    Plan Type: Select the type of plan (‘individual’ or ‘group’) you want to create.

    If you select individual, you need to also specify if you want to set this plan as the default plan for all users, in the Default Type field.

    Transactions: Specify the transaction limit for this plan.

    Note: The transactions allocated to a plan cannot exceed the total transaction limit of your webMethods.io Embed tenant. For example, let’s say your webMethods.io Embed tenant has a transaction limit of 1000 transactions. When you create a new plan under this tenant, the transactions allocated to the plan cannot exceed 1000 transactions.

    Limitation Type: Select the limitation type you want to associate with the plan.

    • If you set Solutions as the limitation type, you need to select the solution(s) you want to make available under this plan in the Solutions field that appears.
    • If you set Solution Tags as the limitation type, you need to select the solution tag(s) in the Solution Tags field that appears. When you do this, all the solutions associated with the selected solution tag(s) are made available under this plan.
    • If you select Connectors as the limitation type, you need to select the connector(s) you want to make available under this plan in the Connectors field that appears.

    Once you have entered these details, click Add. This creates the specified plan.

Editing or deleting plans

You can also edit or delete an existing plan. To do so, navigate to Settings > Plans.

You can see a list of existing plans associated with your application, along with the following details:

Click on the Edit or Delete options to modify or delete the plan from Embed Admin.

Users

You can add, view, and manage users of your application using the Users tab. To do so, navigate to Settings > Users.

Adding new users

To add a new user, perform the following steps:

  1. Click the Add User button located at the top-right corner of the Users screen.

    The Add Embed User window appears on screen.

  2. Provide the required details to add a new user.

    Email ID: Enter the email ID of the user you want to add.

    Plan Type: Select the type of plan (individual/group) you want to assign to the user.

    Plan: Select the plan you want to assign to the user.

  3. Click on Add button.

This adds the user to the list of webMethods.io Embed users. Now when you navigate to the Users screen, you see the following details associated with the added user.

Metrics

The Metrics tab lets you view the usage statistics of your Embed enabled application/website. When you click on the Metrics menu, you can see the following tabs:

Let’s know more about these tabs in detail.

Execution Overview

This section gives you an overview of the execution and transaction usage statistics for your Embed admin portal.

Transaction used

This section gives the graphical information of the total number of transactions used by your Embed Admin account over a period of time (in days).

Total Usage

This section shows the total number of transactions used out of the allocated monthly transactions.

Top Active Integrations

This section gives you the list of integrations that consumed most transactions.

Top Active Groups

This section gives you the list of groups that consumed most transactions.

Top Active Users

This section gives you the list of email IDs associated with the users who consumed most transactions.

Filter-based Execution Details

You can alternatively view the execution statistics associated with specific plans, solutions, and users associated with your Embed Admin account. To do so, navigate to Metrics > Filter-Based Execution Details page.

Setting Custom Time Frame

You can specify a custom time frame (up to one month) to fetch the execution details associated with it. To do so, click on the date picker icon and set the required time frame.

Adding Filters

You can add filters to fetch the execution logs associated with specific plans, solutions, and users. To do so, click on the Add Filter button. A new filter field appears in the window.

Once this is done, click on the Apply Filter button. You can see the execution graph for the selected filters.

Alerts

The Alerts menu lets you set up alert notifications for your total tenant transaction usage and daily transaction usage.

Usage Alerts

You can enable alerts to receive notifications whenever your total allocated tenant transactions are close to being exhausted/already exhausted. These alerts are sent for the following scenarios:

Note: Your tenant executions are not stopped till your tenant consumes 180% of its allocated transitions. Any overage usage is charged separately for your tenant. After 180% of allocated transaction consumption however, all your tenant executions are stopped.

To enable alerts for your tenant, click on Alert menu.

Once this is done, click SAVE.

You can add/remove email addresses in the alert list any time in the future. You can alternatively delete the alert or disable alert for your tenant.

Daily Statistics Alerts

You can set up daily statistics alerts to receive notifications about the daily usage statistics for your tenant.

To enable Daily Statistics Alerts, navigate to Alerts > Daily Statistics Alerts.

Once this is done, click SAVE .

You can add/remove email addresses in the alert list any time in the future. You can alternatively delete the alert for your tenant by clicking the Delete icon.