Utility Actions Spoke
Summarize
Summary of Utility Actions Spoke
The Utility Actions spoke enables ServiceNow customers to automate file-related tasks within their instance, such as creating file attachments and zipping multiple files together. It is designed to streamline handling of files and zipped file sets through prebuilt actions available in Integration Hub, enhancing automation capabilities starting from the Zurich release version.
Show less
Key Features
- File Creation and Manipulation: Actions to begin files, append lines or rows, build and attach files to records, and manage delimited files.
- Zip File Management: Actions to start zip file sets, add files to zips, and build the final zip file with attachments.
- Record Conversion: Convert records to objects or arrays of objects for flexible data handling within flows.
- Encoded Query Generation: Create encoded queries dynamically to be used in other actions, improving filter and search automation.
- Comment Retrieval: Retrieve the latest comment from any record as a string, useful for notifications or auditing.
- No Connection or Credential Alias Needed: Simplifies setup, as the spoke does not require these configurations.
Compatibility and Dependencies
- Requires Integration Hub subscription.
- Compatible with ServiceNow Zurich release and later.
- Depends on plugins including Flow Designer - Dynamic Inputs and IntegrationHub Runtime; some require licensing.
- The Build Zip action specifically requires at least one MID Server with the IntegrationHub Utilities capability.
Tables and Data Management
The spoke introduces specific tables to manage files, their lines, schemas, mappings, and zip file sets. It supports automatic data retention policies (Auto Flush) for cleanup, retaining data for 7 days by default except for schema information. Deletion of main file or file set records cascades to related line or mapping records, ensuring data integrity.
MID Server Requirements and Setup
- Some actions use REST calls that can run on the instance or optionally through a MID Server.
- Building zip files mandates a MID Server with IntegrationHub Utilities or ALL capability.
- Setup requires specific roles (snutilityspoke.utilityactionsadmin) and configuration, including setting a MID Server property to .service-now.com.
Practical Benefits for ServiceNow Customers
- Automate complex file operations without custom scripting.
- Integrate file and zip file management seamlessly into workflows and integrations.
- Leverage out-of-the-box actions to improve efficiency and reduce errors in file handling.
- Use encoded queries and record conversions to enhance data-driven automation.
- Ensure compliance and data hygiene through built-in retention policies.
Create file attachments and zip attachments in your ServiceNow instance.
Request apps on the Store
Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Integration Hub subscription
This spoke requires an Integration Hub subscription. For more information, see Legal schedules - IntegrationHub overview.
Spoke version
Utility Actions spoke v1.4.0 is the latest version.
Supported versions
This spoke is compatible with ServiceNow instance of Zurich and later versions.
Spoke dependencies
- ServiceNow Flow Designer - Dynamic Inputs (com.glide.hub.dynamic_inputs)
- ServiceNow IntegrationHub Runtime (com.glide.hub.integration.runtime)
Spoke actions
The Utility Actions spoke provides actions to automate tasks when events occur in your ServiceNow instance. Available actions include:
| Category | Action | Description |
|---|---|---|
| Default | Add File to Zip | Adds the file to list of files to be zipped. |
| Append to Delimited File | Creates a file line record, corresponding to a row in the delimited file. | |
| Append to File | Creates a file line record, corresponding to a line in the file to be created. | |
| Begin File | Creates a file record, to which the actual file would be attached. | |
| Begin Zip | Creates a file set record, to which the zip file would be attached. | |
| Build File | Generates the file and attaches it to the file record specified. | |
| Build Zip | Generates the zip file and attaches it to the file set record specified. Note: This
action requires at least one MID Server with the IntegrationHub Utilities
capability. |
|
| Spoke Util Actions | Convert Record to Object | Converts the specified record into an object. |
| Convert Record to Array of Objects | Converts the given list of records to an array of objects. Note: Flow designers must
have read access to the sys_dictionary and sys_db_object tables to use this action as the
table schema is being populated from these tables. |
|
| Generate Encoded Query | Generates encoded query with the provided name and value pairs. The output encoded query can be used with any field that is of the type, dynamic template. For example, the encoded query output of the Generated Encoded Query action, can be given as an input for Additional Fields in the Create Issue action. |
|
| Look up Latest Comment on Record | Retrieves the latest comment from the required record in ServiceNow instance. The output comment is in the form of a string. |
Spoke module and tables
| Table | Description | Fields |
|---|---|---|
| File [sn_utility_spoke_file] | Information about every file that has been created. The associated file is attached
to the record. Note: You must specify Schema if you specify
Delimited File for File
Type. |
|
| File Line [sn_utility_spoke_file_line] | Information about each row in delimited file. |
|
| File Mapping [sn_utility_spoke_file_mapping] | Information about files mapped to a ZIP file. For example, if four files are zipped to a ZIP file, four records are created in this table for each file. |
|
| File Schema [sn_utility_spoke_file_schema] | Information regarding the delimited files. |
|
| File Set [sn_utility_spoke_file_set] | Information about the zip files. The associated ZIP file is attached to the record. | Zip File Name |
The Utility Actions spoke adds the IntegrationHub Utilities application to your instance and includes the File Schemas module. The module displays records from the File Schema table.
- Auto Flush data retention policies don't apply to records in the File Schema table.
- When the file records in the File table are deleted, the corresponding file line records in the File Line table are also deleted.
- When the file set records in the File Set table are deleted, the corresponding file mapping records in the File Mapping table are also deleted.
To modify the data retention policy, change the value of Age in seconds in the Auto Flush form of the required table. For more information, see Autoflush form.
Connection and credential alias requirements
This spoke doesn't require configuration of connection and credential alias. For information about setting up the spoke, see Create schema.
MID Server requirements
These actions use REST calls that can run either on an instance or, optionally, through a MID Server. For more information, see MID server.
- The Build Zip action in the spoke requires at least one MID Server with the capability IntegrationHub Utilities or ALL. To set up and configure the MID Server, user must have the role sn_utility_spoke.utility_actions_admin role.
- Create a MID Server property with Value as *.service-now.com.
To set up the MID Server for this spoke, see Set up MID Server for a spoke.