{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":21663,"path":"integrate-applications/integration-hub/utilityact-spoke.md","title":"Utility Actions Spoke","bundle":null,"doc_type":null,"release":"australia","body":"\n# Utility Actions Spoke\n\nCreate file attachments and zip attachments in your ServiceNow instance.\n\n## Request apps on the Store\n\nVisit the [ServiceNow Store](https://store.servicenow.com/sn_appstore_store.do#!/store/home) 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](https://www.servicenow.com/docs/r/store-release-notes/sn-store-release-notes.html).\n\n## Integration Hub subscription\n\nThis spoke requires an Integration Hub subscription. For more information, see [Legal schedules - IntegrationHub overview](https://www.servicenow.com/content/dam/servicenow-assets/public/en-us/doc-type/legal/snc-addendum-integrationhub.pdf).\n\n## Spoke version\n\nUtility Actions spoke v1.4.1 is the latest version. For version history of the spoke, see [Utility Actions spoke release notes](https://www.servicenow.com/docs/r/store-release-notes/store-integrationhub-rn-utility-actions.html).\n\n## Supported versions\n\nThis spoke is compatible with ServiceNow instance of Australia and later versions.\n\n## Spoke dependencies\n\nIf you’re having trouble installing the app, ensure that these dependent plugins are installed:\n\n-   ServiceNow Flow Designer - Dynamic Inputs \\(com.glide.hub.dynamic\\_inputs\\)\n-   ServiceNow IntegrationHub Runtime \\(com.glide.hub.integration.runtime\\)\n\n**Note:** Some of these plugins are licensable features and require appropriate licenses, if used outside the spoke implementation.\n\n## Spoke actions\n\nThe Utility Actions spoke provides actions to automate tasks when events occur in your ServiceNow instance. Available actions include:\n\n<table id=\"table_u1p_kh2_hfb\"><thead><tr><th>\n\nCategory\n\n</th><th>\n\nAction\n\n</th><th>\n\nDescription\n\n</th></tr></thead><tbody><tr><td rowspan=\"7\">\n\nDefault\n\n</td><td>\n\nAdd File to Zip\n\n</td><td>\n\nAdds the file to list of files to be zipped.\n\n</td></tr><tr><td>\n\nAppend to Delimited File\n\n</td><td>\n\nCreates a file line record, corresponding to a row in the delimited file.\n\n</td></tr><tr><td>\n\nAppend to File\n\n</td><td>\n\nCreates a file line record, corresponding to a line in the file to be created.\n\n</td></tr><tr><td>\n\nBegin File\n\n</td><td>\n\nCreates a file record, to which the actual file would be attached.\n\n</td></tr><tr><td>\n\nBegin Zip\n\n</td><td>\n\nCreates a file set record, to which the zip file would be attached.\n\n</td></tr><tr><td>\n\nBuild File\n\n</td><td>\n\nGenerates the file and attaches it to the file record specified.\n\n</td></tr><tr><td>\n\nBuild Zip\n\n</td><td>\n\nGenerates 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.\n\n</td></tr><tr><td rowspan=\"4\">\n\nSpoke Util Actions\n\n</td><td>\n\nConvert Record to Object\n\n</td><td>\n\nConverts the specified record into an object.\n\n</td></tr><tr><td>\n\nConvert Record to Array of Objects\n\n</td><td>\n\nConverts 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.\n\n</td></tr><tr><td>\n\nGenerate Encoded Query\n\n</td><td>\n\nGenerates 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.\n\n</td></tr><tr><td>\n\nLook up Latest Comment on Record\n\n</td><td>\n\nRetrieves the latest comment from the required record in ServiceNow instance.The output comment is in the form of a string.\n\n</td></tr></tbody>\n</table>## Spoke module and tables\n\nThe Utility Actions spoke includes these tables:\n\n<table id=\"table_okz_1by_qlb\"><thead><tr><th>\n\nTable\n\n</th><th>\n\nDescription\n\n</th><th>\n\nFields\n\n</th></tr></thead><tbody><tr><td>\n\nFile \\[sn\\_utility\\_spoke\\_file\\]\n\n</td><td>\n\nInformation 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**.\n\n</td><td>\n\n-   File Name\n-   File Type\n-   Schema\n\n</td></tr><tr><td>\n\nFile Line \\[sn\\_utility\\_spoke\\_file\\_line\\]\n\n</td><td>\n\nInformation about each row in delimited file.\n\n</td><td>\n\n-   File\n-   Line Content\n\n</td></tr><tr><td>\n\nFile Mapping \\[sn\\_utility\\_spoke\\_file\\_mapping\\]\n\n</td><td>\n\nInformation 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.\n\n</td><td>\n\n-   File\n-   File Set\n\n</td></tr><tr><td>\n\nFile Schema \\[sn\\_utility\\_spoke\\_file\\_schema\\]\n\n</td><td>\n\nInformation regarding the delimited files.\n\n</td><td>\n\n-   Schema Name\n-   Columns\n-   Delimiter\n-   Has Header\n-   Quoted\n\n</td></tr><tr><td>\n\nFile Set \\[sn\\_utility\\_spoke\\_file\\_set\\]\n\n</td><td>\n\nInformation about the zip files. The associated ZIP file is attached to the record.\n\n</td><td>\n\nZip File Name\n\n</td></tr></tbody>\n</table>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.\n\nAuto Flush data retention policies are available for the File and File Set tables. By default, the system retains data in the spoke tables, except the File Schema table, up to 7 days.\n\n**Note:**\n\n-   Auto Flush data retention policies don't apply to records in the File Schema table.\n-   When the file records in the File table are deleted, the corresponding file line records in the File Line table are also deleted.\n-   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.\n\nTo 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](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/application-development/atf-auto-flush.md).\n\n## Connection and credential alias requirements\n\nThis spoke doesn't require configuration of connection and credential alias. For information about setting up the spoke, see [Create schema](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/create-schema.md).\n\n## MID Server requirements\n\nThese actions use REST calls that can run either on an instance or, optionally, through a MID Server. For more information, see [MID server](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/mid-server-landing.md).\n\n**Note:**\n\n-   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.\n-   [Create a MID Server property](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/servicenow-platform/r_MIDServerProperties.md) with **Value** as `*.service-now.com`.\n\nTo set up the MID Server for this spoke, see [Set up MID Server for a spoke](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/integrate-applications/integration-hub/config-adv-mid-settings-for-oauth-on-mid.md).\n\n"}}