Get support for required and optional fields in Native Apps / Actions
Introduction
It’s a systematic process of simplifying the complex data for conducting the automation by offering a pre-built automation template. Native actions are listed under the action drop-down menu, which can be invoked in the integration with a few clicks. The core benefit of Native App is it’s a time-saving and easy-to-use process.
Overview
Native apps
Native Apps are the applications that can be incorporated into any automation as per your requirements. There are plenty of apps for all the vivid domains. For example LMS, HCM, Payroll, E-Commerce, etc. Sapper always looks forward to adding more apps to make your work easy and efficient. It is a user-friendly and easy-to-use process. The native apps can be only run in a JSON request type. It’s also possible to conduct in a REST support application. Therefore, while selecting the native apps, you need to check for the REST support configuration of the applications.
Native apps can be used in 2 ways, i.e., by creating the native connection and by creating the native action.
Native Connection
With the help of the native connection, you can create a connection swiftly in a few steps unlike the traditional way of creating it. You need to visit the connection tab and click on create connection. Here, you can establish a connection by just providing the application name, connection mode connection name, description, authentication URL, and access token code.
Native Action
The native actions are pre-built actions for all the native application/apps. These actions are helpful for you to use the automation more effectively. You will be able to access various actions associated with the particular apps. You will also get the option for a custom action, it will help you to create your desired action based on the requirements. The native actions help you to get a simple and user friendly process for operating the automation appropriately.
How to use Native Apps?
Steps to use Native Connection
Click on create a connection on the right side of the screen. The following form will appear on the screen.
Select the desired application from the drop-down box of the select application field.
Select the connection mode based on your requirement. You can select the template-based connection or custom as per the requirement. The connection mode is circuit oriented. Data are transmitted in sequence over an established connection.
4. Select the connection name and fill in the description. The connection name is a unique identification name and description for the respective connection. For example, Jira connection.
5. Now, provide the authentication details, and access token URL as per the requirements. Authentication details are the information related to the process of recognizing a user's identity. It is the mechanism of associating an incoming request with a set of identifying credentials. On the other hand, an access token URL is required to ensure your platforms are safe from unauthorized access. Now click on authorize and save.
Input | Description | Examples |
|---|---|---|
Select Application | Select the desired application | Jira |
Connection Mode | Mention the mode of connection | TEMPLATE_BASED |
Connection Name | Provide a name for the connection | REST |
Connection Description | Provide a description for the connection | Example |
Authentication URL | You can use an Authentication URL to specify a REST authentication service that manages user authentication, and optionally provide additional meta data to be embedded in the token. |
|
Access Token URL | Access Token URL (Authentication URL) is required to ensure your platforms are safe from unauthorized access. |
|
6. After clicking on the authorize and save, the URL of the application will be open. For example; Slack, as shown in the below image. Now you need to select allow for providing authorization, and the application will be created for future use.
7. You can also opt for custom, by selecting it from the drop-down box.
8. After selecting the custom they need to provide the information such as connection type. A connection type means a connection that identifies whether the connected person is a generator, distributor, or direct consumer and whether the connection is to the grid, a local network, or an embedded network.
9. Now add the rest connection type. For more details visit
https://sappersoftware.atlassian.net/wiki/spaces/SD/pages/63602585
10. Add the connection name and provide a description. The connection name is the specific name of the connection.
11. Add a hostname, i.e. the domain of the provided application. It is the initial part of the URL of the landing page of the application. The hostname is a unique name or label assigned to any device that is connected to a specific computer network.
12. Provide the username and password. A username allows you to maintain your identification when you use a particular application or connection. Passwords require to protect your sensitive information. It’s can be generated with a unique combination of numerical and alphabetic characters.
13. Fill in the header field, and header prefix. The header field enables the client and server to provide additional information with the request or response. The header fields are specified in the <headers> element in the adapter request and support the HTTP standard headers in a JSON format.
14. On the other hand, a header prefix is a feature is used to ensure that a certain snippet of code is inserted at the beginning of every file. Following are the listed prefixes:
i. Basic: Basic Authentication is a method for an HTTP user agent (e.g., a web browser) to provide a username and password when the request proceeds. When employing Basic Authentication, you need to include an encoded string in the Authorization header of each request you want to make.
ii. Bearer: Bearer authentication is an HTTP authentication scheme that involves security tokens called bearer tokens. The bearer token is a cryptic string, usually generated by the server in response to a login request.
iii. Token: API tokens allow you to authenticate with cloud apps and bypass two-step verification and SSO, and retrieve data from the instance through REST APIs. Token controls allow admins to view and revoke the use of API tokens by their managed accounts.
iv. None
15. Now click on save and the native connection will be saved. You can use it as per your requirements.
Input | Key | Description | Example |
Select Application | application | Select Jira application |
|
Connection Mode | Mode | Mention the mode of connection | Custom |
Connection type | connection type | Select the type of connection. |
|
Rest Connection Type | Rest Connection Type | Select the Basic connection type |
|
Connection Name | name | Provide a name for the connection. |
|
Connection Description | description | Provide a description for the connection. |
|
Host Name | host | Provide a string value for the URL of user's Jira account. | |
Username | username | Provide a valid username for the given jira account user want to connect. | exampleUser |
Password | password | Provide a password to authenticate all requests with. Cloud users need to generate an API token for this value. | exampleSecurePassword |
Header Field | header | Provide the path of the endpoint for authentication. | Authorization |
Header Prefix | header prefix | Select the header prefix - | Basic |
Steps to use Native Actions
Click on create automation and select the Slack application. The following form will appear.
\
2. Drag and drop Slack from the task node and click on it, and the form will appear on the right side of the screen.
3. Select the connection i.e. Slack connection
4. Now, choose the action as per the scenario i.e. ‘Send message to Channel’. Actions put your app front and center in Slack. Nestled under the ellipsis menu, apps with actions show up on every Slack message in a workspace.
5. As per the selection of action, new input fields will appear in the form. Now, you need to fill in the channel name, A channel's name lets people know what it's used for. If the purpose of a channel changes at any point in time, it can be renamed.
6. Provide an appropriate message based on the requirements. A message can be a combination of text, symbols, and numerical characters.
7. Click on save to complete the action
Input | Description | Examples |
|---|---|---|
Action | When a user executes the message action associated with the app, Slack will send a POST request to the request URL provided in the app settings. | Send message to channel |
Channel Name | Provide the name of the channel. | Send message to channel |
Message | Mention a message for the action. | Sample |
Related articles
https://sappersoftware.atlassian.net/wiki/spaces/SD/pages/676986956
https://sappersoftware.atlassian.net/wiki/spaces/SD/pages/286261095