Difference between revisions of "Utilities Integration Bridge"

From Hornbill
Jump to navigation Jump to search
Line 33: Line 33:
 
{{bullet1|Current Day|Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday}}
 
{{bullet1|Current Day|Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday}}
 
   
 
   
===Example Use:===
+
===Example Use===
  
 
::Prior to a Service Manager Request Assignment node, you may want to check the current day of the week.  If it is a Saturday or Sunday you could take the decision to assign to a team that covers weekends.
 
::Prior to a Service Manager Request Assignment node, you may want to check the current day of the week.  If it is a Saturday or Sunday you could take the decision to assign to a team that covers weekends.
Line 44: Line 44:
 
Lets you take the format of one date and convert it to another format.  This is then stored in a variable which can be used in other Hornbill Automations. See [https://www.php.net/manual/en/datetime.format.php '''Date Format Characters'''] to get a list of characters that can be used when defining your input and output formats.
 
Lets you take the format of one date and convert it to another format.  This is then stored in a variable which can be used in other Hornbill Automations. See [https://www.php.net/manual/en/datetime.format.php '''Date Format Characters'''] to get a list of characters that can be used when defining your input and output formats.
  
'''Request Parameters'''
+
===Request Parameters===
 
{{bullet1|Date|Most commonly, the variable picker will be used to get a date/time that is stored in a date/time field within Hornbill or it has been collected using Intelligent Capture.}}
 
{{bullet1|Date|Most commonly, the variable picker will be used to get a date/time that is stored in a date/time field within Hornbill or it has been collected using Intelligent Capture.}}
 
{{bullet1|Input Format|Hornbill stores Date and Time in UTC format.  This can be represented using '''Y-m-d H:i:s''' (2022-11-16 18:11:00). }}
 
{{bullet1|Input Format|Hornbill stores Date and Time in UTC format.  This can be represented using '''Y-m-d H:i:s''' (2022-11-16 18:11:00). }}
Line 55: Line 55:
 
{{Bullet1|Output Format|Provide a format that you would like to convert the Date to using [https://www.php.net/manual/en/datetime.format.php '''Date Format Characters'''].}}
 
{{Bullet1|Output Format|Provide a format that you would like to convert the Date to using [https://www.php.net/manual/en/datetime.format.php '''Date Format Characters'''].}}
 
|}}
 
|}}
'''Example Use:'''
+
 
 +
===Response Parameters===
 +
{{bullet1|Date|Contains the date/time based on the new format that was defined in the Output Format}}
 +
 
 +
===Example Use===
 
::If you are getting a date from an external integration, the date format may be stored differently in that external app and you'll need to convert it to a format used in Hornbill.
 
::If you are getting a date from an external integration, the date format may be stored differently in that external app and you'll need to convert it to a format used in Hornbill.
 
::If you only require the date and not the time you would convert the date/time to ''Y-m-d''
 
::If you only require the date and not the time you would convert the date/time to ''Y-m-d''
Line 76: Line 80:
 
Returns the day of the week for the specified timestamp.
 
Returns the day of the week for the specified timestamp.
  
'''Request Parameter'''
+
===Request Parameter===
 
{{bullet1|Timestamp|Enter a UTC Timestamp by either entering the year, month, date, hours (24 hour), minutes, and seconds.  Or use the variable picker to select a stored date in UTC format}}
 
{{bullet1|Timestamp|Enter a UTC Timestamp by either entering the year, month, date, hours (24 hour), minutes, and seconds.  Or use the variable picker to select a stored date in UTC format}}
  
'''Response Parameter'''
+
===Response Parameter===
 
{{bullet1|Day|Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday}}
 
{{bullet1|Day|Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday}}
  
'''Example Use:'''
+
===Example Use===
 
::On a Service Manager Request you may want to check to see what day of the week it was raised on.
 
::On a Service Manager Request you may want to check to see what day of the week it was raised on.
 
|}}
 
|}}

Revision as of 03:53, 17 November 2022

Home > Integration > Business Process Automation & Orchestration > Hornbill iBridge > Utilities Index

Introduction

A Utility for date format conversions and a password generator have been provided as part of the Cloud Automations that can be used within a BMP or AutoTask workflow.


Within the workflow designer, when adding a new node, select the option for Cloud Automation. No authentication or licensing is required to access and use these utilities.

Adding a Utility to a Workflow

  • Add a Cloud Automation node to your workflow
  • Access the properties of that node
  • On the Method field, select edit button to view the available integrations
  • Find Utilities within the list
  • Expand and select the automation that you wish to use.

Current Day

CurrentdayCA.png
Retrieves the current day of the week and stores it in a variable which can be used in other Hornbill Automations or decision nodes.

Request Paramaters

There are no request parameters to configure with the node. Simply added where needed and then use the Output Parameter with decision nodes or to update a record with the day.

Response Paramaters

  • Current Day
Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday

Example Use

Prior to a Service Manager Request Assignment node, you may want to check the current day of the week. If it is a Saturday or Sunday you could take the decision to assign to a team that covers weekends.
Currentdayexpression.png

(Top of Page)

Date Formatter

Date Formatter Example.PNG

Lets you take the format of one date and convert it to another format. This is then stored in a variable which can be used in other Hornbill Automations. See Date Format Characters to get a list of characters that can be used when defining your input and output formats.

Request Parameters

  • Date
Most commonly, the variable picker will be used to get a date/time that is stored in a date/time field within Hornbill or it has been collected using Intelligent Capture.
  • Input Format
Hornbill stores Date and Time in UTC format. This can be represented using Y-m-d H:i:s (2022-11-16 18:11:00).
Y - A full numeric representation of a year, at least 4 digits (1999,2003, 2022)
m - Numeric representation of a month, with leading zeros (01 through 12)
d - Day of the month, 2 digits with leading zeros (01 to 31)
H - 24-hour format of an hour with leading zeros (00 through 23)
i - Minutes with leading zeros (00 to 59)
s - Seconds with leading zeros (00 through 59)
  • Output Format
Provide a format that you would like to convert the Date to using Date Format Characters.

Response Parameters

  • Date
Contains the date/time based on the new format that was defined in the Output Format

Example Use

If you are getting a date from an external integration, the date format may be stored differently in that external app and you'll need to convert it to a format used in Hornbill.
If you only require the date and not the time you would convert the date/time to Y-m-d

(Top of Page)

Get Date Difference

GetDateDifference.png

Returns the difference between two date/time stamps, in days, hours, minutes and seconds. In addition to this, it also provides a yes/no outcome for when the second time stamp is before the first time stamp.

Request Parameters

  • First DateTime
Type in the year, month, date, hours (24 hour), minutes, seconds to provide the first Date/Time. Or use the variable picker to select a date that is stored in Hornbill.
  • Second DateTime
Type in the year, month, date, hours (24 hour), minutes, seconds to provide the second Date/Time. Or use the variable picker to select a date that is stored in Hornbill.

This automations assumes that UTC date/time format is being used. If you have dates from an external app through integrations that are not UTC format, you can use the Date Formatter to convert them to UTC.

(Top of Page)

Get Day of Week

Getdayofweek.png

Returns the day of the week for the specified timestamp.

Request Parameter

  • Timestamp
Enter a UTC Timestamp by either entering the year, month, date, hours (24 hour), minutes, and seconds. Or use the variable picker to select a stored date in UTC format

Response Parameter

  • Day
Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, and Sunday

Example Use

On a Service Manager Request you may want to check to see what day of the week it was raised on.

Get Next Date

Lets you set a day of the week and the operation will return the date that this day falls on. This is stored in a variable which can then be used in other BPM Operation

(Top of Page)

Get Timestamp

Lets you return a timestamp which is x days, hours, minutes before or after an existing timestamp. This is useful for generating a future date / time to use in other business process operations.

(Top of Page)

Password Generator

A password generator tool to provide temporary passwords for users.