Assets
A package is a container that is used to bundle services and related elements, such as specifications, webMethods Integration Server document types, webMethods Integration Server schemas, and triggers. When you create a folder, service, webMethods Integration Server document type, or any element, you save it in a package.
Note: To view and access webMethods Integration Server packages in Integration Cloud, you must assign any custom user groups created in webMethods Integration Server, which are assigned to Access Profiles in the Solution Permissions page, to the following Access Control Lists in webMethods Integration Server:
Administrators ACL
Developers ACL
Replicators ACL
The following figure depicts the package structure in a solution.
Packages are designed to hold all of the components of a logical unit in an integration solution. For example, you might group all the services and files specific to a particular marketplace in a single package. All the components that belong to a package reside in the package’s subdirectory.
Note: Click the arrow beside a folder or package to view its contents.
Downloading assets
You can download user deployed packages and configurations from the
Asset page. To download assets, point to an asset, click the
icon, and then click
Download. The assets will be zipped and downloaded to your local storage space.
Note: You cannot download default packages such as packages that come with webMethods Integration Server installation, for example, Default, WmART, WmCloud, WmJDBCAdapter, WmPublic, and so on.
Services
Services are method-like units of logic that operate on documents. You build services to carry out work such as extracting data from documents, interacting with back-end resources (for example, submitting a query to a database or executing a transaction on a mainframe computer), and publishing documents. Adapters and other add-on packages provide additional services that you use to interact with specific resources or applications. The service editor allows you to view and run the services.
Service Signature
Input and output parameters are the names and types of fields that the service requires as input and generates as output. These parameters are also collectively referred to as a signature. You declare a signature for all types of services: flow services, Java services, and services written in other supported programming languages.
For a flow service, the input side describes the initial contents of the pipeline. In other words, it specifies the variables that this flow service expects to find in the pipeline at run time. The output side identifies the variables produced by the flow service and returned to the pipeline. An webMethods Integration Server document type can also be used to define the input or output parameters for a service.
Click Test to run the service after providing the data to pass into the service.
Service Editor
Use the service editor to view the services. The source code, properties, inputs, and outputs are read only. The editor has the following tabs:
Source tab contains the code or flow for the service.
Input/Output tab contains the input and output signature of the service.
Logged Fields tab indicates the input and output parameters for which the data is logged. You define the data to pass into the service by defining the input parameters on the lower panel of the editor.
Load pipeline for testing services
The pipeline is the general term used to refer to the data structure in which input and output values are maintained for a service in Software AG Designer. The pipeline holds the input and output for a service. The pipeline starts with the input to the service and collects inputs and outputs from subsequent services. When a service runs, it has access to all data in the pipeline at that point.
When you run a service in Software AG Designer, you can click Save and save the pipeline data as an XML document to your local file system. After you deploy the service, you can click the Load Data option in the service editor to select the XML file, and load or update the pipeline data to test the service.
Note: Integration Cloud Integrations can now invoke Cloud Deployment webMethods Integration Server services for the same tenant. A new pre-defined Application, Cloud Deployment, is added in Integration Cloud. Using this Application, you can select the solution webMethods Integration Server services that you want to call from Integration Cloud.
Note: See the webMethods Service Development Help, webMethods Integration Server Administrator’s Guide, and the webMethods Adapter for JDBC Installation and User’s Guide for detailed descriptions of all the services and document types including Adapter services.
Displaying the API details of an executable service
After deploying assets, on the Asset explorer page, click the API Details option to view the API details of the service such as the HTTP Method, URL, Input structure, and the parameters that are required to invoke this service from an external system, for example, a REST client. You can copy the required API details to execute the service from the external system.
Note: The API Details option appears only for executable services. Some examples of executable services are Adapter services, Flow services, Java services, Flat File Schema, and Map services.
You will be able to execute a Flat File Schema by using only the SoapUI tool. You must specify the following settings in the SoapUI tool:
Set the following query parameters in the
Request section:
skipWhiteSpace = true
encoding = UTF8
file = file:file1
In the
Attachments section, browse for the source file and update the following column values:
Name = file1
ContentID = file