Categories

Find answers to some of the most common questions in webMethods.io Integration.

Projects

How can I delete my project?

To delete a project, do the following:

  1. Locate the project you want to delete.

  2. Click on the vertical ellipsis icon (or three tiny dots) located beside the project name and click Delete.

Can I share my project with other users?

No. The feature is currently not available.

I am unable to create a project with a project name Default.

In each tenant, a system-generated Default project is already available. You cannot create another project with the same name.

I am unable to create a project.

This could be due to one of the following reasons:

Can a user with custom role create, update, or delete a project?

No. A user with custom role cannot create a new project, nor can the user update or delete the accessible projects.

Where are my project files stored?

By default, the project files are stored in an internal Git server managed by Software AG. For tenants enabled with Develop Anywhere, Deploy Anywhere capability, you can also store them in GitHub. For more information, see GitHub Repository for Projects.

Can I store my Develop Anywhere, Deploy Anywhere project files in another external Git provider?

No, you can store your assets only in GitHub.

Can I use an existing GitHub repository that already contains other files to store my

Develop Anywhere, Deploy Anywhere projects?

No, you should always associate your projects with an empty GitHub repository.

What should I do if the personal access token for the GitHub account where I store my assets has expired?

Go to the account alias in Settings > Version control and edit the GitHub account with the expired token.

Where are my project files stored?

By default, the project files are stored in an internal Git server managed by Software AG. For tenants enabled with Develop Anywhere, Deploy Anywhere capability, you can also store them in GitHub. For more information, see GitHub Repository for Projects.

Can I store my Develop Anywhere, Deploy Anywhere project files in another external Git provider?

No, you can store your assets only in GitHub.

Can I use an existing GitHub repository that already contains other files to store my Develop Anywhere, Deploy Anywhere projects?

No, you should always associate your projects with an empty GitHub repository.

What should I do if the personal access token for the GitHub account where I store my assets has expired?

Go to the account alias in Settings > Version control and edit the GitHub account with the expired token.

Is there a best practice for setting up Git package or project naming?

Yes. The name of the repository must be in the format, RepoNameProject, where RepoName indicates the name of the repository and must start with an uppercase letter. Ensure that the repository name must be same as the name that you are going to use for your new project.

How are the access permissions provided to a user for a project?

Currently, the project access permissions are not supported for Develop anywhere, deploy anywhere capability. Only administrators can restrict the project access for users. Hence, users who do not have access to the project cannot add or remove packages to that project.

Workflows

Does my workflow gets timed out after a certain period?

Yes. The default timeout period for every workflow is 3 minutes.

Does my workflow has any memory limit?

Yes. Default memory limit for your workflow is 256 MB.

Can I submit my workflows to webMethods.io Integration Recipe?

Yes. Click here to learn how to do it.

How can I delete my existing triggers and accounts?

You can delete accounts created under a specific project by going to the Configurations > Workflow > Connections page.

You can also delete the triggers set up under a specific project by going to the Configurations > Workflow > Triggers page.

What if I do not find the connector, action, or trigger I need?

If you do not find a specific connector, action, or trigger, you can either create them yourself using the Node.js block (for creating actions) or Connector Builder (for creating connectors, actions, and triggers) features.

Alternatively, you can get in touch with Software AG Global Support with your requirements. We will add the required connectors/actions/triggers for you.

Can I restore a deleted workflow?

No, deleted workflows cannot be restored. You can optionally export business-critical workflows to your local machines and then import them later in case you accidentally delete a workflow from your tenant.

I’ve successfully created an SMTP connection in a Flow service, but when I try to set up a new connection with the same details in a workflow, it fails. What are the troubleshooting steps to resolve this issue?

When creating an SMTP connection in a workflow, on the Add Account page, choose one of the following options based on your security requirements:

  1. For a secure connection:

    • Set the value for the Port field to 465.

    • Set the value for the Secure field to true.

  2. For a non-secure connection:

    • Set the value for the Port field to 25 or 587.

    • Set the value for the Secure field to false.

How to set a custom context ID for a particular workflow?

To define a custom context ID for a specific workflow, do the following:

  1. In a workflow, drag and drop the Set Context ID action listed in the Connectors panel on the right-hand side of the canvas.

  2. Double-click the Set Context ID icon. A window appears where you can optionally change the name of the action. Click Next.

    The Set Context ID configuration window appears.

  3. Configure the action by defining a unique identifier for the workflow. Once this is done, click Next.

Flow services

What are Flow services?

The Flow services feature enables you to create complex integrations that require advanced data transformation and custom logic implementation. Here you can easily build a Flow service by adding steps and selecting the constructs including Connectors, Controls, Flow services, and Services from within the steps. The Flow services editor is visually enhanced to offer ease of use and is very interactive. Flow services currently supports a wide range of connectors and comes with several built-in services that makes your job easier. Flow services provide you with rich data mapping capabilities, a familiar debugging mechanism, a large collection of built-in services, and more.

A Flow service mainly has two parts:

What are the differences between Workflows and Flow services?

Workflows and Flow services enable you to automate and optimize tasks based on a set of predefined rules and business logic. These features give you the power to connect apps, devices, and on-premises systems with only clicks and zero code. Although Workflows and Flow services help you to accomplish the same goal, there are significant differences between both the features.
Click here for information on the differences between Workflows and Flow services.

How do I enable Flow services?

Flow services are made available by default for all tenants.

What is Smart Mapping?

Smart mapping provides you with recommendations while mapping the pipeline data and utilizes a series of algorithms to determine the likely accuracy of a given suggestion, enabling you to toggle between high, medium, and low levels of mapping confidence. A Machine Learning (ML) algorithm is applied to provide the suggestions. The ML algorithm learns from the mappings you create and provides suggestions automatically to map similar fields. The algorithm benefits from having more data from more number of users.
Click here to learn more.

How do I change the time zone for a user profile in webMethods.io Integration. The Execution Results and Execution History are shown in PST. Is there a place where I can configure the time zone preference?

Using the App Switcher, go to Software AG Cloud and in Software AG Cloud, click Administration. On the Administration > Users 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.

Note that any time stamp displayed in webMethods.io Integration is based on the user’s registered time zone specified in Software AG Cloud. Not all the time zones in Software AG Cloud are supported in webMethods.io Integration. If a time zone in Software AG Cloud is not supported, then the time stamp in webMethods.io Integration defaults to the Pacific Standard Time (PST) time zone.

What are Conditional Constructs?

Conditional steps are those steps that perform different actions based on the result of evaluated conditions/expressions. Types of conditional constructs include:

What are Transformers?

The purpose of transformers is to accomplish multiple data transformations on the pipeline data in a single step as compared to using normal steps one after another. Transformers are services that are inserted into and run within a Transform Pipeline step. Transformers act as a collection of normal steps embedded in a single Transform Pipeline step.
Click here to know more about transformers.

How do I create a Flow service?

Click here for information on how to create a Flow service.

How can I trigger the execution of a Flow service from an external system?

webMethods.io Integration allows you to trigger the execution of a Flow service from an external system. This option provides you with another way to trigger Flow service executions from a software application, for example, a REST client, apart from manual and scheduled executions from the user interface.
Click here to know more.

How do I debug a Flow service?

Click here for information on how to debug a Flow service.

I cannot copy text into a Flow service from an external source in the Firefox browser.

When using Firefox, you may encounter a limitation where copying text into a Flow service is not possible.

To overcome this limitation, follow these steps:

  1. Open a new Firefox browser window.

  2. Type about:config in the address bar and press Enter.

  3. In the search bar at the top, enter dom.events.testing.asyncClipboard to locate the specific configuration setting.

  4. Double-click on the dom.events.testing.asyncClipboard entry to modify its value.

  5. Set the value to true.

  6. Close the about:config tab and return to the Flow service interface.

You should now be able to successfully copy text into Flow service.

I successfully created an SFTP connection using password authentication within a workflow, but when attempting the same configuration within a flow service, it fails with the following error message: Failed to save the account with given details. Error: Cannot retrieve the host public key. Details: Corrupt or unknown public key format. What is the issue?

The host public keys from Azure are available as provided in the following link: https://learn.microsoft.com/en-us/azure/storage/blobs/secure-file-transfer-protocol-host-keys.

These keys come in various types, including ecdsa-sha2-nistp384, ecdsa-sha2-nistp256, rsa-sha2-512, and rsa-sha2-256. However, when attempting to create the SFTP connection within a Flow Service, none of these keys appear in the “Preferred Key Exchange Algorithms” section.

As a workaround, utilize the ecdsa-sha2-nistp256 host key provided by Azure and modify the key type to “ssh-rsa”, as demonstrated below:

ssh-rsa AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBBmVDE0INhtrKI83oB4r8eU1tXq7bRbzrtIhZdkgiy3lrsvNTEzsEExtWae2uy8zFHdkpyTbBlcUYCZEtNr9w3U=

Save this modified key in a file and use the file as a Custom Host Public Key.

Connectors and Developer Tools

Where can I find the list of connectors supported by webMethods.io Integration and information on the Account configuration fields?

You can find the list of predefined connectors supported by webMethods.io Integration under the Connectors section. You can also create custom connectors using the Connector Builder - Node.js CLI or using the Connector Builder for webMethods CloudStreams.
See Troubleshooting tips on Account configurations for some of the most common scenarios you may come across while configuring an Account.
See Account configuration fields for information on the connection configuration fields.

See the Tech Community tutorials related to connectors to browse through the connector related tutorials.

What is the maximum size for object storage in Flow Store, Memory Store, and Account Store?

The maximum data size for a single object in Flow Store, Memory Store, and Account Store is 16 MB.

Can I call one workflow from another workflow?

Yes, you can do this by using the the Run Flow action.

Can I build my own actions?

Yes. You can build your own actions for a particular service using the Node.js block or Connector Builder.

Why do I get “The provided host name is not valid. Provide a valid host name” error while configuring the SOAP connector despite whitelisting the required IPs in the SAP system?

This issue is observed due to the usage of a WSDL URL associated with a private host that webMethods.io Integration cannot access from AWS DE (Amazon Web Services Development Environment). To address this issue, we recommend exposing the WSDL via a Public IP or host, thereby ensuring accessibility from AWS.

You will be redirected to the Test action window, where you can check if the action is working as expected before executing the workflow. After this, click Done. This will redirect you to the canvas.

We have developed an integration that creates a zip file, serializes it, and sends it to Azure Blob Storage via an HTTP request. However, the receiving service is rejecting the file stream we are trying to send, claiming it is corrupt. Could you please resolve this issue?

webMethods.io Integration supports two distinct integration platforms named workflow and Flow service, and file streaming between these platforms is not supported. Your current integration involves using the SFTP action, which is part of the workflow, and an HTTP operation, which is part of Flow service. This incompatibility is the reason you are encountering the problem. It is recommended that you use the SFTP and HTTP operations within the Flow service to resolve this issue.

APIs

What does the “Invalid XML” error indicate while attempting to import a WSDL for creating a SOAP API?

To address this issue, ensure that the WSDL file you are using contains the required XML declaration at the beginning. The XML declaration should be in the following format:

<?xml version="1.0" encoding="UTF-8"?>

How to invoke a private REST API using webMethods.io API Gateway?

  1. Initiate contact with the support team to enable the Private API capability for your tenant.

  2. Coordinate with the support team to establish the private link and obtain the secondary host (internal domain) designated for the private link.

  3. Develop private REST or SOAP API or designate existing API as private.

  4. Obtain the Swagger JSON or YAML for the created or designated private REST API.

  5. Click Create Alias to generate an Alias in webMethods.io API Gateway corresponding to the secondary domain, and then select the Technical information option.

    Important: Append -internal to the alias created.

  6. Create an API in the API Gateway using the downloaded Swagger JSON or YAML.

  7. Go to Policies and modify the routing rule. Edit the Endpoint URI to utilize the newly established alias to direct the traffic.

  8. Click Transport and enable the HTTP and HTTPS protocols.

  9. Click Activate and then use the Gateway endpoint to invoke the private API.

  10. Employ the API Gateway endpoint for invoking the Private API.

Users and Tenant Management

How to unlock a locked user in webMethods.io Integration tenant?

By default, a locked user is automatically unlocked after a duration of 15 minutes. To manually unlock a user, the tenant administrator can login to Software AG Cloud, click the user name listed under the Users tab, and then click the Unlock button displayed against the user’s name.

What happens when I exhaust the transaction limit for the current month?

Paid Tenants: Users of paid tenants can keep using tenant assets without any restrictions. Any overages are billed and adjusted in the next monthly cycle as per the contract.

Free Forever Edition tenants: Users of Free Forever edition tenants cannot execute tenant assets till the next monthly cycle when the transactions are replenished.

How do I increase the monthly transaction limit?

Get in touch with our support team to increase the monthly transaction limit for your tenant.

How transactions are calculated?

Transaction consumption depends on the type of execution being used.

Execution type Transaction Count
Any webMethods.io Integration Flow service or workflow (however it is initiated) 1
One Flow service invokes another Flow service 1 (only top-level Flow service execution is considered)
A Flow service or B2B API is exposed through the API gateway 2 (1 transaction for Flow service or B2B API execution and 1 transaction for API Gateway-based execution is considered)

Triggers

How do I edit an existing trigger?

You can edit an existing trigger from the workflow in which it is being used or can edit it from a project by navigating to Configurations > Workflow > Triggers tab.
Click here to know how to do it.

How to add conditions in triggers?

You can add conditions in triggers by using ‘Filters’ option located at the bottom of the Trigger Output Data screen, while configuring the trigger.
Know more about Conditions.

Why some of my triggers take longer time to execute?

Some triggers constantly check for updates in the external services and run in real time, whereas some triggers check for updates in external services periodically, for example, every five minutes, and hence take more time. The second type of triggers are called Polling triggers and can be identified by the clock sign given beside the trigger service icon.

Is it possible to change trigger settings for only a specific workflow even if the trigger is connected to multiple workflows?

No, if a trigger is being used in multiple workflows, then any changes made to it will be reflected in all the workflows it is being used in. If you don’t want to change the trigger settings for the rest of the workflows, then it’s advised that you create a new trigger.

How do I delete an existing trigger?

You can delete an existing trigger from a particular workflow it is being used in, via the Workflow Settings panel. If you want to delete the trigger permanently from the project, you can do so by navigating to the Configurations > Workflow > Triggers tab.
Click here to know more about it.

Webhooks

How do I secure my webhooks?

You can secure your webhooks by adding basic authentication or appending authentication tokens to webhooks.
Click here to learn more about it.

You can not change the webhook URL link manually; however, you can regenerate the webhook URL for an existing workflow by clicking the Reset Webhook icon in the webhook configuration window.

How to use webhook as a trigger?

You can use webhook as a trigger by providing the webhook URL link to third-party applications.
Click here to know more about it.

How can I retrieve the response of my workflow through webhook?

You can use Return Data on Sync Webhook action in your workflow to send the response of the workflow to the webhook.

Why my webhook-run workflows stopped executing suddenly?

This could happen due to one of the following reasons:

  1. Tenant transactions exhausted: If you are using a Free Forever Edition tenant and have consumed the monthly allocated transactions, all your asset executions are stopped until the next monthly cycle when transactions are replenished.

  2. Webhook URL changed: If the webhook URL to which the data is being sent via application does not match with the webhook URL present in the workflow, the workflow is not executed.

  3. Tenant password is expired and webhook is using tenant credentials as authentication mechanism: If you are using tenant credentials as webhook authentication mechanism and your tenant password expires, then till the time you reset the tenant password, the webhook-based workflows are not executed.

Conditions

How to use AND operator to set up a condition?

You can use AND operator when you want the workflow to proceed only if all the specified conditions are met.
Click here to know how to set up multiple conditions using AND operator.

How to use OR operator to set up a condition?

You can use OR operator when you want the workflow execution to proceed if any of the specified condition is met.
Click here to know how to set up multiple conditions using ‘OR’ operator.

How to define multiple conditions that work like If-Else statement?

You can use Switch action to define multiple possible execution paths for your workflow. With Switch action, you can add one or more cases. Each case contains one or more conditions and a next step that will be performed if the defined conditions are met. The action also includes a Default case that specifies the action to be executed if none of the condition is met.
Click here to know more about using Switch statement in your workflow.

OAuth 2.0

Can I delete a Client (third-party application that is accessing OAuth token to connect with Edge Runtime)?

No. You must not delete the client from the OAuth 2.0 page.

Edge Runtime

I see the following errors:

Error Solution
docker: Error response from daemon: driver failed programming external connectivity on endpoint EdgeServer11 (afc5df00b5502d0a004ad015a883b7f4c3c15d790f05a43a3603ced834c9d949): Bind for 0.0.0.0:5554 failed: port is already allocated. This error appears because the port number (for example, 5554 in the error message) specified in the command is already in use by another service or application. Provide a port number that is not in use and rerun the command.
docker: Error response from daemon: Conflict. The container name “/EdgeServer11” is already in use by container “f5c1b38b8c2e21580daecbec6ec9d31535a1d1a772305fed9258f2779e5b09f5”. You have to remove (or rename) that container to be able to reuse that name. This error appears because there is already an Edge Runtime registered with the same name. You must use a unique name and register the Edge Runtime.
If you want to use the same name for the Edge Runtime, then delete the client registration details from the OAuth 2.0 page and reuse the name to register the new Edge Runtime. You must have administrative privileges to delete the client registration details.
The Edge Runtime is unavailable. This error can appear because of one of the following scenarios:
  • You are trying to run a deploy anywhere flow service with the Edge Runtime whose token has expired, or whose client registration details do not exist.
  • The Edge Runtime has stopped abruptly.
  • The Edge Runtime is not reachable due to network connectivity issues.

    Can I delete OAuth tokens associated with an Edge Runtime?

    No, you must not delete any of the OAuth tokens associated with the Edge Runtime. If you delete the OAuth token, then the error message The Edge Server is unavailable appears and you cannot run the integrations by using the affected Edge Runtime.

    Can I register an Edge Runtime using an expired token?

    No, you cannot use expired tokens to register an Edge Runtime. Always register an Edge Runtime with a valid token.

    Can I use the name of an Edge Runtime that has been deregistered when registering a new Edge Runtime?

    Yes, you can create an Edge Runtime using the same name of a deregistered Edge Runtime.

    Note: Though the registration does not happen, the runtime is setup in the container. Therefore, if you want to use the same name to register an Edge Runtime using a valid token, first delete the client registration details from the OAuth 2.0 page.

    Can I restart an Edge Runtime that is stopped?

    No, you cannot restart Edge Runtimes that are stopped.

    Who can view and access existing Edge Runtime nodes?

    Currently, you must be an administrator to get access to the control plane.

    Can I define what Edge Runtimes can a developer view and use in their projects?

    No, currently developers can select any Edge Runtime in the given tenant.

    What happens if the connection between the Edge Runtime and Cloud is not available? Which functionality is still available? What functionality is lost?

    Cloud Runtime functions. The Edge Runtime does not function due to network interruption, which may be the infrastructure or the user’s internet issues. The Edge Runtime resumes functioning after the connection is restored.

    What components will be available with Integration Runtimes in the Edge only?

    Components (deploy anywhere flow services, packages imported through Git to the project) that get deployed to your Edge Runtime are available.

    Can I share code and definitions between Cloud and Edge? What would be the best approach?

    Yes, within a project you can share code and definitions.

    What kind of adapter notifications, SOAP, REST endpoints are possible?

    Not supported.

    How to maintain users, accounts, ACLs for the Edge connections?

    Not supported.

    Will the user data be synchronized?

    Not supported.

    Deploy Anywhere Flow services

    Can I call a deploy anywhere flow service from a flow service?

    No. Currently, you can call deploy anywhere flow services from a Workflow. But, you can call either a flow service or deploy anywhere flow service at a given point of time and not together.

    Can I call a flow service or a Workflow from a deploy anywhere flow service?

    No. However, if the flow service and workflow are available as APIs you can invoke them.

    Can I share deploy anywhere flow service assets across projects?

    Yes, if you are in the same tenant. If the deploy anywhere flow services uses Imported package services or database connectors, then these assets can be shared. But, the database connector account must be configured in the target project.

    Does the deploy anywhere service is being invoked on a different Integration runtime will it work ?

    Yes. If the deploy anywhere flow service uses a database connector, then the account must be configured in the target runtime.

    Can I export and import deploy anywhere flow service assets across projects?

    Yes, if you are in the same tenant.

    Can I publish and deploy projects containing deploy anywhere flow service assets?

    No.

    Can I call deploy anywhere flow services from other deploy anywhere flow services, especially across projects?

    Yes, within same project and not across projects.

    Can I select the Edge Runtime dynamically during runtime?

    No, you must select during the design time. However, you can run a deploy anywhere flow service on multiple edge runtimes.

    Do I need to set the Edge Runtime when I clone a deploy anywhere flow service?

    Yes. When you clone a deploy anywhere flow service the Edge Runtime linked to it does not get cloned. It is reset to Cloud Runtime. You must set the desired Edge Runtime and save the deploy anywhere flow service.

    Which built-in services are not available in deploy anywhere flow services? Will the current on-premise functionality be available in Integration Runtimes, for example, all the current services in WmPublic?

    The list of supported services are mentioned under Limitations.

    Packages

    No. Currently, there is no option to remove packages.

    Are there any guidelines for package naming?

    There are no restrictions.

    What do we need if we want to use Designer?

    You do not need to have a 11.0 version of Softare AG Designer. Any version of package can be used. See the tech article, Develop anywhere - A practical guide to using packages with webMethods.io.

    The on-premise Designer currently has options which are not available now in the Cloud. Will it be possible to use these options?

    Yes, the Edge Runtime is a fully functional Microservices Runtime (Integration Server).

    What will happen when a deploy anywhere flow service (having these options) is changed in the Cloud, for example, the pipeline options:

    Yes, if you are importing those services as a package from Git, they function as the same in Cloud.

    Can I share the same package between projects?

    The same package can be imported into different projects, but it is important to note that currently they reside in a single design time environment and hence in reality they will be referencing the same package. This means you cannot have projects referencing different versions of the same package.

    No. You must link a single package to a single Git repository.

    Dashboard

    As we understand the logging is kept in the cloud, what would happen with the logging generated during cloud or internet connectivity unavailability?

    All logs are retrieved from Edge Runtime after the connectivity is restored.

    Audit Logs

    Who can view the audit log screen?

    Audit logs screen is available only for Admin and Owner of the project. If you have been assigned a custom role by the tenant admin/owner, you cannot see the audit logs.

    Security

    Where do I get information about webMethods.io Integration iPaaS Security?

    Click here for a summary on webMethods.io Integration iPaaS Security. You can also see the Data Access and Security section in this document for more information.

    Why does webMethods.io Integration uses OPTIONS method?

    The OPTIONS method is open for webMethods.io Integration as this is required to run the site. As this is a REST API implementation, the application requires the OPTIONS method to be available for AJAX calls to work.

    Why am I unable to upload the customer certificates on webMethods.io Integration?

    Only customer certificates signed by a trusted root CA are accepted on webMethods.io Integration. All other certificates are rejected.

    Is CORS handling available on webMethods.io Integration?

    No, webMethods.io Integration currently does not have CORS handling mechanism. You can use API Gateway to process your requests instead.

    How to resolve security compliance issue while invoking a webMethods.io Integration service using basic authentication through API gateway?

    For webMethods.io Integration service authentication, you can use certificates instead of basic authentication. If you are processing native requests, you need to also configure these certificates on API Gateway.

    How to renew custom domain certificates?

    The custom domain certificates are renewed by our support team. While raising a certificate renew request, please provide the following:

    1. Client certificate, intermediate and root certificates in base64 format

    2. Certificate key in base64 format (.pem or .key)

    3. Cipher details (if any)