Utility

Utility

Utility

Advanced REST Client

Description


Advanced REST Client is a step in the Utilty Plugin for Process Studio Workflows. The REST Client workflow step enables you to consume RESTful services by making REST calls.  It is an extension of the step ‘REST Client’ with more features as follows:

  1. Authenticated Proxy Support
  2. Option to ignore SSL certificate validation
  3. Request Timeout
  4. Form-data request body along with file upload by providing file path
  5. Ability to read HTTP Response headers
  6. Ability to test REST API


Configurations


HTTP Request: 

No.

Field Name

Description

1

Step name

Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow.

2

HTTP Method Dropdown

Choose how the step interacts with a resource--- HTTP Method options are either GET, PUT, DELETE, POST, HEAD, OPTIONS (Read Only) or PATCH.

3

HTTP URL

Specify the path to a REST client resource (HTTP URL).

4

Get URL from field? 

Enable checkbox to accept path to a resource (HTTP URL) from a field. When checked the field next to it is enabled.

5

Field Selection

Select the field which defines the path to a resource (HTTP URL). This field is enabled when Get URL from field? Is checked. 



Settings Tab: Enter basic connection information for accessing a resource.

No.

Field Name

Description


General:


1

Request timeout in seconds

The time to establish the connection with the remote host.


SSL Configuration:

Provide authentication details for accessing a resource that requires SSL certificate authentication.

1

Ignore SSL certificate verification

Enable this checkbox to ignore SSL certificate verification while making HTTPS connection. 

(This strategy entirely ignores certificate checking which makes it insecure and only to be used where it makes sence!!)

2

Trust store file

Specify trust store file path in case of HTTPS connection.

3

Browse

Click Browse button to select trust store file from local machine.

4

Trust store password

Specify trust store password in case of HTTPS connection


Proxy Configuration:


1

Use System Proxy

Enable checkbox to allow REST client to use the Process Studio's default proxy configurations. In case of AE agent, it will use agent's proxy configurations.

2

Proxy Type

Select Proxy server type (HTTP/HTTPS)

3

Proxy Host

Specify the name/IP of a proxy host, if proxy authentication is required

4

Proxy Port

Specify the port number of a proxy host, if proxy authentication is required

5

Proxy Username

In case of authenticated proxy server, provide username

6

Proxy Password

In case of authenticated proxy server, provide password


Parameters Tab: This tab contains table with three columns to provide request (URL) parameters

No.

Field Name

Description

1

Parameter Key

Specify the Request parameter keys to set value.

2

Parameter Value

Specify the Request parameter keys values.

3

Description

Specify a description for the parameter.


Authorization Tab: Enter authorization details for a resource in the Authorization tab.

No.

Field Name

Description


HTTP Authorization:


1

Type

Select Request Authentication (No Authentication, Basic Authentication) 

2

Username

In case of Basic Authentication provide username

3

Password

In case of Basic Authentication provide password



Headers(0) Tab: This tab contains table with four columns to provide request headers

No.

Field Name

Description

1

Header Key

Specify request header key

2

Header Value

Specify request header value

3

Header Value Field

Define the content of any HTTP headers using an existing field. Populate the list of fields by clicking the Get fields button.

4

Description

Specify a description for header


Request Body Tab:  Request Body tab has a group of radio buttons as follows:

No.

Field Name

Description


Request Body:


1

 none

In case where request does not have a request body

2

 raw

Specify raw Request Body as Text, HTML, XML, JSON or XML. 

You could insert fields in the raw body from the navigator by double clicking the field. Else, use template support in request body to substitute fields and environment variables/parameters in appropriate placeholders (?{fieldname}, ${environment variable}).

3

 form-data

Enter Request body in tabular format in a form. Use form-data to send non-ASCII text or large binary data.

4

  • x-www-form-urlencoded

Enter Request body in tabular format in a form. Use x-www-form-urlencoded to send simple text/ASCII data.

5

  • read from file

In case where request body to be read from a file

6

  • read from field

In case where request body text to be read from a field


Form-data: This tab contains table with five columns:

No.

Field Name

Description

1

Key Type

Select form-data parameter key type (Text/File) from the dropdown list.

2

Key

Specify form-data parameter key.

3

Value

Specify form-data parameter value.

4

Value Field

Select a field containing form-data parameter.

5

Description

Specify a description for form-data parameter String.


x-www-form-urlencoded: This tab contains table with three columns:

No.

Field Name

Description

1

Key

Specify a parameter key. 

2

Value

Specify a parameter value.

3

Description

Specify a description for parameter. 


Read from file: This tab contains table with five columns:

No.

Field Name

Description

1

Content type for request body

Select content-type for request body dropdown.

2

File Path

Specify request body file path. 

3

View Request Body Contents

Click this button to view request body file contents 

Read from field: This tab contains table with five columns:

No.

Field Name

Description

1

Content type for request body

Select content-type for request body from dropdown

2

Field name

Specify request body raw text to be read from a field.



HTTP Response Tab: This tab has Output fields.

No.

Field Name

Description

1

Response Status

Specify the output field to hold the HTTP Response status (e.g 200 OK). The default field name is ArcRespStatus.

2

Response Time (milliseconds)

Specify the output field to hold the HTTP Response time in milliseconds. The default field name is ArcRespTime.

3

Response Headers (JSON)

Specify the output field to hold the HTTP Response headers in the JSON format. The default field name is ArcResponseHeaders.

4

Response Cookies (JSON)

Specify field name to set HTTP Response Cookies in JSON format. The default field name is ArcRespCookies.

5

Response Body

Specify the output field to hold the HTTP Response body text if any. The default field name is ArcRespBody.

6

Output File

Specify the output field to hold the file path for file received in the HTTP Response. The default field name is ArcRespOutputFile.

7

Add File to Result

Check this option to add HTTP Response output file to workflow result



Capture Screenshot

Description

Capture Screenshot is a step in the Utility Plugin for Process Studio Workflows. The Plugin is used to capture partial or full Screenshot of the current screen in the processing machine.

Limitations:

The screen resolution of the processing machine (agent machine) must be same as the screen resolution of the machine on which the workflow is designed.


Configurations 


No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow. This field is mandatory.


Input Tab:

No.

Field Name

Description


Input Fields:


2

Screenshot Type

Holds the default value i.e. Full Screen. Screenshot Type i.e. Full Screen or Partial Screen. This field is mandatory.

3

X coordinate

Minimum allowed value is 0. Maximum allowed value depends on the screen resolution of processing machine.

X co-ordinate field value should be positive.

4

Y coordinate

Minimum allowed value is 0. Maximum allowed value depends on the screen resolution of processing machine.

Y co-ordinate field value should be positive.

5

Width

Width value for the screenshot. Width field value should be positive.

6

Height

Height value for the screenshot. Height field value should be positive.

7

File Name

Name of the image file without that will be created. This field is mandatory.

8

File Extension

Holds the extension of the image file that will be created. Currently only bmp, png, jpg and jpeg file are supported by this plugin. This field is mandatory.

9

File Path

Holds the absolute path of the file where the image will be saved. This field is mandatory.

10

Button: Browse

On click of this button a dialog box opens and helps to select the file path. This field is mandatory.

11

Add File To Result

Output field to hold the result of the step execution.

Note: MousePos.exe is a useful utility to locate coordinates of the current cursor position on a screen

Output Tab:

No.

Field Name

Description


Output Fields:


1

Result

Output field to hold the result of the step execution. This field is mandatory. 

Refer Appendix 1: Error Handling in IT Plugins

Note: If the capture screenshot step is part of a workflow also containing Start Browser step, then it is advisable that no browser instance is kept open on agent machine, before executing such a workflow.



Delay row

Description

Delay row is a step in the Utility Plugin for Process Studio WorkflowsDelay row is the delay timeout or wait period for each input row before it is passed to the next step. Use this step to force delay for rows.


Configurations

No.

Field Name

Description

1

Step name

Specify the name of the step. This name has to be unique in a single workflow

2

Timeout

Specify  the timeout value in seconds, minutes or hours




Execute a Process

Description

Execute a Process is a step in the Utility Plugin for Process Studio WorkflowsExecute a process step executes a shell script on the host where the workflow runs. The step is similar to the process entryShell, the difference being this step is executed in a workflow for every row.

Configurations

No.

Option

Description

1

Step name

Specify the name of the step; this name has to be unique in a single workflow

2

Process field

Specify the field name in the data stream that defines the process to start (shell script /batch file to start on linux and windows OS respectively). Arguments can also be used. 

3

Fail if not success

Checking this option means if the exit status is different than zero the step fails. You can use error handling to get these rows.

4

Output line delimiter 

Without defining a line delimiter, all returned lines are collapsed into a single string with no line delimiters. Specify Output line Delimiter field to contain the line separator character used to separate lines in the output. You can set to any line delimiter and special characters can be set with the format $[value], e.g. $[0D] for CR or $[0D,0A] for CR/LF 

5

Result fieldname 

Specify the result fieldname (STRING) 

6

Error fieldname

Specify the error fieldname (STRING) 

7

Exit value

Specify the exit fieldname (INTEGER) 



Generate Hash

Description

Generate Hash-value is a step in the Utility Plugin for Process Studio Workflows. This Plugin generates Hash-value of any file selected.

Configurations                                                                                

No.

Field Name

Description   

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

File(String)

Holds the absolute path along with the name of the file. File field cannot be empty.

3

Button: Browse File

Click on this button to select a particular file.

4

Hash Type(String)*

Select the type of encryption for generating Hash-value. Encryption Algorithm field cannot be empty. This field is mandatory. Currently following are the hash types implemented with this plugin. (MD5, SHA1, SHA-256,SHA-384,SHA-512)

Note: Some Hash Algorithms must be installed on your machine. 

One such example is to download hash algorithms from http://implbits.com/products/hashtab/.  



Output Tab:

No.

Field Name

Description


Output Fields:


1

Result

Displays the generated Hash-value of the file selected if executed successfully.

Note: You may cross verify the Hash-value generated. Right click the file you chose for hashing and under properties tab select the hashing algorithm. Copy the hash value shown. After copying the hash value is available in a field below. Compare this hash value with the hash value generated in process studio. These two should be the same.

Refer Appendix 1: Error Handling in IT Plugins



Generate Password 

Description

Generate Password is a step in the Utility Plugin for Process Studio WorkflowsThis plugin can generate a random password based on the input criteria provided by the user.  The requirement may be to create a random password for applications/systems, OTP-One time password etc. The step generates a random password with a provision to set maximum and minimum length of the password, a number of capital case letters, small case letters, special characters and digits.


Configurations

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Maximum length

The maximum length of the password. An integer value should be provided. 

3

Minimum length

The minimum length of the password. An integer value should be provided.

4

Minimum number of capital case letters

The minimum number of capital case letters to be present in the password. An integer value should be provided. 

5

Minimum number of small case letters

The minimum number of small case letters to be present in the password. An integer value should be provided. 

6

Minimum number of digits

The minimum number of digits to be present in the password. An integer value should be provided.  

7

Minimum number of special characters

The minimum number of special characters to be present in the password. An integer value should be provided. 

Note: Addition of criteria field values (minimum number of capital letters, the minimum number of small case letter, the minimum number of special character, the minimum number of digits) should be less than the value in the field Minimum Password length. Validation for mandatory integer field values is also implemented for all the fields from 2 to7 above. 


Output Tab:

No.

Field Name

Description

1

Result

This field contains the final password generated randomly.

Refer Appendix 1: Error Handling in IT Plugins


If field value is null

Description

If field value is null, is a step in the Utility Plugin for Process Studio WorkflowsThe step ‘If field value is null’ is used to replace nulls by a given value for,

  1. Rows with all fields
  2. Rows but only for specific field types (Number, String, Date etc.)
  3. Rows but only for specific fields by name

Note: Changing a numeric field type to an empty string field type can cause an error in the subsequent steps. The error appears only when the next step accesses that field.


Configurations

Select & Alter Tab: 

No.

Field Name

Description

1

Step name

Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow.


Replace null for all fields:


1

Replace by value

Specify the value for all null fields 

2

Set empty string?

Enable checkbox to insert empty string otherwise it inserts null string.

3

Mask(Date)

Choose a Date Format from the dropdown list.

4

Select fields

Enable checkbox to select fields to be replaced for null values

5

Select value type

Enable checkbox to select value types for replacing null values


Value Types: 

This is enabled when Select value type is enabled

1

Type

Choose the data type

2

Replace by value

Put the value for all null fields by data type

3

Conversion mask(Date)

Date Format

4

Set empty string?

Select Y to Set empty string or N to Set value to null


Fields:

This is enabled when Set empty string? above is enabled

1

Field

Select the fields whose null values have to be replaced.

2

Replace by value

Specify the value for all null fields by field

3

Conversion mask(Date)

Choose the date Format

4

Set empty string?

Select Y to Set empty string or N to Set value to null





      Links to better reach 

            Bot Store

             EPD