Utilities

String, list and other miscellaneous utilities

PROPERTIES
Name Utilities
System ID ut
Connection String
Heartbeat Connection String
SUPPORTED NODE DEFINITIONS
Message UID Node Definition Name
01ut02 Abort
01ut07 Convert List To String
01ut06 Format Date
01ut31 Get Actual Lookup Keys For Distribution
01ut32 Get Asset Output Files Type For Distribution
01ut33 Get Directory Structure For Distribution
01ut09 Get FileList Under Directory
01ut17 Get List Item
01ut13.801 Get Preference
01ut16 Get Preferences
01ut35 Get Relative Path
01ut18 Get Setting
01ut19 Get Settings
01ut08 Get Special Operation Templates Preference
01ut15.801 Get System Preference
01ut34 Get Titles From Search Result
01ut05 List Iterator
01ut04 List size
01ut01 Sleep
01ut03 String Tokenizer
01ut20 Update Setting

* Indicates the message has been deprecated. Please use the replacement message(s) instead.

NODE DEFINITION DETAILS
Abort (01ut02)

Always returns a nack. Useful in scenarios where the intention is to force termination.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
errorMessage NO
RESPONSE MESSAGE:
Parameter Name Description / Value
Convert List To String (01ut07)

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
list NO
delimiter NO
RESPONSE MESSAGE:
Parameter Name Description / Value
strResult
Format Date (01ut06)

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
dateLong NO
RESPONSE MESSAGE:
Parameter Name Description / Value
dateFormatted Format: "yyyy-MM-dd HH:mm:ss"
Get Actual Lookup Keys For Distribution (01ut31)

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
lookupKeyType NO
siteLookupKeys NO
configuredLookupKeys NO
RESPONSE MESSAGE:
Parameter Name Description / Value
actualLookupKeys
isMetadataIncluded
Get Asset Output Files Type For Distribution (01ut32)

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
distConfigFile NO
step NO
platform NO
transcodeProfile NO
RESPONSE MESSAGE:
Parameter Name Description / Value
outputType
Get Directory Structure For Distribution (01ut33)

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
distConfigFile NO
step NO
lookupKeyType NO
lookupKey NO
siteLookupKeys NO
RESPONSE MESSAGE:
Parameter Name Description / Value
dirStructure
Get FileList Under Directory (01ut09)

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
directory NO
filter NO
RESPONSE MESSAGE:
Parameter Name Description / Value
fileList
Get List Item (01ut17)

Get specific item from the list using the index. This call is similar to List Iterator except that it also returns the specified index.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
index NO The index of the element in the list that should be returned
list NO The list
RESPONSE MESSAGE:
Parameter Name Description / Value
element The current element in the list at the specified index
hasNext Indicates whether the list traversal has reached the last element or not
next Index of the next element. Use this returned value to get the next element by overwriting the index variable used in the template with this value.
originalIndex Original index passed as input.
Get Preference (01ut13.801)

Gets the preference of a user using the specified key. Default preference location is in install_dir/workflow/preferences.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
user NO The user
key NO Preference name
RESPONSE MESSAGE:
Parameter Name Description / Value
value Value of the preference
Get Preferences (01ut16)

Get preference values for list of keys. Supported upto 10 keys.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
user NO
key1 NO
key2 NO
key3 NO
key4 NO
key5 NO
key6 NO
key7 NO
key8 NO
key9 NO
key10 NO
RESPONSE MESSAGE:
Parameter Name Description / Value
value1
value2
value3
value4
value5
value6
value7
value8
value9
value10
Get Relative Path (01ut35)

relativePath is the relative path to access destPath from currentPath pre-requisite: current path and destination path shared the same parent folder.eg /p /p/currentPath --> /p/destPath. if currentPath=a/b/c, destPath=a/c/d. relativePath=../../c/d

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
currentPath NO
destPath NO
RESPONSE MESSAGE:
Parameter Name Description / Value
relativePath
Get Setting (01ut18)

Retrieves a setting from the configuration service

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
path NO The unique string used to define the path for a settings group
name NO The name of the setting in the group specified by the path parameter to retrieve
RESPONSE MESSAGE:
Parameter Name Description / Value
value The value of the requested setting
Get Settings (01ut19)

Retrieves all the settings for a given settings group

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
path NO The unique string used to define the path for a settings group
RESPONSE MESSAGE:
Parameter Name Description / Value
values A list containing the settings values for the component
names A list containing the names of the settings for the component
Get Special Operation Templates Preference (01ut08)

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
type NO
RESPONSE MESSAGE:
Parameter Name Description / Value
specialTemplatesToRun
Get System Preference (01ut15.801)

Gets a system preference using the specified key. Default preference location is in install_dir/workflow/preferences.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
key NO Preference key
RESPONSE MESSAGE:
Parameter Name Description / Value
value Value of the preference
Get Titles From Search Result (01ut34)

Get a list a title from the search result. The search result is saved to an file.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
filepath NO The file path contains the search result
RESPONSE MESSAGE:
Parameter Name Description / Value
ids a list of title ids
List Iterator (01ut05)

Returns the element at the specified index and the value of the next index. Can be used to iterate over a list. Workaround for missing Studio feature. This call is similar to Get List Item, except it doesn't return the specified index.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
index NO The index of the element in the list that should be returned
list NO The list
RESPONSE MESSAGE:
Parameter Name Description / Value
element The current element in the list at the specified index
hasNext Indicates whether the list traversal has reached the last element or not
next Index of the next element. Use this returned value to get the next element by overwriting the index variable used in the template with this value.
List size (01ut04)

Gets the size of a list. Workaround for missing Studio feature.

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
list NO The list
RESPONSE MESSAGE:
Parameter Name Description / Value
size Count of items in the list
Sleep (01ut01)

Sleeps for a specified interval. Default is 5 seconds void sleep(int delay)

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
RESPONSE MESSAGE:
Parameter Name Description / Value
String Tokenizer (01ut03)

Tokenizes a string array (comma-delimited) and returns a list of tokens

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
string NO The string "array" (just a comma-delimited string)
RESPONSE MESSAGE:
Parameter Name Description / Value
list Returns a list of tokens
Update Setting (01ut20)

Updates a setting in the configuration service. note: updates are low priority for sprint 12. Review prior to implementing

REQUEST MESSAGE:
Parameter Name Blank Value Allowed? Description / Value
settingspath NO The unique string used to the path for the settings group containing the setting
name NO The name of the setting to update
value NO The new value of the setting
RESPONSE MESSAGE:
Parameter Name Description / Value
© 2002 - 2017 Ericsson Television Inc.
All Rights Reserved.