Developer

AgileApps

AgileApps provides an interface to other products and applications to communicate with the AgileApps platform. Other products and Applications can use this connector to invoke any AgileApps REST API.

Custom Actions

AgileApps connector lets you create your own custom actions for performing specific tasks. The actions you create look and work exactly like the other actions do.

To know more about how to create custom actions, click here.

AMQP

AMQP (Advanced Messaging Queuing Protocol) is an open source messaging protocol operating in the application layer of ISO OSI model. AMQP mandates the behavior between the message provider and the client in a similar way of other protocols such as HTTP, FTP, SMTP, and so on.

Triggers

• Subscribe: Triggers when a subscriber receives a message from the publisher

Actions

• Publish Message: Publish a new message to an exchange or a queue

AMQP 1.0

AMQP (Advanced Messaging Queuing Protocol) is an open source messaging protocol operating in the application layer of ISO OSI model. AMQP mandates the behavior between the message provider and the client in a similar way of other protocols such as HTTP, FTP, SMTP, and so on.

Triggers

• Subscribe: Triggers when a subscriber receives a message from the publisher

Actions

• Publish Message: Publish a new message to a queue

API Specs

Create custom actions with ease using RAML and Swagger.

Actions

• RAML: Create forms for actions built using RAML

• Swagger - Open API: Create forms for actions built using Swagger

Api2Pdf

Api2Pdf allows you to create PDFs from HTML, URLs, images, and office documents. Furthermore, PDF files can be merged, password-protected, and marked up with bookmarks.

Actions

• convertRawHtmlToPdf: Converts an HTML document to a PDF

• convertUrlToPdf: Converts a web page or URL to a PDF

• convertRawHtmlToImage: Converts an HTML document into an image

• convertUrlToImage: Converts a web page or URL into an image

Custom Actions

Api2Pdf connector also lets you create your own custom actions for performing specific tasks. The actions you create look and work exactly like the other actions do.

Archive

Zip and unzip files with ease.

Actions

• Unzip Files: Unzip selected ZIP file

• Zip Files: Zip specific files

• Unzip Gzip File: Unzip the selected Gzip file

• Unzip TAR File: Unzip the selected TAR file

ARIS

Runtime systems, for example SAP® or Oracle® systems, have data such as the frequency of executed processes and their data, access frequencies and problems or error messages that have occurred. IBM webMethods Integration allows using the ARIS connector to create the connection between ARIS and these systems. For example, this data can be transferred from runtime systems to ARIS and written to attributes in ARIS. Thus these real data are also available in ARIS.

Using the ARIS connector

ARIS connector allows you to create your own custom actions.

1. Add a custom action.

   Always select ArisServices as the functional area. ArisAuthService is used internally by IBM webMethods Integration.

   

2. Create a connection. Specify connection details and session parameters.

   • Account name: The account name is used to identify the connection. You can enter any name.
   • Server URL: The server URL is the URL to ARIS Repository API. Edit the domain. Typically, this is the host name of the ARIS system used. Enter only the URL and leave the /abs part unchanged.
   • Username: The user account name of ARIS.
   • Password: The password for the user name provided in the Username field.
   • Auth Server URL: The Auth Server URL is the URL to the User Management of ARIS. Edit the domain. Typically, this is the host name of the ARIS system used. Edit the domain. Enter only the URL and leave the /umc/api part unchanged.
   • Tenant: Specify default.
   • Session Management: Set to fixed.

   • Session Timeout: Set to 45 minutes.

     IBM webMethods Integration requests a session token from ARIS and uses it when calling ARIS. By default the session token expires in ARIS in sixty minutes. To ensure token renewal, use a session timeout lower than the duration of the ARIS session.

3. Edit the parameters.

   The parameter umcsession is set internally by the ARIS connector.

   The Content-Type parameter of the request header should always be set to application/json.

   Do not edit either of the parameters.

   

4. Find items in the database.

   The ARIS repository has a method for finding elements in a database. This method can be used to find groups, object definitions, or models. The ARIS connector provides a search function with three different operations:

   • find groups in a database
   • find objects in a database
   • find models in a database

ARIS Process Mining

Runtime systems, for example, SAP® or Oracle® systems, have data such as the frequency of executed processes and their data, access frequencies and problems, or error messages that have occurred. Using the IBM webMethods Integration connector for ARIS Process Mining allows you to create the connection between ARIS Process Mining and these systems. This data can be transferred, for example, from runtime systems to ARIS Process Mining and loaded into a data set for further analysis.

ARIS Process Mining supports a public data ingestion REST-API. The API allows you to transfer data from any data source to ARIS Process Mining. The data transferred to ARIS Process Mining must be in table format and must conform to JSON format.

The IBM webMethods Integration connector provides the REST operations from the data ingestion API that you can use to customize your own actions. Additionally, predefined operations allow you to directly use the most commonly used REST resources and operations or reduce the complexity of customizing REST operations.

Prerequisites

Before you can create the connection, you must first create a system integration and connection for the data ingestion API in ARIS Process Mining. The system integration must be based on the Client credentials authentication method. The system integration provides the client ID and client secret required to create a connection between IBM webMethods Integration and ARIS Process Mining.

Connection Parameters

You must specify the following parameters to create a connection between IBM webMethods Integration and ARIS Process Mining:

• Account Name: The account name is used to identify the connection.

• ARIS Cloud URL: The ARIS Cloud URL is the URL to the ARIS Process Mining host. https://mc.ariscloud.com is preset by default.

• Project Room: The project room is the tenant.

• Data Set Name: Data set to which the data is uploaded. The specified data set is automatically used for all requests of the connector.

• Client ID: ID to log in to ARIS Process Mining. The client ID is provided by the system integration created for the data ingestion in ARIS Process Mining.

• Client Secret: Secret to log in to ARIS Process Mining.The client secret is provided by the system integration created for the data ingestion in ARIS Process Mining.

• UMC Session Timeout (min): Optional. The default value is 45 minutes according the default UMC settings (This can be changed if updated in the UMC settings).

• Response Timeout (milliseconds: Optional. The default value is 30000 milliseconds.

Actions

• Cancel Cycle: Cancels the specified cycle.

• Commit Data Upload Cycle: Indicates ARIS Process Mining that all data has been uploaded and can be loaded into the source tables. The status of the specified cycle will be set to “COMPLETED_SUCCESSFULLY” when the upload has finished without errors in the ARIS Process Mining.

• Create Data Upload Cycle: Creates an ingestion cycle to upload data. An ingestion cycle key is returned. This key must be used to cancel or delete this cycle, or to get the state of the cycle or to inform ARIS Process Mining that the data upload is complete.

• Create Source Tables: Creates source table(s) in ARIS Process Mining. Note: If persistenceMode is not set, the table(s) will be created with persistenceMode = OVERWRITE.

• Drop Source Table: Drops a specified source table.

• Is Ready for Data Load: It is checked, if a data load can be started.

• Is Ready for Data Upload: It is checked, if data can be uploaded.

• Start Data Load: Creates a data ingestion cycle to start the data load.

• Replace Source Tables: Replaces source table(s) in ARIS Process Mining if the identifier already exists. The structure and data will be replaced. Note: If persistenceMode is not set, table will be replaced with persistenceMode = OVERWRITE.

• Retrieve Cycle State: Retrieves the state of the specified ingestion cycle.

• Retrieve API Version: Retrieves the current API version of ARIS Process Mining.

• Retrieve Cycles: Retrieves all existing ingestion cycles of a data set. This action is based on the corresponding endpoint, which is only available from ARIS Process Mining version 10.18.

• Retrieve Source Table Definitions: Retrieves definition of requested tables. Note: If no tables are specified, the structure of all tables will be returned.

• Upload Data: Uploads data for a specified source table to ARIS Process Mining. Before the data is uploaded to ARIS Process Mining, it is checked whether the data corresponds to the expected data type.

• Update Source Table Definition: Updates the structure of the specified source table while preserving the existing data. This action is available from ARIS Process Mining version 10.20.

Custom Actions

ARIS Process Mining connector also lets you create your own custom actions for performing specific tasks. To know more about how to create custom actions, click here.

The custom actions are based on the endpoints provided by the data ingestion API.

Beanstalk

Beanstalk is a code hosting workflow that you can use to write, review, and deploy code instantly. This easy-to-use service removes the hassles of hosting code and managing deployments, thus accelerating the software development process.

Triggers

• New Comment: Triggers when a new comment is added

• New Changeset: Triggers when a new changeset is added

Actions

• Add User to Team: Add a user to an existing team

• Create Team: Create new team in your account

• Create User: Create a new user in your account

• Get Repositories List: Retrieve list of all existing repositories

• Get Repository Details: Get details about an existing repository

• Get Teams List: Retrieve list of all existing teams

• Get Users List: Retrieve list of all existing users

Bitbucket

Bitbucket, powered by Atlassian, offers web-based version control repository hosting service. It manages source code and projects with the help of mercurial or git that runs in the background.

Triggers

• Push: Triggers when a block of code is pushed

• New Comment on a Commit: Triggers when a new push comment is added

• New Issue: Triggers when an issue is created

• Issue Updated: Triggers when an existing issue is updated

• New Comment on an Issue: Triggers when a new issue comment is added

• New Pull Request: Triggers for a new pull request is created

• Pull Request Updated: Triggers when an existing pull request is updated

• Merged Pull Request: Triggers when an existing pull request is merged

• Declined Pull Request: Triggers when an existing pull request is declined

Actions

• Get Branch List: Get all branches of a repository

• Get Forks List: Get list of all forked repositories

• Get Master Branch Details: Get more details about the main branch of a repository

• Get Repository Details: Get more details about an existing repository

• Get Tags List: Get list of all tags and branches of a repository

• Get Watchers List: Get list of all watchers of a repository

Clock

The Clock trigger allows you to run a workflow automatically at a particular date or time.

Triggers

• Clock: Triggers at a specific date or time

Database

The Database allows you to connect to a database and perform database operations using a JDBC driver.

Creating a New Account

1. Click the Connectors.

2. Search for Database in the Available Connectors and select Database.

3. Click New account.

4. Provide the following details in the Add account page:

   

   a. Enter the action name and description for the account.

   b. Enter the following details in the Add account wizard:

   

   • Name: Name for the account you want to add.

   • Description: Short description for the account you want to add.

   • Database: Database you want to connect to.

   • Driver Group: Driver group used to connect to the database. Lists the pre-bundled drivers available and the drivers uploaded in the Database connector. For more information, see Certified Databases and JDBC Driver Jars. You can upload a new JDBC driver by selecting the icon next to the Driver Group dropdown list. You can upload only certified jars. For more information, see Adding Driver.

   • Transaction Type: Transaction type you want to perform. Transaction types supported are:

     • NO_TRANSACTION: Account automatically commits operations.
     • LOCAL_TRANSACTION: Account uses local transactions. With this transaction type, all of the operations on the same account in a single transaction boundary are either committed or rolled back together.
       
     Note

     Transaction Type must be set to LOCAL_TRANSACTION if you use the account with the following:

     • BatchInsertSQL or BatchUpdateSQL actions.
     • Notifications.

   • DataSource Class: Datasource class to be used. This field specifies the name of the JDBC driver’s datasource class.

   • Server Name: Name of the server that hosts the database.

     Note

     If the tenant cannot connect to the cloud database, then check the security settings of the cloud database.

   • User Name: Username associated with the account on the database server.

   • Password: Password for the specified user name.

   • Database Name: Name of the database to which you are connecting.

   • Port Number: Port number used for connecting to the database.

   • Truststore Alias: Alias of the truststore configuration. The truststore contains trusted certificates that are used to determine the trust for the remote server peer certificates. You can also add a new Truststore certificate by selecting the icon next to the Truststore Alias dropdown list.

     Note

     This field is not available for connections on Edge Runtime.

   • Network Protocol: Network protocol that the connection must use when connecting to the database. Type TCP or TCPS to indicate the network protocol.

   • Keystore Alias: Alias for the Keystore file or the fully qualified file name of the SSL keystore.
     You can add a new Keystore certificate by selecting the icon next to the Keystore Alias dropdown list.
     See more information on Keystore and How to generate key-pair using Open SSL.

     Note

     This field is not available for connections on Edge Runtime.

   • Property Name: Name of the property. You can select the property from the drop-down list or use the ’+’ button to add a new property.

     

     Note

     Properties listed for you to select from the dropdown list are driver-dependent.

     • Example 1: Use this field to choose a property such as TableFilter. You can either select or type the TableFilter property in the dropdown list and enter the <current catalog>.Accounting in the input text field.
       Use {} to configure a combination of multiple key-value pairs.
     • Example 2:

       *connectionProperties={oracle.jdbc.V8Compatible=true,includeSynonymns=true }

       .
       By default, the loginTimeout is set to 60, which is the time (seconds) that a connection waits while attempting to connect to a database.
     • The <current catalog> represents the default catalog associated with an account.
     • The <current schema> represents the default schema associated with an account.

   • Property Value: Value for the property selected.

   c. Click Next. The Add account > Advance Setting page appears.

   d. Provide the following details in Advance Setting page to configure connection pooling manually:

   

   Note

   Connection pooling is not enabled by default.
   • Enable connection pooling: Toggle the slider to the right to enable manual configuration of the connection pooling details. Disable the connection pooling to use system defined values.
     
   • Minimum and maximum Pool Size: Minimum and maximum connection pool size for this account.
     • Minimum Pool Size: Number of connections to create when the connection is enabled. The system maintains the specified Minimum Pool Size of connections, irrespective of whether these connections remain idle.
     • Maximum Pool Size: Maximum number of connections that can exist at a time in the connection pool.
   • Block timeout: Number of milliseconds that Integration waits to obtain a connection before it times out and returns an error. For example, you have a pool with maximum pool size of 20. In the event of receiving 30 simultaneous connection requests, 10 requests will be queued, awaiting a connection from the pool.
     • If you set the Block timeout value to 5000, the 10 requests will wait for 5 seconds to establish a connection before they time out and return an error. If the services using the connections require 10 seconds to complete and return connections to the pool, the pending requests will encounter failure and return an error message stating the unavailability of the connections.
     • If you set the Block timeout value too high, you may encounter problems resulting in error. If a request contains errors that delay the response, other requests will not be sent.
       
       This Block timeout must be tuned in conjunction with the Maximum Pool Size setting to accommodate such bursts in processing.
   • Expire timeout: Number of milliseconds that an inactive connection can remain in the pool before it is closed and removed from the pool. The connection pool removes inactive connections until the number of connections in the pool is equal to the Minimum Pool Size. The timer for an inactive connection is reset when the connection is used.
     • If you set the Expire timeout value too high, the connection pool might accumulate numerous unused and inactive connections. This not only consumes local memory but also ties up a connection on your backend resource. This could have an adverse effect if your resource has a limited number of connections.
     • If you set the Expire timeout value too low, the performance could degrade because of the increased activity of creating and closing connections.
       
       This Expire timeout must be tuned in conjunction with the Minimum Pool Size setting to avoid excessive opening and closing of connections during processing.

   e. Click Next.

   f. Verify the account details and other properties.

   

   g. Click Test connection to verify the database connection. A success message appears if the connectivity is successful.

   

   h. Review the account details and click Enable.

   

   i. Click Done. This will redirect you to the Predefined Connectors page containing the list of connectors created.

   

Sample Accounts

The following sample accounts are created for secured and non-secured connection for various databases.

Microsoft SQL Server

Oracle

PostgreSQL

MySQL

MariaDB

Tibero

SAP HANA

Amazon Redshift

Snowflake

Vertica

Teradata Vantage

Adding Driver

The Add Driver screen gives you an option to upload a custom driver jar for a particular database. This uploaded driver can be used when you create an account.

To add a new driver

1. In the Account page, from the Driver Group, select the ’+’ button.

2. In the Add Driver page, select the supported Database.

3. Type the driver group name in the Driver Group.

4. Browse the jar in the Select the Driver field for a particular database. The driver jar gets uploaded for the corresponding database.

   Note

   
   

   • You can upload only certified jars. For more information, see Certified Databases and JDBC Driver Jars.
     
   • The uploaded driver jars can be used across the projects in the tenant.

Pre-bundled Drivers

Pre-bundled driver jars are provided to connect to the databases like Microsoft SQL Server, Oracle, PostgreSQL. You cannot delete these pre-bundled driver group. The below table shows the driver groups and supported databases.

Certified Databases and JDBC Driver Jars

You can upload only the following list of certified driver jars:

JDBC Driver Jars for Microsoft SQL Server

JDBC Driver Jars for Oracle

JDBC Driver Jars for PostgreSQL

JDBC Driver Jars for MySQL

JDBC Driver Jars for MariaDB

JDBC Driver Jars for Tibero

JDBC Driver Jars for SAP HANA

JDBC Driver Jars for Amazon Redshift

JDBC Driver Jars for Snowflake

JDBC Driver Jars for Vertica

JDBC Driver Jars for Teradata Vantage

Database connector Actions

To use Database connector, you must select the actions to execute. Actions allow you to connect to the database and initiate an action on the database from Integration.

You call database actions to perform database operation on tables, views, or synonyms. The database actions are performed by calling JDBC APIs.

Actions are based on templates provided with Database connector. Each template represents an SQL statement for performing an action on a database. For example, use Select action to retrieve specified information from the database tables.

Creating a new action from a template is straightforward. You have to create an account for creating a new action. When creating a new action, select the action template and configure the action using the wizards.

Database connector provides the following action templates:

• Select: Retrieves specified information from the database table.

• Insert: Inserts new information into a database table.

• Update: Updates the existing information in a database table.

• Delete: Deletes rows from a database table.

• Stored Procedure: Calls a stored procedure. It obtains the stored procedure’s input/output parameters by introspecting when you configure the action.

• Batch Insert: Inserts new information into a database table. Use this action when you insert a large volume of data into a single table.

• Batch Update: Updates the existing information in a database table. Use this action when you update a large volume of data in a single table.

• Custom SQL: Defines and executes custom SQL to perform database operations. You can run almost any SQL statement required, such as data management statements and data definition statements. The following table describes the restrictions when creating an SQL query statement:

  • Specify the table alias along with the table name if the SQL query contains more than one table.

    select d.deptno, e.empno from dept d,emp e where d.deptno = ?

  • Use different column name alias for columns in the SQL query.

    select firstname as f_name, lastname as l_name from emp

  • Column names in the SQL query should not be enclosed in quotes.

    select partno as partno from emp where partno=1

  • Use the “as” keyword when you specify an alias for a column.

    select city as dummy from emp

  • Irrespective of the database type, the query syntax must follow the SQL standards.

    insert into example_default_now set id=?, data=?

    
    
  Note

  • You can use a CustomSQL to call a stored procedure only when the stored procedure does not have any OUT/INOUT or return parameters. If you need to use these parameters, use the StoredProcedure template.
  • Standards corresponding to specific database types are not supported.
  • If you use the ? variable placeholders in your SQL statement, ensure that you enter the corresponding Input Field and field type information in the same order as they appear in your SQL statement.
  • Do not end your SQL statement with a semi-colon (;) or an exception will be generated at run time.

• Dynamic SQL: Configures a dynamic SQL statement, part of which you set at run time using input fields. At run time, the Dynamic SQL action will create the SQL statement by combining the contents of the input fields and then executing it. This is useful when you need the flexibility to set all or part of a SQL statement at run time, instead of at design time. DynamicSQL uses ${INPUT_FIELD_NAME} to map a part of the SQL statement to the input field. At design time, the action template generates an input field with INPUT_FIELD_NAME. At run time, the Dynamic SQL action parses the statement and replaces the ${INPUT_FIELD_NAME} with the actual contents of the input field. For variable names, use the ? variable placeholder for each variable. For example:

  select employee_name where StaffID = ? and Dept = ?

  
  

  Example 1:

  select * from table1 ${where} 

  
  At run time, the where input field is set to where col1 > 100. The final SQL query will be:

  select * from table1 where col1 > 100 

  Example 2:

  select * from table1 ${where}

  
  At run time, the where input field is set to where col1 > ?. As you are using placeholder ? to receive input value for col1, you need to configure an input field to set value for column col1. The final SQL query will be:

  select * from table1 where col1 > ?

  Example 3:

  select ${output_fields} from table1 ${where}

  
  At run time, the where input field is set to *where col1 > 100 * and output_fields input field is set to * col1,col2,col3 *. The final SQL query will be:
  

  select col1,col2,col3 from table1 where col1>100

  Note

  • Database connector does not validate the input parameters of a DynamicSQL action for any malicious SQL injections. When you use a variable input parameter such as the text ${INPUT_FIELD_NAME} in the SQL statement, you must take extra measures to avoid potential security risks.
  • You can use a DynamicSQL to call a stored procedure only when the stored procedure does not have any OUT/INOUT or return parameters. If you need to use these parameters, use the StoredProcedure template.
  • If you use the ? variable placeholders in your SQL statement, ensure that you enter the corresponding Input Field and field type information in the same order as they appear in your SQL statement.
  • Do not end your SQL statement with a semi-colon (;) or an exception will be generated at run time.

Advanced Options

The following options provide additional capabilities for Database operations:

Configuring the Parameter Values

CRUD Actions and Stored Procedures

You can configure the following parameters for custom SQL, Select, Update, Insert, Delete actions and Stored Procedures:

Batch Operation

You can configure the following parameters for Batch Insert and Batch Update operations:

JDBC Data Type to Java Data Type Mappings

Each column in the database table is assigned a SQL type. The JDBC driver maps each SQL data type to a JDBC data type. Database connector then maps each JDBC data type to one or more Java data types that are used as the input or output of the database actions.

The following table shows the JDBC data type to Java data type mappings. You can map each JDBC data type to a set of Java data types by choosing one from the set. The JDBC data type you select during configuration will then map to the input or output of the database actions.

For a list of data types for which Database connector has some constraints, see the DBC Data Type to Java Data Type Mapping Constraints section.

Important Considerations When Using BLOB and CLOB Data Types

• When passing large CLOB or BLOB data, use the Java data types java.io.Reader for CLOB and java.io.InputStream for BLOB to prevent Database connector from running out of memory. When using these data types, Database connector streams the data into bytes thus allowing to pass large data. The data types java.io.Reader and java.io.InputStream are supported only for the Oracle database using the Oracle driver.
• When using the CLOB data with java.io.Reader as input data type, it is recommended that you use the InputStreamReader implementation of java.io.Reader with the correct encoding parameter.
• When Integration executes a SELECT operation that has its output type set to java.sql.Blob for a BLOB data type, Integration issues a java.io.NotSerializableException error.

Important Considerations When Using the Array and Struct Database Specific Data Types

• In database operation, when using the java.lang.Object as the output field type for a database column of type ARRAY or STRUCT, Database connector returns the data as a java.lang.Object array, provided that the ARRAY or STRUCT data in the database table is composed of primitive data types.
• When using the java.sql.Array or java.sql.Struct as the output field type for a database column of type ARRAY or STRUCT, Database connector returns the java.sql.Array and the java.sql.Struct objects, respectively, as returned by the driver. However, when serializing the data across the JVMs, this returned data may not be serializable and may result into a java.io.NotSerializableException. Therefore, before serializing the data across the JVMs, it is important that you process the java.sql.Struct and java.sql.Array objects as required, and then drop them from the pipeline.

Using the SetAsString Data Type in Database connector

The SetAsString data type is a dummy string data type. When using this data type, Database connector does not try to convert the input data into the equivalent JDBC data type, but passes the data to the underlying database driver as a string data type. Thus, you have the flexibility to specify the format of the equivalent JDBC data type by using a database specific function.

For example, you can specify the format for date, time, or timestamp using the to_date function or a similar database function for Oracle database. Database connector treats the input data as a string data type and does not convert it to the equivalent JDBC data type. The to_date function then uses the string data to provide the required format of the date, time or timestamp.

If your database has native database specific functions that can convert string data type to any other data type, you may use the SetAsString data type.

JDBC Data Type to Java Data Type Mapping Constraints

Database connector has some constraints when mapping JDBC data types to Java data types.

If you select one of the following Java data types, the data type will map exactly to the Input/Output of operation:

• java.lang.String
• java.lang.Byte
• java.lang.Boolean
• java.lang.Character
• java.lang.Double
• java.lang.Float
• java.lang.Integer
• java.lang.Long
• java.lang.Short
• java.util.Date
• java.math.BigDecimal
• java.math.BigInteger
• java.lang.Object

The data types that are not included in this list are mapped to java.lang.Object. In these cases, if the JDBC data type you specify is for input, you need to pass in the object with the selected Java data type. If the JDBC type is for output, you can cast the object to the selected Java data type.

Database Connector Notifications

For more information about Database notifications, see About Database Polling Notifications, Database Polling Notifications, How to create Database Polling Notifications?, and How to use the Database Polling Notifications?.

Supported Cloud Databases

The following table lists the supported cloud databases:

Limitations

General limitations

• In stored procedure notifications, parameter types IN, INOUT, and ORACLE CURSOR (INOUT) are not supported.

Amazon Redshift

• Actions not supported
  • Stored Procedure
• Notifications not supported
  • Insert Notifications
  • Update Notifications
  • Delete Notifications
  • StoredProcedure Notifications

MariaDB

• Notifications:
  • Trigger conditions not supported in Update and Delete Notifications.
• If you configure an operation for MariaDB using the driver versions greater than or equal to 2.4.0, select the table under <current catalog>.

Microsoft SQL

• Notifications:
  • Trigger conditions not supported in Update and Delete Notifications.
  • Microsoft SQL 2000 and 2005 do not allow the retrieval of both the old and the new values in a single Update notification. The notification can retrieve either the old or the new value.
  • The WHERE tab is not supported in Insert and Update notification. An exception is generated if you try to use this tab.

MySQL

• Notifications:
  • Trigger conditions not supported in Update and Delete Notifications.
  • MySQL version 5.0.x does not support multiple triggers with the same event (insert, delete, or update) for one table. Hence, with a MySQL database, when using an Insert, Update, or Delete Notification to monitor a table, you must disable the notification before you can enable another Insert, Update, or Delete Notification with the respective (insert, delete, or update) operation for the same table.
  • When using an Update Notification with a MySQL database, updating any database field with the same value will not invoke a trigger.

Oracle

• Notifications:
  • Trigger conditions not supported in Update and Delete Notifications.
• In the WHERE tab, if you use a CHAR(n) data type and enter a value in the Input Field, then the JDBC data type is automatically set to ORACLEFIXED_CHAR.

PostgreSQL

PostgreSQL 11.2 and PostgreSQL 11.5:

• Actions not supported
  • Stored Procedure
• Notifications not supported
  • Insert Notifications
  • Update Notifications
  • Delete Notifications
  • StoredProcedure Notifications
• If you configure an operation to select a table, you must always select the table under <current catalog>.

SAP HANA

• Notifications:
  • Trigger conditions not supported in Update and Delete Notifications.
• SAP HANA requires Tunnelling while using SAP HANA Cloud Platform SDK Version 1.82.21.2.
• Metadata lookup for ARRAY data type is not supported. Only CustomSQL and DynamicSQL actions can be used to perform operations using these data types.
• SAP HANA trigger definition does not support the WHERE clause thereby rendering the WHERE tab in Insert, Update, Delete Notification useless.
• StoredProcedure Action and StoredProcedure Notification do not support ResultSet.

JDBC driver for SAP HANA2

• SSL connection is supported using SAP HANA file-based trust stores (PSEs).

Snowflake

• Actions not supported
  • Stored Procedure
• Notifications not supported
  • Insert Notifications
  • Update Notifications
  • Delete Notifications
  • StoredProcedure Notifications

Teradata Vantage

• Actions not supported
  • Stored Procedure
• Notifications not supported
  • Insert Notifications
  • Update Notifications
  • Delete Notifications
  • StoredProcedure Notifications

Tibero

• Actions not supported
  • Stored Procedure
• Notifications not supported
  • Insert Notifications
  • Update Notifications
  • Delete Notifications
  • StoredProcedure Notifications

Vertica

• Actions not supported
  • Stored Procedure
• Notifications not supported
  • Insert Notifications
  • Update Notifications
  • Delete Notifications
  • StoredProcedure Notifications

Deploy Anywhere Flow Services

• Only JDBC jars certified by IBM for the database driver are permitted for uploading with deploy anywhere flow services.

• The following databases are supported:

  • Amazon Redshift

  • MariaDB

  • Microsoft SQL Server

  • MySQL

  • Oracle

  • PostgreSQL

  • SAP HANA

  • Snowflake

  • Teradata Vantage

  • Tibero

  • Vertica

• The following features are not supported:

  • Connection pool configuration

  • One-way SSL due to lack of SSL keystore deployment

  • Polling notifications

  • Kerberos-based authentication

  • Templates

    • Execute service

    • Stored procedure without signature

SAP® ERP

Introduction

SAP® ERP enables you to extend your SAP business processes and integrate non-SAP products using open and non-proprietary technology. SAP® ERP allows for bi-directional, real-time communication to and from the SAP system. SAP® ERP is based on the on-premises webMethods Adapter for SAP (WmSAP).

SAP® ERP allows you to increase customer loyalty and efficiency across the supply chain by tightly integrating your business infrastructure with that of any partner. Typical deployment scenarios for SAP® ERP are:

• Real-time integration between supplier inventories and your SAP system.
• Real-time integration between product, price, and availability information from any number of suppliers and your purchasing application.
• Real-time integration between fulfilment and order tracking applications and your shippers’ internal systems.

SAP® ERP key features

The purpose of this section is to clarify the use of SAP® ERP with the restricted access (RA) version. You must read through the differences between WmSAP and SAP® ERP, and analyze if the migration of existing WmSAP applications to SAP® ERP is affected.

• Synchronous and asynchronous communication with SAP systems through RFC, tRFC, qRFC, and bgRFC

  • SAP® ERP allows you to run the Application Link Enabling (ALE) services inside SAP system asynchronously, which allows you to integrate the business processes. SAP® ERP can run SAP remote function calls.
  • Asynchronous processing transparently uses the Application Link Enabling (ALE) services inside the SAP system for the client to integrate the business processes.
  • Run the SAP Remote Function Calls (RFCs) from SAP® ERP. You can access all SAP functionality that is available through RFC from SAP® ERP. External applications do not need to understand the SAP datatypes, ABAP structures, or the RFC protocol to communicate with an SAP system.

• Bi-directional and multithreaded communication to and from SAP systems

  • Call and invoke services from the SAP systems. This allows the SAP users to access information that is available through SAP® ERP. SAP® ERP enables integration between trading partners, thereby extending the reach of your SAP infrastructure to customers, partners, and suppliers.

• Higher level services to process SAP IDocs and BAPIs

  • Send IDocs to the SAP® ERP. You can send Intermediate Documents to SAP® ERP for further synchronous processing or let them be published to subscribers asynchronously.
  • Use the SAP’s implementation-independent Business Application Programming Interface (BAPI) methods as described in the Business Object Repository (BOR). BAPIs are stable, precisely defined, and well-documented interfaces to SAP solutions, providing standardized access to SAP solutions on a semantic level. You can quickly and easily create XML-based services that run a BAPI. Applications within your organization can then invoke the services to run a BAPI on the SAP system. Similarly, your business partners can make requests over the Internet to invoke a service that runs a BAPI. The BAPI-interfaces provide unified access to the application-level functionality, independent of the type of call; both synchronous and asynchronous processing can be triggered by using these interfaces.
  • Route SAP business documents based on the criteria you specify. SAP® ERP provides rich routing capabilities for BAPIs, RFCs, and IDocs. Different transport types are available out-of-the-box. These include routing of a business document to another SAP system or simply to a remote URL in an XML format.

• Load balancing of incoming SAP documents.

• Easy XML and Internet enabling of existing SAP releases.

• Supports BizTalk XML envelopes for BAPI and RFC calls.

• Supports unified error handling of BAPIs and RFCs on XML level.

Pre-requisites for getting started with SAP® ERP

• Install SAProuter tunnel software to connect from SAP® ERP to your SAP systems (located either on-premise or in a private cloud). An existing SAProuter installation in your environment can also be used for the connectivity to SAP® ERP in Integration.

  SAProuter can be downloaded from SAP and is free for SAP customers. A separate guide is available on how to install, configure, and create certificates for the SAProuter instance.

  For more information about SAProuter tunnel software, see the related links:

  • https://help.sap.com/docs/ABAP_PLATFORM_NEW/e245703406684d8a81812f4c6334eb2f/487612ed5ca5055ee10000000a42189b.html?q=SAPRouter
  • https://help.sap.com/docs/SAP_NETWEAVER_731_BW_ABAP/e245703406684d8a81812f4c6334eb2f/487612ed5ca5055ee10000000a42189b.html?version=7.31.22
    
  Note

  Links might change in future.

• Configure Secure Network Communications (SNC) for authentication and encryption of the connections between SAP® ERP and your SAProuter instance. SNC configuration is optional and may be omitted.

Differences between SAP® ERP and the on-premise WmSAP

SAP® ERP provides most of the features available in the on-premise WmSAP. In some cases, you may have to use workarounds, while some others might have restrictions. Limitations will be removed in future releases.

The deviations, and restrictions to keep in mind when migrating from WmSAP to SAP® ERP are listed below:

• Asynchronous SAP ALE and RFC notifications are currently not supported in SAP® ERP. This may be available in future releases.

  Workaround: Substitute asynchronous SAP ALE and RFC notifications with synchronous notifications.

• Internal, undocumented administration services (wm.sap.*) in WmSAP are not available in SAP® ERP.

  Workaround: Raise a request with IBM for new SAP® ERP public services with similar functionality if some administration services are required for migrating the existing WmSAP application to Integration.

• WmSAP public services accepting the complete node name (package and folder/service name) as input parameters might not be supported.

  • For example, the register or unregister routing callback services - pub.sap.idoc.routing:registerService, pub.sap.idoc.routing:unregisterService are not supported in Integration.

    Workaround: Use the Routing-Mapping screen instead of using register and unregister services.

  • Another example is the pub.sap.transport.IS:OutboundProcess service. This service is not fully supported in Integration because it expects the folder name and service name of a Flow (or Java) service to be run either on local or remote on-premise webMethods Integration Server.

• Execute ACLs are currently not supported in Integration. In the on-premise webMethods Integration Server setup, incoming SAP notification requests are run under the account of the webMethods Integration Server user having the same username as the SAP user who has sent the request. This allows the usage of Execute ACLs to limit the execution of notification services to specific users only.

  Information: SAP notification services can run when requests are sent by any SAP user.

• Custom Java services are not supported in Integration.

  Workaround: Contact IBM if the migrated WmSAP applications require custom Java services and clarify if the Java services can be substituted with Flow services or existing public Integration services.

• WmSAP template Java services (with editable Java source code) in sample.sap.* are not available in Integration.

Accounts

Create New Account

Complete the following fields to create a new account:

If the Connection Mode selected is Standard:

If the Connection Mode selected is Load Balancing:

Actions

SAP® ERP actions execute a function module residing on an SAP system. A function module performs functions on the data in the SAP system.

Create New Actions

Complete the following fields to create a new action:

Listeners

For more information about SAP® ERP, see SAP® ERP Listeners, SAP® ERP Listener Notifications, How to create and invoke RFC Listeners Notification?, and How to use the SAP® ERP for RFC invocation?.

Create New Document Type

Complete the following fields to create a new Document Type:

If the Document type selected is RFC:

If the Document type selected is IDoc:

DDIC Cache

The Data Dictionary Cache (DDIC) is a cache that holds information about SAP function modules, structure definitions, Business Objects, ALE mappings, and IDocs. SAP® ERP retrieves this information from an SAP system when it performs RFC, BAPI, or IDoc lookups. To improve performance, SAP® ERP caches information it receives about function modules and structure definitions.

SAP® ERP receives information about function modules and structure functions when:

• An RFC, BAPI, or IDoc lookup is requested.
• SAP® ERP executes a service that invokes an RFC or BAPI on an SAP system.
• An SAP system executes an RFC that invokes a service.
• An IDoc gets processed by SAP® ERP.

SAP® ERP keeps separate cached function modules, structure definitions, Business Objects, ALE mappings, and IDocs for each SAP system. When SAP® ERP requires specific data, it checks its DDIC cache for the specific SAP system to determine if the information it requires is in cache. If the required information is in the DDIC cache, SAP® ERP uses the cached information rather than retrieving it from the SAP system.

The DDIC cache is always active. There are no configuration tasks required to activate it. When you are developing services, there may be times when the information in the DDIC cache becomes outdated; for example, if you change an RFC signature on an SAP system. In these situations, you can use the DDIC cache screens to view the information in the cache and remove specific function modules or structure definitions from the cache as necessary.

Field	Description
System ID	Uniquely identifies an SAP system within a SAP domain. RFC connections using the same system ID share the same cache. Note If you have configured and enabled an RFC listener, you will also see a Local entry in the System ID list. The cached elements of this System ID cannot be deleted or modified.
Functions	Number of cached function modules for an SAP system. You can view the function module names by clicking on the number in the Functions field. You can clear the individual function module from the cache by clicking icon.
Structures	Number of cached structure definitions for an SAP system. You can view the structure module names by clicking on the number in the Structures field. You can clear the individual structure module from the cache by clicking icon.
Business objects	Number of cached business objects for an SAP system. You can view the business object names by clicking on the number in the Business objects field. You can clear the individual business object from the cache by clicking icon.
ALE mappings	Number of cached BAPIs for an SAP system (for which ALE information of an SAP system has been checked and extracted). You can view the ALE mapping module names by clicking on the number in the ALE mappings field. You can clear the individual ALE mapping module from the cache by clicking icon.
IDocs	Number of cached function IDocs for an SAP system. You can view the IDoc names, IDoc type extension, and release information by clicking on the number in the IDocs field. You can clear the individual IDoc from the cache by clicking icon.

Transaction Store

SAP® ERP provides a transaction manager that allows you to monitor the transaction state for all messages associated with a transaction ID. The transaction ID uniquely identifies the transaction. The transaction ID can be up to 24 alpha numeric characters in length. If SAP® ERP receives a message without a transaction ID, it can create one for the message. The message is stored in the transaction store.

To view and manage the transactions that SAP® ERP records in its transaction store:

• Click the icon.
• In the drop-down menu, click on Settings.
• In the menu, select Connectors Configuration > SAP® ERP > Transactions.
• The Transactions page appears. You can view and manage the transactions.

Viewing transactions

1. You can view all the transactions or filter the transactions.

   • Click Apply without entering any values in any of the fields to view all transactions.

   • Enter a filter term in one of the following fields and click Apply to filter the transactions based on the filter criteria.

     Note

     Regular expressions are supported to allow flexible filter criteria matching.

     Field	Description
     Sender	Sender SAP system.
     Receiver	Receiver SAP system.
     Message Type	Message Type as defined in the SAP system.
     TID	Transaction ID.
     State	States of the tRFC protocol. Possible values are: Created-Transaction is created. Rolledback-Transaction is rolledback. Committed-Transaction is committed. Confirmed-Transaction is confirmed.
     Date and Time Range	Restricts the transactions to a specific date and time interval.

     The list of transactions are displayed.

Sorting the Transactions

You can sort the transactions by the date and time of transactions.

1.Click to sort the transactions in ascending or descending order by date and time.

The transactions are sorted by date and time.

Searching for Specific Text in the Transactions Listed

You can search for a specific text in the transactions listed.

1.Type the text you want to search in the field and click Search.

The transactions containing the text are listed.

Deleting Transactions

1.You can delete the selected transactions or delete the filtered transactions.

• Select the transactions you want to delete and click Delete selected transaction(s).
• Click Delete filtered transaction(s) to delete all the filtered transactions.

The transactions are deleted.

Viewing Selected Transaction Details

You can view the details of a transaction.

1. Select a specific TID. In the transaction details page, the following fields are displayed:

   Field	Description
   Audit log
   Sender	Sender SAP system.
   Receiver	Receiver SAP system.
   Message Type	Message Type as defined in the SAP system.
   Date and Time Range	Restricts the transactions to a specific date and time interval.
   Current State	States of the tRFC protocol. Possible values are: Created-Transaction is created. Rolledback-Transaction is rolledback. Committed-Transaction is committed. Confirmed-Transaction is confirmed.
   Audit timestamp	Record of the date and time of the audit.
   Audit log	Collection of all the previous transactions.
   Document
   Document of transaction	Message body of the transaction.

Monitoring SAP® ERP Connection Pool

Monitor the SAP® ERP repository connection pools, the SAP® ERP client connections, and the listener status from the Monitoring page. You may access a list of the size attributes of all currently active connection pools, as well as the attributes of all currently locked connections for a specific connection.

Go to Monitor > Connectors > SAP® ERP > Connection pool. The Connection pool page appears. You can view the repository connection pools, client connections and listener status.

Repository connection pools

Repository connections are used to fetch metadata from SAP systems. The connection pools are shared by all the connections to the same SAP system and cannot be controlled or directly accessed by the user.

Go to Monitor > Connectors > SAP® ERP > Connection pool > Repository connection pools.

You can sort the fields in ascending or descending order.

Client connections

Go to Monitor > Connectors > SAP® ERP > Connection pool > Client connections.

You can sort the fields in ascending or descending order.

Click on the link in the Pools to see the details.

Click on the link in the Locked connections to see the details.

Listener status

Go to Monitor > Connectors > SAP® ERP > Connection pool > Listener status.

You can sort the fields in ascending or descending order.

Monitoring SAP® ERP Performance

Monitor the SAP® ERP performance, the SAP® response time summary, query requests and query components from the Monitoring page.

Go to Monitor > Connectors > SAP® ERP > Performance. The summary page appears.

Summary

You can monitor the SAP® response time summary.

Go to Monitor > Connectors > SAP® ERP > Performance > Summary.

You can refresh the data in the summary.

Query requests

You can view the SAP® query requests details and can also filter for the Gross time range and Net time range fields.

Go to Monitor > Connectors > SAP® ERP > Performance > Query requests.

You can sort the fields in ascending or descending order. You can refresh the data in the page.

Click the “>” icon for a request to view the details.

Click the “>” icon for the Filters to filter the query requests for the Gross time range and Net time range fields.

Query components

You can view the SAP® query requests details for a specific component.

Go to Monitor > Connectors > SAP® ERP > Performance > Query components.

You can refresh the data in the summary.

Click the “>” icon for the Filters to filter the query components for the Gross time range, Average gross time, Net time, and Average net time fields.

Lookup

SAP® ERP allows you to perform metadata lookups for IDocs, Business Objects, structures, tables, and function interfaces in specific SAP ABAP application servers.

Lookup Functions

You can view the RFC function module details in a specific SAP ABAP application servers and execute the selected function modules.

Go to Connector > Lookup. Select the Function tab.

How to lookup functions?

1. Go to Connector > Lookup.
2. Go to the Function tab.
3. Provide values for the following fields:
   • System ID - Select the system ID from the dropdown list.
   • Function Name - Enter a specific function or a function name with * for matching the similarly named functions.
     
   • Group Name - Enter the group name to filter the functions belonging to the group.

4. Click Apply to see the list of functions matching the criteria.

   Filtering the function to display all functions whose names begin with Z_RFC.

   

   Filtering the functions as per the groups.

   

Lookup function module signature

1. Go to Connector > Lookup.
2. Go to the Function tab.
3. Provide values for the following fields:
   • System ID - Select the system ID from the dropdown list.
   • Function Name - Enter a specific function or a function name with * for matching the similarly named functions.
     
   • Group Name - Enter the group name to filter the functions belonging to the group.

4. Click Apply to see the list of functions matching the criteria.

   

5. Select the function to view. For example, select Z_RFC_ADD.

   Field	Description
   Class	Class indicating the general type of the field. Possible values are: I – Input (Import) C – Changing (Import or Export) E – Output (Export) T – Table X – Exception
   Parameter	Parameter name.
   Table	Table name.
   Type	Data type allowed. Possible values are: CHAR - Character INTx – Integer values of various length (INT, INT1, INT2, INT8) NUM – Numeric values BCD – Binary coded decimal values DATE – Date values (various types) TIME – Time values (various types) FLOAT – Floating-point values BYTE – Byte values STRING – String values XSTRING – String values (in raw bytes) ABAPOBJECT – ABAP objects STRUCTURE – Data structure of given type TABLE – Table structure of given type EXCEPTION – Exception string
   Length	Length of the field if applicable, else 0.
   Decimals	Number of digits allowed after the decimal point. Used only for float or fixed-point numeric data types.
   Optional	Indicator to show whether the field is mandatory or optional. Possible values are: Yes No
   Test Function	Execute the function with given input parameters.

   

Testing a function

1. Go to Connector > Lookup.
2. Go to the Function tab.
3. Provide values for the following fields:
   
   • System ID - Select the system ID from the dropdown list.
   • Function Name - Enter a specific function or a function name with * for matching the similarly named functions. For example Z_RFC_ADD.
   • Group Name - Enter the group name to filter the functions belonging to the group.

4. Click Apply.

   

5. Select the function to view. For example, select Z_RFC_ADD.

6. In the Function Module Signature page, add the values for the input fields. For example, in the signature for Z_RFC_ADD, add IP_VALUE1, IP_VALUE2, and IP_VALUE3.

   

7. Click Test. The sum of all the input fields is displayed in the output field EP_RESULT.

   

Testing a function using RFC XML

1. Go to Connector > Lookup.
2. Go to the Function tab.
3. Provide values for the following fields:
   • System ID - Select the system ID from the dropdown list.
   • Function Name - Enter a specific function or a function name with * for matching the similarly named functions. For example Z_RFC_ADD.
   • Group Name - Enter the group name to filter the functions belonging to the group.

4. Click Apply.

   

5. In the Function Module Signature page, click Execute As > RFC XML.

   

   The RFC XML template for the function appears.

   

6. In the RFC XML template for the function, add the values for the input fields. For example, in the signature for Z_RFC_ADD, add IP_VALUE1, IP_VALUE2, and IP_VALUE3.

   

7. Click on Invoke on <<SYSTEM_ID>>. The sum of all the input fields is displayed in the output field EP_RESULT.

   

How to test a function using bXML?

1. Go to Connector > Lookup.
2. Go to the Function tab.
3. Provide values for the following fields:
   • System ID - Select the system ID from the dropdown list.
   • Function Name - Enter a specific function or a function name with * for matching the similarly named functions. For example Z_RFC_ADD.
   • Group Name - Enter the group name to filter the functions belonging to the group.

4. Click Apply.

   

5. In the Function Module Signature page, click Execute As > bXML.

   

   The bXML template for the function appears.

   

6. In the bXML template for the function, add the values for the input fields. For example, in the signature for Z_RFC_ADD, add IP_VALUE1, IP_VALUE2, and IP_VALUE3.

   

7. Click on Invoke on <<SYSTEM_ID>>. The sum of all the input fields is displayed in the output field EP_RESULT.

   

Lookup Business Objects

You can view the RFC function module details in a specific SAP ABAP application servers and execute the selected function modules.

Go to Connector > Lookup. Select the Business Object tab.

Lookup business object details

1. Go to Connector > Lookup.
2. Go to the Business Object tab.
3. Provide values for the following fields:
   • System ID - Select the system ID from the dropdown list.
   • Business Object Name - Enter a specific business object. A list of business objects starting with the name is provided. If the field is left blank (or an asterisk is entered), all existing Business Objects are displayed. For example Company.

4. Click Apply.

   

5. In the list of the business objects, select the business object to view the details.

   

The detailed information of a business object consists of a

1. List of all the Keyfields of a business object. The Keyfields list is empty for business objects, which only provide instance-independent methods (static methods in programming languages like C or JAVA).
2. List of all its BAPI methods. Optional. The list of BAPIs is empty for business objects that do not provide BAPIs.
3. List of all Events. Optional. The list of Events is empty for business objects that do not provide events.

Lookup keyfields of the business object

1. Go to Connector > Lookup.
2. Go to the Business Object tab.
3. Provide values for the following fields:
   • System ID - Select the system ID from the dropdown list.
   • Business Object Name - Enter a specific business object. A list of business objects starting with the name is provided. If the field is left blank (or an asterisk is entered), all existing Business Objects are displayed. For example Company.

4. Click Apply.

   

5. In the list of the business objects, select the business object to view the details.

   

6. Go to the Keyfield(s) tab.

   Field	Description
   Declaration object name	Object name selected and the unique id to identify the object. For example, CompanyCode (BUS0002).
   Internal name	Internal parameter name of the field.
   ABAP dictionary type	Usually, a field of a structure inside the SAP Data Dictionary. Click the link to view the data type description used for this parameter. Note Key fields are used with instance-dependent (non-static) methods and with factory methods. In calls to these methods, the key fields of the corresponding business object have to be specified as attributes of the business document root element.For example, using the key field CompanyCodeId in a call to the CompanyCode.GetDetail: <xml version=“1.0” encoding=“iso-8859-1”?> <biztalk_1 xmlns=“urn:biztalk-org:biztalk:biztalk_1”> <header> ….. </header> <body> <?doc:CompanyCode.GetDetail CompanyCodeId=“0001” xmlns:doc=“urn:sap-com:document:sap:business” xmlns=“”> </doc:CompanyCode.GetDetail> </body> </biztalk_1>

   Example of Keyfields in a business object.

   Example of ABAP Dictionary Type in a business object.

Lookup BAPI methods of the business object

1. Go to Connector > Lookup.
2. Go to the Business Object tab.
3. Provide values for the following fields:
   • System ID - Select the system ID from the dropdown list.
   • Business Object Name - Enter a specific business object. A list of business objects starting with the name is provided. If the field is left blank (or an asterisk is entered), all existing Business Objects are displayed. For example Company.

4. Click Apply.

   

5. In the list of the business objects, select the business object to view the details.

   

6. Go to the BAPI(s) tab.

   Field	Description
   BAPIs	BAPI method name. Click > to view the details: Parameters - Name of the parameter of the underlying RFC. Direction - Usage direction of the parameter. Possible values are: Importing , Exporting, Changing (importing and exporting). Optional - Value is set to true, indicates thar you can omit this parameter in an XML message. Usually, the implementation inside the SAP system uses specific default values for optional parameters that are omitted. Table – Value is set to true, indicates that the parameter consists of several lines, where each line has the data type specified in the ABAP Dictionary Type field. ABAP Dictionary Type - Link to the data type description used for this parameter. The value can be a whole structure or just a field of a structure. Following the hyperlink to see the whole structure.
   Static method	Flag to indicate if the BAPI is an instance-independent method. Possible values are: true. BAPI is an instance-independent method. You do not have to specify the business objects key fields when calling this method. false.
   Dialog method	Flag to indicate if the method is a dialog method. Possible values are: true. Method is a dialog method. Dialog BAPIs require a SAPGui. false. Method is not using a dialog.
   Factory method	Flag to indicate if BAPI is used to create an object instance inside the SAP system. Possible values are: true. BAPI is used to create an object instance inside the SAP system. Factory methods return the key fields of the business object. false.
   Function module	Message type that must be used to set up routing for synchronous calls coming from an SAP system. This is technically realized via RFC, so here the name of the corresponding RFC function module inside the SAP system is provided. Although it is possible, it is not recommended to call BAPIs directly via RFC-XML, as this would only be an implementation-dependent view of the BAPI.
   ALE message type	Optional. IDoc type, if the BAPI has a mapping for the specific IDoc type.

   

   Example of ALE Message Type in the BAPI:

   

7. Click > icon to view the details:

   

8. Click the link on ABAP Dictionary Type to view the details:

   

Lookup events of the business object

1. Go to Connector > Lookup.
2. Go to the Business Object tab.
3. Provide values for the following fields:
   • System ID - Select the system ID from the dropdown list.
   • Business Object Name - Enter a specific business object. A list of business objects starting with the name is provided. If the field is left blank (or an asterisk is entered), all existing Business Objects are displayed. For example OrderBasedOnCU.

4. Click Apply.

   

5. In the list of the business objects, select the business object to view the details.

   

6. Go to the Event(s) tab.

   A list of events is appears.

   Field	Description
   Events	Optional. Name of the available for this Business Object.
   Declaration object name	Business Object type name of this event. For example, OrderBasedOnCU (/CUM/ORDER)
   Internal name	Internal SAP name of the event (Always upper-case).

   

Lookup Table

1. Go to Connector > Lookup.
2. Go to the Tables tab.
3. Provide values for the following fields:
   • System ID - Select the system ID from the dropdown list.
   • Table Name - Enter a specific table name. For example RFCFunc.

4. Click Apply.

   Field	Description
   Field	Field Name which can consist of digits, letters, and underscores and must begin with a letter.
   Position	Field position in the table in ascending order.
   Length	Field length.
   Decimal	Number of digits allowed after the decimal point. Used only for float or fixed-point numeric data types.
   Type	Field data type. Possible values are: CHAR, TEXT, INTx, NUM, FLOAT, BCD, STRING, XSTRING, STRUCTURE, TABLE, ABAPOBJECT, EXCEPTION, DATE (various types), TIME (various types).
   Description	Field description.

   

Lookup IDoc

1. Go to Connector > Lookup.
2. Go to the IDoc tab.
3. Provide values for the following fields:
   • IDoc type - IDoc name. For example, MATMAS02.
   • IDoc type extension (optional) - Optional. the IDoc type extension.
   • Release (optional) - Optional. IDoc release number.

4. Click Apply.

   

5. Go to the Segments tab if applicable. Lists all the fields with the following details of each field:

   Field	Description
   Segment type	Internal name of the segment, independent of the SAP release. Segments can include child segments and fields.
   Segment definition	Release specific name of the segment or external name of the segment as seen by the partner system.
   Hierarchy level	Hierarchy level of the segment in this IDoc type.
   Required	Indicates if the segment type is mandatory. Possible values are yes and no.
   Min. occurrence	Minimum number of times a segment must occur in the IDoc.
   Max. occurrence	Maximum number of times a segment can occur in the IDoc.
   Qualified	Indicates if the segment is qualified. Possible values are yes and no.
   Description	Segment description.

   Example of IDoc with segments including child segments and fields:

   

6. Go to the Fields tab if applicable. Lists all the fields with the following details of each field:

   Field	Description
   IDoc data type	SAP data type of the field.
   Data dictionary type	Internal DDIC name of the data type of the field.
   ISO code	Possible values: yes. If the field contains an ISO code. no.
   Possible values	Optional. List of value/description pairs for the field, if available Value - Valid field value, or value range. Description - Description of the valid field value, or value range

   Example of IDoc with fields:

   

   Example of IDoc with field details:

   

Built-In Services

clientConnect

Establishes a connection to an SAP system.

Input Parameter

Return Values

Example

Use clientConnect when you want to establish a connection to a target SAP system. This might be useful for creating a session pool. In the most common scenarios, it is not necessary to invoke this service explicitly, as it is invoked implicitly. For example, when a clientInvoke or clientInvokeTransaction is issued.

clientLockSession

Locks an RFC connection to your session so that you always exclusively use this RFC connection for subsequent calls.

Input Parameter

Return Values

None

Example

The data is not written to the database until the client triggers a commit work command. In order to call a BAPI that writes data, you must perform the following steps on Integration:

1. Call the clientLockSession service in order to get an exclusive connection to the SAP system.
2. Perform the BAPI calls.
3. Call the BAPIcommitor BAPIrollback service
4. Call the clientReleaseSession service in order to release the exclusive connection to the SAP system and clean up used resources on Integration.

clientReleaseSession

Releases a locked session on an SAP system.

Input Parameter

Return Values

None

Example 1

The service releases a session after a commit work or rollback work command is triggered inside the SAP system.

In order to call a BAPI that writes data, you must perform the following steps on Integration:

1. Call the clientLockSession service in order to get an exclusive connection to the SAP system.
2. Perform the BAPI calls.
3. Call the BAPIcommit or BAPIrollback service.
4. Call the clientReleaseSession service in order to release the exclusive connection to the SAP system and clean up used resources on Integration.

Example 2

You also need this service if you want to lock and change a certain database object. To do this, please proceed as follows:

1. Call the clientLockSession service in order to get an exclusive connection to an SAP system.
2. Lock an object by calling a BAPI_*_ENQUEUE.
3. Make your changes by invoking other BAPIs.
4. Release the object by calling a BAPI_*_DEQUEUE.
5. Call the clientReleaseSession service.

clientInvoke

Invokes an RFC function module in synchronous mode on a given SAP system.

Input Parameter

Return Values

This service returns the outputs (exports and tables) returned by the function module.

Example

This service is used when you are directly calling an RFC on an SAP system without creating an RFC adapter service. When an RFC adapter service is used, this service is invoked implicitly.

clientInvokeTransaction

Invokes a tRFC function module on a given SAP system.

Input Parameter

Return Values

Example

This service is used in outbound flows and can handle both synchronous and transactional RFC calls. Therefore, it can be seen as a generic wrapper for clientInvoke, clientInvokeTransaction and clientConfirmTID.

clientCreateTID

Call this service if you want to obtain a transaction ID (TID; which is a GUID) that conforms to the format of SAP TIDs.

The obtained TID can be used as an input value for clientInvokeTransaction, clientSendIDoc, and clientConfirmTID.

Input Parameter

Return Values

Example

This service is used in tRFC client scenarios, which require a transactional ID (TID) uniquely identifying the transaction. See also clientConfirmTID.

clientConfirmTID

Confirms the transaction specified by the TID on the specified SAP system.

This service must be called after a transactional invoke in order to complete a transaction on the target system.

Input Parameter

Return Values

None.

Example

This service is used in tRFC client scenarios in order to confirm a transaction which is executed completely.

1. Invoke clientCreateTID. This service creates an SAP-conformant TID. It is necessary to have one, otherwise you cannot invoke the function module with clientInvokeTransaction. If you have already obtained a TID, you must use that one in order to guarantee that the transaction is executed only once.
2. Invoke clientInvokeTransaction. This service invokes the given function module as a tRFC on the SAP system specified by serverName. The TID is passed as a parameter on this call.
3. Invoke clientConfirmTID. Confirms that the transaction is completed. Pass the same serverName and $tid value on this call.

clientGetAttributes

Connects to the given SAP system and returns information specific to one RFC client connection session.

Input Parameter

Return Values

clientGetFunctionInterface

Looks up the function interface definition of an RFC function module in the given SAP system.

Input Parameter

Return Values

Document list named params that contains all parameter-related information.

clientGetStructureDefinition

Looks up the structure definition of an SAP structure in the given SAP system.

Input Parameter

Return Values

Document list named params that contains all parameter-related information:

clientGetThroughput

Returns the performance throughput value of the connection since the adapter startup or the last reset to zero

Input Parameter

Return Values

clientSendIDoc

Sends an IDoc list to a given SAP system. The IDocs in the list must be of the same IDoc type.

Input Parameter

Return Values

clientSendIDocLists

Sends a heterogenous list of IDoc lists to a given SAP system. All the IDoc elements in an IDoc list must be of the same IDoc type, but the IDoc lists can contain different types. All IDocs can be processed in a single transaction.

Input Parameter

Return Values

clientPing

Checks the response time of an SAP system.

Input Parameter

Return Values

RFCdecode

Converts an RFC-XML (XRFC) string into the pipeline so that is in a format that can be passed to an SAP system.

Input Parameter

Return Values

Example

This service can be used when an RFC-XML document is posted to Integration in a variable.

RFCencode

Converts an RFC call stored in the pipeline to an XML string in a format specified by the SAP RFC-XML (XRFC) specification.

Input Parameter

This service needs the RFC calls in Values representation as input.

Return Values

Example

Use this service to create RFC-XML corresponding to the pipeline and perhaps forward it to another server, for example, via HTTP. This is done in the XML transport’s Outbound Process for function modules.

RFCcreateTemplate

Creates an RFC-XML (XRFC) template for the specified function module.

Input Parameter

Return Values

Example

Use this service to create templates for testing purposes.

IDocDecodeSDATA

Converts the SDATA field from a String object to a Document object and immediately converts the whole list of IDocs to a com.sap.conn.idoc.IDocDocumentList object for further processing.

The IDocDecodeSDATA service is only required if you receive an IDoc in the tables representation from a sending system. That is, you have created an RFC listener notification for function module IDOC_INBOUND_ASYNCHRONOUS or INBOUND_IDOC_PROCESS.

Input Parameter

Return Values

IDocDecodeString

Decodes an IDoc from a String equivalent, the format that is used by the file port of an SAP system.

Input Parameter

Return Values

documentToIDoc

Converts a document to an object of type IDoc(s).

Input Parameter

Return Values

IDocEncodeSDATA

Converts every SDATA field from a Document object to a String object.

This service is usually called prior to sending an IDoc to an SAP system via clientInvokeTransaction or by an RFC adapter service for function module IDOC_INBOUND_ASYNCHRONOUS or INBOUND_IDOC_PROCESS.

Input Parameter

Return Values

IDocEncodeString

Encodes an IDoc to a String equivalent, the format that is used by the file port of an SAP system.

The service first checks for the iDocList field, if that parameter is not present, it looks for the IDOC_* record lists.

Input Parameter

Return Values

IDocToDocument

Generates a Document representation of an IDoc list to perform mappings in Flow service.

Input Parameter

Return Values

IDocToTables

Generates tables from an object of type IDoc(s).

Input Parameters

Return Values

tablesToIDoc

Generates object of type IDoc(s) from tables.

Input Parameters

Return Values

IDocEncode

Service that converts an IDoc list to an XML string in a format specified by the SAP IDoc-XML Specification.

Input Parameters

Return Values

Example

This service is most often used when you want to receive an IDoc from an SAP system and convert it to XML.

• Invoke IDocEncode. This takes the pipeline containing the IDoc as input and converts it to an XML string. The XML string is accessible in the pipeline via the xmlData key.

IDocDecode

Service that converts an XML string in a format specified by the SAP IDoc-XML Specification into an IDoc that is of the type com.sap.conn.idoc.IDocDocumentList and necessary for an RFC call (using clientSendIDoc).

Input Parameters

Return Values

Example

This service is the first service called when you want to send an IDoc-XML document to an SAP system. The following is a sequence of service calls that take an IDoc in XML format, convert it to a com.sap.conn.idoc.IDocDocumentListcom.sap.conn.idoc.IDocDocumentList object, then fire it into the SAP system:

1. Invoke this service (IDocDecode). This takes the input xmlData (the XML String) and creates an com.sap.conn.idoc.IDocDocumentList object that is in RFC-ready form. (This means that it matches the RFC call used to send an IDoc into the SAP system, and that the pipeline is almost in the required format).
2. Invoke clientCreateTID service. Use this service to request a transaction id from an SAP system that can be used for sending the IDoc to the SAP system.
   Note

   Store this transaction ID, so that you can resend the IDoc in case of errors with the same ID.
3. Invoke clientSendIDoc.

IDocTrace

Internal service used to trace the status of certain IDocs back to either the sending SAP system or to a further processing .

This service is directly called from SAP systems.

Input Parameters

Return Values

swapSenderReceiverLS

Switches Sender and Receiver (logical systems) for a list of given ALEAUD01 IDocs.

Input Parameters

Return Values

SYSTAT01report

This service sends out SYSTAT01 IDocs to the sending SAP system for all IDocs that have been received in ‘Monitoring’ mode.

Can be executed exactly once for the IDocs of a transaction.

Input Parameters

None.

Return Values

None.

BAPIdecode

Decodes bXML documents and generates a corresponding pipeline.

Input Parameters

Return Values

BAPIencode

Converts a BAPI call represented in a pipeline to an XML string in a format specified by the SAP bXML specification.

Input Parameters

Return Values

BAPIcreateTemplate

Generates a bXML document template for the definition of a BAPI in an SAP system.

Input Parameters

Return Values

BAPIcommit

Commits a transaction with a single or multiple BAPI calls.

Input Parameters

Return Values

BAPIrollback

Rolls back a transaction with a single or multiple BAPI calls.

Input Parameters

Return Values

listTransactions

Returns a list of transactions from the transaction store that match the filter criteria. Regular expressions are supported to allow flexible filter criteria matching.

Input Parameters

Return Values

getTransaction

Returns detail information for a single transaction.

Input Parameters

Return Values

getTransactionMessageBody

Returns the pipeline containing the actual message body.

Input Parameters

Return Values

None.

getTransactionLog

Adds a new audit log entry to the given transaction, and optionally changes the transaction status to the given new state.

Input Parameters

Return Values

None.

setTransactionCacheParameter

This service sets new runtime parameters for the cache of the transaction store.

Input Parameters

Return Values

None.

storeTransactionConfig

Returns the current configuration and cache parameter of the transaction store.

Input Parameters

None.

Return Values

deleteTransaction

Deletes one transaction from the transaction store.

Input Parameters

Return values

None.

deleteAllTransactions

Deletes the entire transaction store. Exercise care if you choose to use this.

Input Parameters

None.

Return Values

sweepTransactions

This service can be used to cleanup the transaction store that matches the given filter criteria.

For example, set it up in the Scheduler as follows:

1. Create a Flow Service, which invokes sweepTransactions.
2. In the Flow Service, define the inputs using Set Value.
3. Create a scheduler job that executes the Flow Service.

Input Parameters

Return Values

ALEinboundProcess

Receives an IDoc and forwards it to the routing listener.

Input Parameters

Return Values

None.

ALEoutboundProcess

Receives an IDoc and forwards it to the routing listener.

Input Parameters

Return Values

None.

ALEgetRoutingInfo_Default

Default service to retrieve routing information from a list of IDocs.

Input Parameters

Return Values

ISinboundProcess

Receives a message from a remote Integration and forwards it to the routing listener, which determines the routing notification to use to route the message based on the sender, receiver, and message type specified in the input parameters.

After determining the routing notification to use, it invokes the flow service that processes the matching routing notification. This can be called with an arbitrary message to pass it on to the routing listener.

Input Parameters

In addition to the parameters specified below, the input parameters must also include the message to be routed through SAP® ERP. Use a key for the message that the outbound transport expects.

Return Values

Depends on transaction and invoked routing notification.

RFCinboundProcess

Invokes an RFC on an SAP system.

This service can handle both RFC and tRFC calls.

Input Parameters

This service requires the following input parameters:

Return Values

RFCoutboundProcess

Invokes an RFC on an SAP system.

This service can handle both RFC and tRFC calls.

Input Parameters

This service requires the following input parameters:

Return Values

XMLinboundProcess

Can be called \for example, using HTTP post with arbitrary XML documents to pass them on to the routing listener.

Input Parameters

This service requires the following input parameters:

Return Values

Depends on transaction and invoked routing notification.

XMLoutboundProcess

Use this service to post an XML document to a specified URL. The XML transport is basically used for posting XML documents to external Web servers.

Input Parameters

This service requires the following input parameters:

Return Values

The return values depend on the document that is posted. The return value is a Values object representation of the answer to the posted document.

BAPIinboundProcess

When posting bXML documents representing a BAPI of a Business Object to this service, it takes care of passing the document to the routing listener.

Input Parameters

Return Values

Depends on transaction and invoked routing notification.

BAPIoutboundProcess

Executes a BAPI in an SAP system. This transport service can handle both asynchronous and synchronous execution of a BAPI.

Input Parameters

Return Values

A pipeline that represents the response or an exception of the executed BAPI.

Builtin Services Specifications

ALE Routing Info Default

To allow content based routing for all IDocs, the user might provide a service that implements this specification.

This service is called prior to selecting the right routing notification by the routing listener.

Input Parameters

Return Values

ALE Routing Info

To allow message type specific content based routing, the user might provide a service that implements this specification.

This service is called prior to selecting the right routing notification by the routing listener but after the default ALE routing info service was called.

Input Parameters

Return Values

ALE Mapping Info

To allow message type specific mapping for IDocs, the user might provide a service that implements this specification.

This service is called prior to sending an IDoc to an SAP system using the pub.sap.transport.ALE:OutboundProcess service but after the default ALE mapping info service is called.

Input Parameters

Return Values

ALE Mapping Info Default

To allow mapping for all IDocs, the user might provide a service that implements this specification.

This service is called prior to sending an IDoc to an SAP system using the pub.sap.transport.ALE:OutboundProcess service.

Input Parameters

Return Values

XML Routing Info

To allow routing for incoming XML documents, the user must provide a service that implements this specification.

This service is called prior to selecting the right routing notification by the routing listener.

Input Parameters

Return Values

createTIDOffline

Call this service if you want to obtain a transaction ID (TID; which is a GUID) that conforms to the format of SAP TIDs even when not connected to a SAP system. The Transaction ID is based on a randomly created UUID Version 4.

The obtained TID can be used as an input value for clientInvokeTransaction, clientSendIDoc, and clientConfirmTID.

Input Parameters

None.

Return Values

Example

This service is used in tRFC client scenarios, which require a transactional ID (TID) uniquely identifying the transaction. See also clientConfirmTID.

getListenerRuntimeStatus

Call this service if you want to obtain the current runtime state and configuration of an enabled RFC listener instance.

Input Parameters

Return Values

How to create the SAP® ERP Account

Let’s understand how to use the SAP® ERP action with the help of an example.

Let’s say you have a project Test_SAP_ERP. You want to create a SAP® ERP Account.

To create a SAP® ERP Account, follow the steps given below:

1. Select Connectors from the menu.
   
2. Search SAP® ERP in the Available Connectors section.
   

3. Select SAP® ERP connector. This will take you to the Add account configuration screen.

   

4. Provide the following details:

   • Connection alias - Provide a suitable name for the account you want to add.
   • User name - Provide the SAP registered user name.
   • Password - Provide the password for the SAP registered user.
   • Client - Provide the 3-digit SAP client number.
   • Repository user name (Optional) - Provide the repository user name.
   • Repository password (Optional) - Provide the password of the repository user.
   • SAP router string (Optional) - Provide the SAP router string.
   • Language - Select the supported language from the dropdown list.
   • Description (Optional) - Provide the description. Click Next.

5. Select the Connection mode setting selection.

   Click Next.

6. Provide the details in the Connection mode.

   • If you selected Standard (Default) as the connection mode, provide the following details:

     • Application server - Provide a SAP application server name.
     • System number - Provide a SAP system number (00-99).

   • If you selected Load Balancing as the connection mode, provide the following details:

     • Logon group - Provide the name of the group you want to login.
     • Message server host - Provide a host name or IP address of the message server.
     • Message server service - Provide a SAP message server service.
     • System Id - Provide a SAP system number (00-99).

   Click Next.

7. Verify the connection details.

   Click Add account.

8. Select Done.

You will see the configured custom account.

How to create a Document Type for SAP

Let us see how to create a new document type from an SAP RFC structure or SAP IDoc, that matches the structure of the document and content of the SAP RFC structure or SAP IDoc respectively.

Let’s say you have a project DocTest_Project.

To create a SAP® ERP Account, do the following:

1. Select Configurations > Flow service > Document types.

   

2. Click Add Document Type.

   

3. In the Add new Document type screen, select SAP®.

   

   Click Ok.

4. In the System ID and document screen, provide the following details:

   • Save As - Provide a suitable name for the Document Type you want to add.
   • System ID - Type or select System ID (SID) of the source SAP system.
   • Document type - Select the document type RFC or IDoc.
   • Description - Optional. Provide a description for the document type.

   

   Click Next.

5. In the Document details screen, provide the following details:

   • If you selected RFC as the Document type, provide the following details:
     • RFC structure - Select the RFC structure from the dropdown list of cached names. If cached names are not available, you must type the RFC structure name.
       

   

   • If you selected IDoc as the Document type, provide the following details:
     • IDoc type - Select the IDoc type expected by the listener notification from the dropdown list of cached names. If cached names are not available, you must type the IDoc type.
     • CIM type(optional) - Provide a IDoc type extension (CIM type / customer extension type).
     • SAP system release(optional) - Provide the IDoc release.
     • Old IDoc type 2 (optional) -
       • Checked for old version 2 IDocs.
       • Unchecked for a new version 3 IDoc.
       
       

   

   Click Save and continue.

6. In the Overview screen, verify the details and click Done.

   • If you selected RFC as the Document type:

   • If you selected IDoc as the Document type:

   A new Document Type is created.

   Note

   You can add, edit, delete, or copy a document type from the Document Types page. To edit an existing document type, on the Document Types page, click the Edit icon for the document type.

IBM® Power®

IBM® Power® connector facilitates data exchange with IBM Power systems through the use of IBM Toolbox for Java. IBM® Power® ensures smooth and real-time communication with the IBM Power systems. You can create and run services capable of running commands and programs, as well as reading and writing data from the dataqueues on the IBM Power systems.

IBM® Power® consists of the following components:

• Account: Facilitates the connection with IBM Power systems. Configuring an account is essential for performing any operation through IBM® Power® actions.
• Actions: Enables the initiation and running of commands and programs, as well as reading from and writing data to the dataqueues. Actions are based on templates provided by IBM® Power®. Each template represents a command that can be performed on the IBM Power systems. For example, the Read DataQueue action retrieves specified data from the IBM Power systems.
• Built-in Services: Provides the capability to initiate and run services. For example, you can use createDataQueue for creating a dataqueue in the IBM Power systems.

Creating a New Account

1. In the Flow services page, click (Plus) icon to create a new deploy anywhere flow service.

2. Select Deploy Anywhere Flow Service and click Create.

3. Provide a name and description for the deploy anywhere flow service. Description is optional.

4. From the list, select an Runtime on which you run a deploy anywhere flow service.

5. On the flow service step, type IBM® Power® to select the IBM Power connector.

   

6. In the Type to choose action box, click Add Custom Action.

   

   The Connect account page appears.

7. Perform the following in the Account page to create an account that can be used to access IBM Power systems:

   a. Enter the name and description for the action.

   b. Select the runtime. The Runtime on which the action or account is deployed. By default, the selection on the Flow Editor page is considered. However, if you change the Runtime on Add account wizard, the connection is redeployed.

   Note

   The Runtime selected in the Default runtime field takes precedence during the connection redeployment.

   

   c. Click the (Plus) icon to add a new IBM® Power® account. You are redirected to the Add account wizard.

   d. Enter the following details in the Add account wizard:

   • Connect to account IBM® Power®: Name of the account by which the IBM Power system is known to IBM® Power® developers, clients, and partners.
   • Default system user: Use the default user for the system name specified in the System name field.
   • User: Username of the IBM Power system.
   • Password: Password of the user defined in the User field or the default user for the system name specified in the System name field.
   • System name: Hostname or IP address of the IBM Power system.

   • Service type: Type of service representing the various ways to interact with and utilize an IBM Power systems service type capabilities, such as for data management, system administration, or other tasks. The specific usage and functionality can vary depending on the context and the software or tools being used to establish the connections. Possible values are:

     • COMMAND - Runs the non-interactive Control Language (CL) commands or Report Program Generator (RPG) programs. You can perform system administration and automation tasks.
     • DATAQUEUE - Performs read or write and other operations on the dataqueue of the IBM Power system. Dataqueues are used for asynchronous communication between programs on the system.
       
     Note

     Create an account with COMMAND service type if you want to use services like Call Command or Call Program, and an account with DATAQUEUE service type if you want to use services like Read DataQueue or Write DataQueue.

   • Current library: Optional. Library used for accessing the IBM Power system resources. The library specified in the Current library field is available as %CONN_CURLIB% envionment variable in your service.

   • Socket Properties: Any socket properties that you prefer to add for this account, which the IBM Toolbox for Java sets on its client side sockets. You can select or type the property name and enter the value in the corresponding input text field.

     • Property Name: Name of the property. You can select the property from the drop-down list or use the ’+’ button to add a new property.
     • Property Value: Value for the property selected.

   • Other Properties: Any additional properties that you prefer to add for this account. You can type the property name and enter the value in the corresponding input text field.

     • Property Name: Name of the property. You can use the ’+’ button to add a new property.
     • Property Value: Value for the property selected.
       
   Note

   IBM® Power® connector for Develop Anywhere, Deploy Anywhere enabled tenants does not support SSL connections.

   

   

   

   d. Click Next. The Add account > Advance Setting page appears.

   e. Provide the following details in Advance Setting page to configure connection pooling manually:

   Note

   Connection pooling is enabled by default.
   • Enable connection pooling:
     • Manual: Toggle the slider to right to enable configuration of the connection pooling details manually. The default value is manual. Disable the Manual connection pooling to use system defined values.
       
   • Minimum and maximum Pool Size: Minimum and maximum connection pool size for this account.
     • Minimum Pool Size: Number of connections to create when the connection is enabled. The system maintains the specified Minimum Pool Size of connections, irrespective of whether these connections remain idle.
     • Maximum Pool Size: Maximum number of connections that can exist at a time in the connection pool.
   • Block timeout: Number of milliseconds that Integration waits to obtain a connection with the IBM Power system before it times out and returns an error. For example, you have a pool with maximum pool size of 20. In the event of receiving 30 simultaneous connection requests, 10 requests will be queued, awaiting a connection from the pool.
     • If you set the Block timeout value to 5000, the 10 requests will wait for 5 seconds to establish a connection before they time out and return an error. If the services using the connections require 10 seconds to complete and return connections to the pool, the pending requests will encounter failure and return an error message stating the unavailability of the connections.
     • If you set the Block timeout value too high, you may encounter problems resulting in error. If a request contains errors that delay the response, other requests will not be sent. This Block timeout must be tuned in conjunction with the Maximum Pool Size setting to accommodate such bursts in processing.
   • Expire timeout: Number of milliseconds that an inactive connection can remain in the pool before it is closed and removed from the pool. The connection pool removes inactive connections until the number of connections in the pool is equal to the Minimum Pool Size. The timer for an inactive connection is reset when the connection is used.
     • If you set the Expire timeout value too high, the connection pool might accumulate numerous unused and inactive connections. This not only consumes local memory but also ties up a connection on your backend resource. This could have an adverse effect if your resource has a limited number of connections.
     • If you set the Expire timeout value too low, the performance could degrade because of the increased activity of creating and closing connections. This Expire timeout must be tuned in conjunction with the Minimum Pool Size setting to avoid excessive opening and closing of connections during processing.
       

   

   f. Click Next. The Add account > Synchronize page appears.

   

   g. Click Next. The Next button is enabled only after a successful validation. The Add account > Test and review page appears.

   h. Review the account details.

   

   

   i. Click Test connection to verify the connection. A success message appears if the connectivity is successful.

   

   j. Click Enable.

   

   k. Click Done.

   You are redirected to the Add custom action page and the newly created account appears in the Connect to account drop-down list. You can use this account to run any IBM® Power® custom action created under the same project.

   

Action Types

IBM® Power® provides templates to perform the following types of actions:

• Call Command: Runs a non-interactive IBM Power batch command, providing a flexible interface for invoking system commands programmatically.
• Call Program: Initiates an IBM Power program, enabling seamless integration and interaction with custom or external programs on the system.
• Read DataQueue: Reads messages from an IBM Power dataqueue, facilitating data retrieval for further processing.
• Write DataQueue: Writes messages to an IBM Power dataqueue, allowing seamless integration with systems using a DataQueue for communication.

Creating Read and Write DataQueues

1. In the Flow services page, click (Plus) icon to create a new deploy anywhere flow service.

2. Select Deploy Anywhere Flow Service and click Create.

3. Provide a name and description for the deploy anywhere flow service. Description is optional. For example, GetCustomerInfo.

4. From the list, select an Runtime on which you run a deploy anywhere flow service.

5. On the Flow service step, type IBM® Power® to select the IBM® Power® connector.

6. In the Type to choose action box, click Add Custom Operation.

7. Perform the following in the Account page to create an account that can be used to access IBM Power systems:

   a. Enter the name and description for the action.

   b. Select the runtime. The Runtime on which the action or account is deployed. By default, the selection on the Flow Editor page is considered. However, if you change the Runtime on Add account wizard, the connection is redeployed.

   Note

   Runtime selected in the Default runtime field takes precedence during the connection redeployment.

   c. Select the IBM® Power® account.

   

   d. Click Next.

8. Select the Read DataQueue or Write DataQueue action in the Action page.

   

9. Click Next.

10. Provide the following fields in the Data queue page:

    • Library name: Name of the library where the dataqueue exists. Type the library name or select from the library list (containing user, system, and other libraries added).
      
    • Queue name: Name of the dataqueue.
    • Operation type: Type of read operation. Available in Read DataQueue only. Possible values are:
      • Read: Reads a record from the dataqueue and removes it from the dataqueue. If no records exist in the dataqueue, then returns.
      • Peek: Reads a record from the dataqueue without removing it from the dataqueue. If no records exist in the dataqueue, then returns.
    • Read timeout (sec): Time in seconds to wait if the dataqueue is empty. Specify -1 to wait until a record becomes available. Available in Read DataQueue only.
    • Queue type: Type of dataqueue. Possible values are:
      • Sequential. Dataqueue organized in a linear or sequential order.
      • Keyed. Dataqueue organized as key-value pair. The key-value pair allows direct access to messages based on the specific identifier (key).
    • Key type: List of the IBM Power native data types in which the key is stored in the dataqueue if the Queue type is Keyed.
    • Key input type: List of the possible Java data types corresponding to the Key type selected, if the Queue type is Keyed.
    • Key length: Length of the key in bytes if the Queue type is Keyed.
    • Key value: Value of the key if the Queue type is Keyed.
    • Key compare type: Type of comparisions to perform on the Key value if the Queue type is Keyed. Available in Read DataQueue only. Possible values are:
      • EQ: Equal
      • NE: Not equal
      • LT: Less than
      • LE: Less than or equal
      • GT: Greater than
      • GE: Greater than or equal

    Sample of the Data queue page in Write DataQueue:

    

    Sample of the Data queue page in Read DataQueue:

    

11. Click Next. The Record page appears.

12. Click Add Record and provide the following fields in the Record page:

    • Data name: Name of the record to be stored in or retrieved from the dataqueue.
    • Native data type: List of IBM Power native data types for the record.
    • Byte length: Length in bytes of the data value.
    • Is array: Flag to indicate if the data value is an array.
    • Input data type: List of possible Java data types depending on the Native data type and the Is array fields selection. Available in Write DataQueue only.
    • Data occurrence: Number of elements in the array if Is array is selected. Available in Read DataQueue only.
    • Output data type: List of possible Java data types depending on the Native data type and the Is array fields selection. Available in Read DataQueue only.
    • Data value: Value of the record to store in the dataqueue. You can specify the data value either in the field or during runtime. If the intention is to provide the value at runtime, then include a ? in the Data value field. Available in Write DataQueue only.

    Sample of the Record page in Write DataQueue:

    

    Sample of the Record page in Read DataQueue:

    

13. Click Next. The Overview page.

14. Verify the details in the Overview page.

    

15. Click Add. The success message appears.

    

16. Click Done. The flow service editor page appears.

17. Click (Save) to save the service.

18. Click (Sync) to sync the service.

19. Click (Run) to run the service.

    Sample of the run in Write DataQueue:

    

    Sample of the run in Read DataQueue:

    

Creating Call Command and Call Programs

1. In the Flow services page, click (Plus) icon to create a new deploy anywhere flow service.

2. Select Deploy Anywhere Flow Service and click Create.

3. Provide a name and description for the deploy anywhere flow service. Description is optional.

4. From the list, select an Runtime on which you run a deploy anywhere flow service.

5. On the Flow service step, type IBM® Power® to select the IBM Power connector.

6. In the Type to choose action box, click Add Custom Operation. The Connect account page appears.

7. Perform the following in the Account page to create an account that can be used to access IBM Power systems:

   a. Enter the name and description for the action.

   b. Select the runtime. The Runtime on which the action or account is deployed. By default, the selection on the Flow Editor page is considered. However, if you change the Runtime on Add account wizard, the connection is redeployed.

   Note

   Runtime selected in the Default runtime field takes precedence during the connection redeployment.

   c. Select the IBM® Power® account.

   

   d. Click Next.

8. Select the Call Command or Call Program action in the Action page.

   

9. Click Next.

10. If you have selected Call Command in the Action page:

    a. Provide the following details in the Command page:

    • Library name: Optional. Name of the library where the command exists. Type the library name or select from the library list (containing user, system, and other libraries added). Default is *LIBL.
    • Command name: Name of the command to call.
    Note

    When you select a command to call, the description for the command appears.

    

    b. Click (Plus) icon to add the parameters which must be passed to the command.

    c. Provide the following fields in the Add Parameter page:

    • Name: Name of the parameter to pass when the command is called.
    • Value: Value associated with the parameter. You can specify the parameter value either in the field or during runtime. If you want to provide the value at runtime, then include a ? in the Value field.
      

    

    d. Click Add.

    e. The Command page appears with the parameters listed.

    

    f. Click Next. The Overview page appears.

11. If you have selected Call Program in the Action page:

    a. Provide the following details in the Program page:

    • Library name: Name of the library where the program exists. Type the library name or select from the library list (containing user, system, and other libraries added).
    • Program name: Name of the program to call.
    • Inquire message reply: Option to indicate how the program must respond to inquiry messages.
      • INQUIRY_MESSAGE_REPLY_DEFAULT - Sends the default reply message to respond to any inquiry received while the program is running. The default reply is either defined in the message description or is the default system reply.
      • INQUIRY_MESSAGE_REPLY_SYSTEM_REPLY_LIST - Checks system reply list to see if there is an entry for an inquiry message issued while the program is running. If a match occurs, the system sends the reply value for that entry. If no entry exists for that message, the system sends an inquiry message.
        

    

    b. Click Next. The Input page appears.

    c. Provide the following details in the Input page:

    • Input parameter name: Name of the input parameter to pass when the program is called.
    • Native data type: List of IBM Power native data types for the parameter.
    • Byte length: Length in bytes of the input parameter value.
    • Is array: Flag to indicate if the parameter value is an array.
    • Input data type: List of possible Java data types depending on the Native data type and the Is array field selection.
    • Parameter value: Value associated with the parameter. You can specify the parameter value either in the field or during runtime. If you want to provide the value at runtime, then include a ? in the Parameter value field.
      

    

    d. Click Next. The Output page appears.

    e. Provide the following fields in the Output page:

    • Output parameter name: Name of the output parameter returned when the program is called.
    • Native data type: List of IBM Power native data type for the parameter.
    • Is array: Flag to indicate if the parameter value is an array. Default value is 1.
    • Data occurrence: Number of elements in the array if Is array is selected.
    • Output data type: List of possible Java data types depending on the Native data type and the Is array field selection.
    • Output data length: Length in bytes of the output data value.
      

    

    Note

    If you want to specify a parameter as both input and output, add the parameter in the Input page as well as in the Output page with the same parameter name.

    f. Click Next. The Overview page appears.

12. Verify the details in the Overview page.

    

13. Click Add. The success message appears.

    

14. Click Done. This will redirect you to the flow service editor page.

15. Click (Map Pipeline) to add the input parameters to the service pipeline.

    Sample of the map pipeline in Call Command:

    

    Sample of the map pipeline in Call Program:

    

16. Click (Save) to save the service.

17. Click (Sync) to sync the service.

18. Click (Run) to run the service.

    Sample of the run service in Call Command:

    

    Sample of the run service in Call Program:

    

IBM® Power® BuiltIn Services

createDataQueue

Creates a sequential or keyed dataqueue in the IBM Power system.

Input Parameter

Return Values

getDefaultUser

Returns the default user ID for the system name specified in $connectionAlias.

Input Parameter

Return Values

removeDefaultUser

Removes the default user for the system name specified in $connectionAlias.

Input Parameter

Return Values

setDefaultUser

Sets the default user for the system name specified in $connectionAlias.

Input Parameter

Return Values

Data Store

Store and retrieve keys with local and global scope for your workflows.

Actions

• Flow Store: Store and retrieve one or more key-value pairs with local scope.

• Account Store: Store and retrieve one or more key-value pairs with global scope.

• Memory Store: Store and retrieve one or more key-value pairs that are specific to one workflow.

Know how to use Account Store, Flow Store, and Memory Store actions in detail.

DevOps Tools

Execute shell commands over SSH connections.

Actions

• Execute shell commands over SSH connection: Run shell commands over an SSH connection

Developer Tools

Developer Tools are the set of in-built services offered by IBM webMethods Integration to help you add advanced functionalities to your workflows.

Actions

• Global Error Handler: Continue workflow execution or follow a specific path even if there is an error

• Return Data on Sync Webhook: Run a flow by calling webhook URL to retrieve it’s output in the body of the URL

• Run Flow: Include and run an existing flow in your current workflow

• Format Date and Time: Customize the date and time to be used in your workflow

  The Format Date and Time action supports the following date formats:

  Format	Description	Example
  MM/DD/YYYY	Month/Day of the Month/Year (with leading zeros)	11/18/2009
  M/D/YYYY	Month/Day of the Month/Year (with no leading zeros)	2/18/2018
  YYYY/M/D	Year/Month/Day of the Month (with no leading zeros)	2009/11/18
  sM/sD/YYYY	(space)Month/(space)Day of the Month/Year (with spaces instead of leading zeros) Here, ‘s’ represents a blank space that can be inserted before a single-digit day or a single-digit month.	s1/s9/2006
  YYYY/sM/sD	Year/(space)Month/(space)Day of the Month (with spaces instead of leading zeros) Here, ‘s’ represents a blank space that can be inserted before a single-digit day or a single-digit month.	2008/s9/s1
  YYYY-MM-DDThh:mm:ssZ	ISO 8601 UTC date and time format	2013-07-16T19:23:51Z

• Download File: Download a specific file from internet

• Text to Emoji: Convert plain text to emojis

• Logger: See the output of previous activities in console log

• WIKI Page Search: Search any topic on Wikipedia.org

• Switch: Create multiple execution paths in your workflow

• Delay: Delay the execution of a specific action for a specified number of seconds

• Set Workflow Status Failed: Set the status of a workflow to ‘failed’ irrespective of its actual execution status. You can optionally specify a custom error message to be displayed whenever a workflow fails as a result of this action.
  Whenever you attach a Global Error Handler to your workflow, it always successfully executes the workflow. If you want such workflows to fail, add ‘Set Workflow Status Failed’ action inside the Global Error Handler action.

• Error Handler: The Error Handler action lets you complete the workflow execution even if one of the workflow actions fails. This is especially useful in scenarios where you are working with critical workflows and you do not want an error to terminate the workflow execution abruptly.

  Error Handler Example

  Let’s say we have a workflow where whenever a new Member is added to a specific Trello Board, the member details are posted to a channel on Slack and a notification email is sent to specific recipients.

  To make sure that the workflow execution does not fail abruptly due to any error in the Post Message to Channel action, attach an Error Handler to it. This Error Handler action will ensure that the workflow execution completes despite error.

  Next, create a success path for the Post Message to Channel action to specify the next action (in this case, Send an Email) that should be executed if Post Message to Channel action executes without any errors.

  

  Note

  Every action that is attached to an Error Handler must also have a ‘Success Path’. If you do not create a success path, you will get an error similar to the one shown below:

• Set Context ID: Define a unique identifier for a particular workflow. Read more about how to set a custom context ID for a particular workflow.

File

The File actions let you accomplish certain tasks when working on file-related activities.

Actions

• Decyrpt PGP File: Decrypt the specified PGP File

• Write File: Create a new file on IBM webMethods Integration engine local storage

• File Append: Append specific data at the end of an existing file saved on IBM webMethods Integration engine local storage

• Open Readable File Stream: Read an existing file saved on IBM webMethods Integration engine local storage, with file stream

• Open Writable File Stream: Write to an existing file saved on IBM webMethods Integration engine local storage, with file stream

• Read File: Read the contents of a file stored on IBM webMethods Integration engine local storage

FTP

FTP or File Transfer Protocol, is a network protocol used to transfer files among hosts over a TCP-based network or internet.

Workflow Actions

• Upload File: Upload a specific file on the FTP server

• Change Current Directory: Change the working directory from current to the specified one

• Append File: Append a specific local file to an existing file on the FTP server

• Move to Parent Directory (CDUP): Change your working directory from current directory to its parent directory

• Get Current Working Directory: Retrieve current working directory name from the FTP server

• Remove Directory: Delete the specified directory from the FTP server

• Create Directory: Create a new directory at a specified location on the FTP server

• Get List of Files and Folders: Retrieve list of files and folders from a specified directory on FTP server

• Download File: Download a specific file from FTP server

• Delete File: Delete a specific file from FTP server

• Rename File or Folder: Rename a specific file or folder from FTP server

Flow service Actions

• getFile: Retrieve a file from a remote FTP server

• listFiles: Retrieve a list of files along with other associated details such as permissions and ownership information from a specified remote directory. If no remote directory is mentioned, the file listing of the current remote directory will be retrieved.

• deleteFiles: Delete file(s) from the specified remote FTP server

• putFile: Transfer a file to the specified remote FTP server

• renameFile: Rename a specific file from the specified remote FTP server

FTP Predefined Operations

The following predefined FTP operations are available:

getFile

Retrieves a file from a remote FTP server.

Input Parameters

Output Parameters

listFiles

Returns a list of file names in a specified remote directory. If path is not specified, the operation retrieves the file listing of the current remote directory. The operation also retrieves additional details such as permissions and ownership information.

Input Parameters

Output Parameters

deleteFiles

Delete file(s) from a remote FTP server.

Input Parameters

Output Parameters

putFile

Transfers a file to a remote FTP server.

Input Parameters

Output Parameters

Usage Notes

Some FTP servers do not support “putting” a unique file. When using the putFile operation to put a unique file to an FTP server that does not support putting a unique file, you may encounter the following error:

com.wm.app.b2b.server.ServiceException: 500 'STOU': command not understood.

renameFile

Renames a file on a remote FTP server.

Input Parameters

Output Parameters

GitHub

GitHub is a website for storing your project’s files. It is a Git repository hosting service which helps you manage projects, build software along other developers, and use version control.

Triggers

• Push: Triggers when a block of code is pushed

• New or Update Pull Request: Triggers when a new pull request is created or updated in a specified repository

• Pull Request Comment: Triggers when a new comment is added for a pull request in the specified repository

• Branch or Tag Created: Triggers when a new branch or a tag is created in a specified repository

• Branch or Tag Deleted: Triggers when an existing branch or a tag is deleted from the specified repository

• Repository Added to Team: Triggers when an existing repository is added to the team in the specified organization

• Collaborator Added: Triggers when a new collaborator is created in a specified repository

• Collaborator Removed: Triggers when an existing collaborator is removed

• New Deployment: Triggers when a new deployment is initiated in the specified repository

• Deployment Status: Triggers when the status of an existing deployment is updated in the specified repository

• Commit Status: Triggers when the commit status is updated in the specified repository

• New Commit Comment: Triggers when a new comment is added for a commit in the specified repository

• New Release: Triggers when a new repository or code is released

• New Fork: Triggers when a new fork is created of the specified repository

• New Issue: Triggers when a new issue is created

• Issue Updated: Triggers when an existing issue is updated

• New Comment on Issue: Triggers when a new comment is added to an issue of a specified repository

• Update Comment on Issue: Triggers when a comment of an issue is updated

• Delete Comment on Issue: Triggers when a comment of an issue is deleted

• New or Edit Wiki Page: Triggers when a wiki page is created or edited in the specified repository

• Repository Starred: Triggers when an existing repository is star marked

• Discussion Events: Discussion Events contain number of trigger events as mentioned here:

  • Created: Triggers when a discussion is created in the specified repository

  • Edited: Triggers when a discussion is edited in the specified repository

  • Closed: Triggers when a discussion is closed in the specified repository

  • Deleted: Triggers when a discussion is deleted in the specified repository

  • Reopened: Triggers when a discussion is reopened in the specified repository

  • Pinned: Triggers when a discussion is pinned in the specified repository

  • Unpinned: Triggers when a discussion is unpinned in the specified repository

  • Locked: Triggers when a discussion is locked in the specified repository

  • Unlocked: Triggers when a discussion is unlocked in the specified repository

  • Transferred: Triggers when a discussion is transferred in the specified repository

  • Answered: Triggers when a discussion is answered in the specified repository

  • Unanswered: Triggers when a discussion is unanswered in the specified repository

  • Labeled: Triggers when a discussion is labeled in the specified repository

  • Unlabeled: Triggers when a discussion is unlabeled in the specified repository

  • Category Changed: Triggers when a category of a discussion is changed in the specified repository

• Comment on Discussion: Comment on Discussion event contains number of trigger events as mentioned here:

  • Created: Triggers when a comment is added within a discussion in the specified repository

  • Edited: Triggers when a comment is edited within a discussion in the specified repository

  • Deleted: Triggers when a comment is deleted within a discussion in the specified repository

• Workflow Jobs: Workflow Jobs event contains number of trigger events as mentioned here:

  • Completed: Triggers when workflow jobs are completed within the specified repository

  • In Progress: Triggers when workflow jobs are in progress within the specified repository

  • Queued: Triggers when workflow jobs are queued within the specified repository

  • Waiting: Triggers when workflow jobs are waiting within the specified repository

• Workflow Runs: Workflow Runs event contains number of trigger events as mentioned here:

  • Completed: Triggers when workflow runs are completed within the specified repository

  • Requested: Triggers when workflow runs are requested within the specified repository

  • In Progress: Triggers when workflow runs are in progress within the specified repository

Actions

• Create Gist: Create a new gist in your account

• Create Pull Request: Create a new pull request

• Delete Gist: Delete an existing gist

• Download File: Download a file from a specified repository

• Download Repository: Download the specified repository

• Get Branch Details: Retrieve more details about a specified branch

• Get Repositories: Retrieve the list of all repositories of your account

• Get Repository Details: Retrieve more details about a specified repository

• Get Tags: Retrieve the list of all the tags of a specified repository

• List Commits on Pull Request: Retrieve the list of commits of a pull request

• Merge Pull Request: Merge a pull request into an upstream branch

• Get Organizations: Retrieve the list of organizations of your account

• Get Authenticated User Organizations: List organizations for the authenticated user

• Get Organization Repositories: List repositories for the specified organization

• Get User Repositories: List repositories for the specified user

• Get Assignees: List the assignees for issues in a repository

• Get Labels: List all labels for a repository

• Get Milestones: List milestones for a repository

• Get Issues: List issues in a repository. Only open issues will be listed.

• Get Issue Details: List the details of the specified issue in a repository

• Comment On an Issue: Create a comment on a specific issue in a repository

• Create Issue: Create an issue in a repository

• Update Issue: Update the specified issue in a repository

• Get Account Details: Retrieve the details of your account

• Get Authenticated User Repositories: List repositories for the authenticated user

Google Apps Admin

The Google Apps Admin actions let you perform important admin related tasks, helping you organize, manage, and control business operations easily.

Actions

• Action Mobile Device: Takes an action that affects a mobile device

• Delete ASP: Delete an ASP issued by a user

• Delete Calendar: Delete a Calendar

• Delete Domain: Delete a domain of the customer

• Delete Domain Alias: Delete a domain alias of the customer

• Delete Group: Deletes a group

• Delete Group Alias: Delete a group alias

• Delete Member: Removes a member from a group

• Delete Mobile Device: Remove a mobile device

• Delete Notification: Removes a notification

• Delete Organization Unit: Remove an Organization Unit

• Delete Role: Remove a role

• Delete Role Assignment: Remove a role assignment

• Delete Schema: Remove a Schema

• Delete Token: Delete all access tokens issued by a user for an application

• Delete User: Remove an user

• Delete User Alias: Remove an user alias

• Generate Verification Codes: Generate new backup verification codes for the user

• Get ASP By ID: Get information about an ASP issued by a user

• Get Calendar By ID: Retrieve a calendar resource

• Get Customer By ID: Retrieve a customer

• Get Domain Alias By ID: Retrieve a domain alias of the customer

• Get Domain By ID: Retrieves a domain of the customer

• Get Group By ID: Retrieve a group’s properties

• Get Member By ID: Retrieve a group member’s properties

• Get Mobile Device By ID: Retrieve a mobile device’s properties

• Get Notification By ID: Retrieve a notification

• Get Organization Unit By ID: Unit By ID Retrieves an organization unit

• Get Role Assignment By ID: Retrieve a role assignment

• Get Role By ID: Retrieves a role

• Get Schema By ID: Retrieve schema

• Get Token By ID: Get information about an access token issued by a user

• Get User By ID: Retrieve an user

• Insert Calendar: Create a calendar resource

• Insert Domain: Insert a domain of the customer

• Insert Domain Alias: Insert a domain alias of the customer

• Insert Group: Create a group

• Insert Group Alias: Add an alias for the group

• Insert Member: Add a user to the specified group

• Insert Organization Unit: Add an organization unit

• Insert Role: Create a role

• Insert Role Assignment: Creates a role assignment

• Insert Schema: Create schema

• Insert User: Create a single user

• Insert User Alias: Add an alias to user

• Invalidate Verification Codes: Invalidate the current backup verification codes for the user

• List ASPs: List all application-specific password(ASP)

• List Calendars: Retrieve a list of calendar resources for an account

• List Domains: List the domains of the customer

• List Group Aliases: List all aliases for a group

• List Groups: Retrieve a paginated list of groups in a domain

• list Members: Retrieve a paginated list of all members in a group

• List Mobile Devices: Retrieve a paginated list of all mobile devices for an account

• List Notifications: Retrieve a list of notifications

• List Organization Units: Retrieve a list of all organization units for an account

• List Privileges: Retrieve a paginated list of all privileges for a customer

• List Role Assignments: Retrieve a paginated list of all roleAssignments

• List Roles: Retrieve a paginated list of all the roles in a domain

• List Schemas: Retrieve all schemas for a customer

• List Tokens: Return the set of tokens specified user has issued to 3rd party applications

• List User Aliases: List all aliases for a user

• List Users: List all users

• List Verification Codes: Return the current set of valid backup verification codes for the specified user

• Make Admin: Make a user a super administrator

• Patch Calendar: Update a Calendar with patch semantics

• Patch Customer: Updates a device’s annotatedUser, annotatedLocation, or notes properties with patch semantics

• Patch Group: Update a group’s properties with patch semantics

• Patch Member: Update the membership of a user in the specified group with patch semantics

• Patch Notification: Update a notification with patch sementics

• Patch Organization Unit: Update an organization unit with patch sementics

• Patch Role: Updates a role with patch semantics

• Patch Schema: Update schema with patch semantics

• Patch User: Update a user with patch semantics

• Undelete User: Undelete a deleted user

• Update Calendar: Modifies a Calendar

• Update Customer: Update a device’s annotatedUser, annotatedLocation, or notes properties

• Update Group: Update a group’s properties

• Update Member: Update the membership of a user in the specified group

• Update Notification: Update a notification

• Update Organization Unit: Updates an organization unit

• Update Role: Modify a role

• Update Schema: Modify schema

• Update User: Modify an user