Difference between revisions of "Utilities Integration Bridge"

From Hornbill
Jump to navigation Jump to search
 
(42 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Utilities (Cloud Automation)}}
+
This document can now be found at its new location in the [https://docs.hornbill.com/ibridge-packages/welcome Hornbill Document Library].
{{breadcrumb|[[Main Page|Home]] > [[Integration]] > [[Business Process Automation & Orchestration]] > [[Hornbill iBridge]] > Utilities|Integration}}
 
{{Section|
 
==Introduction==
 
[[file:CloudAutomationUtility.mp4|800px|border|right]]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.
 
<br>
 
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.
 
<br><br>
 
'''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.
 
|
 
{{rightBox|Related Articles|
 
:* [[Hornbill iBridge]]
 
:* [[Hornbill_iBridge#Premium_Integrations|Premium Integrations]]
 
:* [[Hornbill_KeySafe|KeySafe]]
 
:* [[Integration Call]]
 
:* [[Business_Process_Designer|Business Process Designer]]
 
}}
 
}}
 
  
{{Section|
+
    [[file:hornbill-document-library.png|iBridge Package Reference|link=https://docs.hornbill.com/ibridge-packages/welcome]]
==Current Day==
+
[[Category:HDOC]]
[[file:currentdayCA.png|right|400px|border]]Retrieves the current day of the week and stores it in a variable which can be used in other Hornbill Automations or decision nodes.
 
 
 
There are no 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.
 
 
 
{{bullet1|Response Parameter|&[global["UtilitiesCurrentDay"]["day"]]}}
 
{{bullet1|Possible values|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.
 
[[file:currentdayexpression.png|center]]
 
|}}
 
{{TOP}}
 
{{Section|
 
==Date Formatter==
 
[[File:Date_Formatter_Example.PNG|400px|right|link=https://wiki.hornbill.com/images/a/a8/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 [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'''
 
{{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). }}
 
::::'''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)
 
{{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:'''
 
::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}}
 
{{Section|
 
==Get Date Difference==
 
[[file:GetDateDifference.png|right|border]]
 
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'''
 
{{bullet1|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. }}
 
{{bullet1|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}}
 
{{Section|
 
==Get Day of Week==
 
[[file:getdayofweek.png|right|border|link=https://wiki.hornbill.com/images/6/60/Getdayofweek.png]]
 
Returns the day of the week for the specified timestamp.
 
 
 
'''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}}
 
 
 
'''Response Parameter'''
 
{{bullet1|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.
 
|}}
 
{{Section|
 
==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}}
 
{{Section|
 
==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}}
 
{{Section|
 
==Password Generator==
 
:: A password generator tool to provide temporary passwords for users.
 
|}}
 
 
 
[[Category:Integration]]
 

Latest revision as of 19:52, 11 April 2024

This document can now be found at its new location in the Hornbill Document Library.

   iBridge Package Reference