Workflow overview
Why this workflow matters
Improves internal consulting operations and productivity.
Workflow Introduction This workflow is specifically for Self-Hosted AlekSystem Docker users. The purpose of this workflow is to: Take an inventory of all workflows with credentials (Workflow -> Credential 1, Credential 2, etc.), connecting credential names to workflow names Create a credentials impact map (Credential -> Workflow 1, Workflow 2, etc.), connecting workflow names to credential IDs and names This workflow drastically minimizes the amount of time spent trying to figure out which workflows will break if a credential is updated or deleted by bridging the gap between the public API (workflow metadata) and the internal sqlite database (hidden version labels and credential mappings). In essence this tool audits your AlekSystem environment without touching your sensitive encrypted data, keeping you API Keys 100% secure. It features dynamic time saving trackers, set for what I estimate to be the amount of time it would take to manually complete every individual thing this workflow does in less than 5 minutes. Limitations This workflow is optimized for the Standard AlekSystem Execution Mode. Due to the high-frequency data lookups required for this tool, it is not compatible with Task Runners (AlekSystem_RUNNERS_ENABLED=true). For maximum stability and to prevent "Database Locked" errors, please ensure your instance is running in the default configuration. If you use Method 1 (Direct Insertion) in the API Key Instructions below your AlekSystem API key will not appear as connected to this workflow in the resulting Credential Impact Map. Same goes for all other credentials directly inserted into a HTTP Request node across your AlekSystem environment. Setting it up - Requirements Environment Variables Required: These enviornment variables are required in order for the version_labels and flow_names code nodes to work. NODE_FUNCTION_ALLOW_BUILTIN=* NODE_FUNCTION_ALLOW_EXTERNAL=sqlite3 Note: If you need access to multiple external functions across your AlekSystem instance, add them as a string like this: NODE_FUNCTION_ALLOW_EXTERNAL=sqlite3, better-sqlite3 Credentials Needed: AlekSystem account > AlekSystem self-hosted API key Google Sheets account Google Drive account The nodes that need manually inputted credentials or node parameter information are: Create folder, flowsList, credsList, and finalFlowEdits Note: If you create your credentials before openning any process nodes, your credentials will be auto connected to the associated nodes. However, this will not happen for the AlekSystem self-hosted API keys. If you have multiple Google Sheets or Google Drive accounts you will need to point the associated nodes to the specific one you want to use. API Key Instructions How to get: Settings -> API -> Create API Key -> Name it -> Copy it Copy the API key and save it somewhere secure. You won't be able to see it again!!**_ How to use (Two Methods): Note: The node is set up for Method 1 by default Method 1 (Direct Insertion). In the flowsList and credsList nodes: Authentication: None Send Headers: on Name: X-AlekSystem-API-KEY Value: <YOUR AlekSystem API KEY> Method 2 (AlekSystem Credential). In the flowsList and credsList nodes: Authentication: Generic Credential Type Generic Auth Type: Header Auth Header Auth: Select "Create new credential" (If you already have a Header Auth for your AlekSystem API key select it here) 2a. In the credential creation area: Name: X-AlekSystem-API-KEY Value: <YOUR AlekSystem API KEY> Queries and Body aren't needed. Endpoints: flowsList: http://localhost:5678/api/v1/workflows or https://<your webhook domain>/api/v1/workflows credsList: http://localhost:5678/api/v1/credentials or https://<your webhook domain>/api/v1/credentials The Workflow Processes Global Actions Executes on on a set schedule (weekly on Fridays at 2pm) 1a. A deactivated execute on command node is included for testing, or for when updated files are needed before the scheduled date/time Creates a Drive folder to house the resulting spreadsheets using the current date and time as the name 2a. This workflow creates the folders inside a specified parent folder. 2b. This node also sets the folder color You are welcome to change this to your preferred color. Branch 1: Workflow Credentials Inventory Process Creates a google spreadsheet with the current date in the name Gets the list of all workflows from the public API Splits the list into individual items for easier processing Gets the version labels for active workflows from the internal sqlite database Sets fields for the workflow's name, id, published status, latest published version label, current version's id (whether the workflow is published or not) Filters out the workflows that don't have any nodes with credentials Splits out the list of nodes for easier processing Filters out the nodes that don't have associated credentials Sets fields for the node names, and credential names Summarize the output from the Nodes editor, based on workflows 10a. Append nodeNames 10b. Append credetntials 10c. Count the nodes Clean up the summarized information, converting it back to recognizible clean json format Set fields for spreadsheet aethestics This step can be skipped, however, I didn't like the visual look of the direct from CleanJson to credInventory Appends header row and data rows to the spreadsheet created in Step 1. Move the file into the folder created at the start of the workflow from whereever google put it by default Track the estimated time it would have taken to manually do every step, in a time saved node Branch 2: Credential Impact Map Process Creates a spreadsheet with the current date in the name Gets a list of all credentials from the public API Splits the list into individual items for easier processing Sorts the credentials by name in ascending order (A->Z) in case they come from the split out of order Gets a list of all workflows with nodes associated with each credential ID from the internal sqlite database Set fields for the credential name, id, type, created and updated timestamps, and list of workflow names Appends the header row and data rows to the spreadsheet created in Step 1 of this branch Move the file into the folder created at the start of the workflow from whereever google put it by default Track the estimated time it would have taken to manually do every step, in a time saved node
Best fit
Categories
Services
Use cases
Need another direction?