### Set Up and Install Deployment Project Dependencies Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/getting-started/quick-start.md Navigate into the basic deployment example directory and install its specific dependencies. It is recommended to copy this directory to a new, private location for your own project. ```bash cd examples/basic-deployment npm install ``` -------------------------------- ### Full API Call Step Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/02-api-call.md This example demonstrates fetching a user profile by making a GET request to a dynamic URL, including an authorization token in the headers, and mapping the response data. ```json "fetch_user_profile": { "stepInstanceId": "fetch_user_profile", "displayName": "Fetch User Profile from API", "stepType": "API_CALL", "apiHttpMethod": "GET", "apiUrlTemplate": { "template": "https://api.myapp.com/v1/users/{{user_id}}", "contextMappings": { "user_id": { "sourceJsonPath": "$.initialContextData.userId" } } }, "apiHeadersTemplate": { "Authorization": "Bearer {{auth_token}}" }, "inputMappings": { "auth_token": "$.flow_variables.authToken" }, "outputMappings": { "$.steps_output.user_profile_data": "$.data" }, "onError": { "retries": { "count": 3, "intervalSeconds": 2, "backoffRate": 1.5 } }, "defaultNextStepInstanceId": "process_profile" } ``` -------------------------------- ### Install @allma/core-sdk Source: https://github.com/allma-dev/allma-core/blob/main/packages/core-sdk/README.md Install the core SDK package using npm. ```bash npm install @allma/core-sdk ``` -------------------------------- ### Navigate to Basic Deployment Example Source: https://github.com/allma-dev/allma-core/blob/main/README.md Change the directory to the basic-deployment example within the Allma core project. ```bash cd examples/basic-deployment ``` -------------------------------- ### Install @allma/ui-components Source: https://github.com/allma-dev/allma-core/blob/main/packages/ui-components/README.md Install the UI components package along with its peer dependencies. Ensure React and Mantine are set up in your project. ```bash npm install @allma/ui-components @mantine/core @emotion/react react ``` -------------------------------- ### Install CDK Integration Utilities Source: https://github.com/allma-dev/allma-core/blob/main/packages/cdk-integration-utils/README.md Install the @allma/cdk-integration-utils package using npm. ```bash npm install @allma/cdk-integration-utils ``` -------------------------------- ### Start Local Development Server Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/README.md Starts a local development server for live previewing changes. Changes are reflected without server restart. ```bash npm start ``` -------------------------------- ### Install @allma/core-cdk Source: https://github.com/allma-dev/allma-core/blob/main/packages/core-cdk/README.md Install the core CDK package using npm. ```bash npm install @allma/core-cdk ``` -------------------------------- ### Install @allma/core-types Source: https://github.com/allma-dev/allma-core/blob/main/packages/core-types/README.md Install the core types package using npm. ```bash npm install @allma/core-types ``` -------------------------------- ### Full API_CALL Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/02-api-call.md A complete JSON configuration example for the API_CALL step, demonstrating fetching a user profile with dynamic URL parameters and authentication headers. ```APIDOC ### Full JSON Example This example fetches a user profile using a dynamic user ID in the URL and an auth token from the context. ```json "fetch_user_profile": { "stepInstanceId": "fetch_user_profile", "displayName": "Fetch User Profile from API", "stepType": "API_CALL", "apiHttpMethod": "GET", "apiUrlTemplate": { "template": "https://api.myapp.com/v1/users/{{user_id}}", "contextMappings": { "user_id": { "sourceJsonPath": "$.initialContextData.userId" } } }, "apiHeadersTemplate": { "Authorization": "Bearer {{auth_token}}" }, "inputMappings": { "auth_token": "$.flow_variables.authToken" }, "outputMappings": { "$.steps_output.user_profile_data": "$.data" }, "onError": { "retries": { "count": 3, "intervalSeconds": 2, "backoffRate": 1.5 } }, "defaultNextStepInstanceId": "process_profile" } ``` ``` -------------------------------- ### Install Admin Shell and Dependencies Source: https://github.com/allma-dev/allma-core/blob/main/packages/admin-shell/README.md Install the @allma/admin-shell package along with its required peer dependencies using npm. ```bash npm install @allma/admin-shell @allma/core-types react react-dom react-router-dom @mantine/core aws-amplify @aws-amplify/ui-react ``` -------------------------------- ### Install Dependencies with npm Source: https://github.com/allma-dev/allma-core/blob/main/allma.cdk/README.md Installs project dependencies using npm. Ensure you have Node.js and npm installed. ```bash npm install ``` -------------------------------- ### Full CUSTOM_LAMBDA_INVOKE Step Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/03-custom-lambda-invoke.md A complete example of a CUSTOM_LAMBDA_INVOKE step configuration, including ARN, input/output mappings, and error handling. ```json "calculate_premium": { "stepInstanceId": "calculate_premium", "displayName": "Calculate Insurance Premium", "stepType": "CUSTOM_LAMBDA_INVOKE", "lambdaFunctionArnTemplate": "arn:aws:lambda:us-east-1:123456789012:function:premium-calculator-prod", "inputMappings": { "applicant_data": "$.steps_output.gather_applicant_info", "policy_type": "$.initialContextData.policyType" }, "outputMappings": { "$.flow_variables.premium_details": "$" }, "onError": { "retries": { "count": 2, "intervalSeconds": 5 } }, "defaultNextStepInstanceId": "generate_quote_document" } ``` -------------------------------- ### Deploy CDK Stack (Example without Custom Domain) Source: https://github.com/allma-dev/allma-core/blob/main/allma.cdk/README.md Example deployment command for the CDK stack without configuring a custom domain. Ensure AWS credentials are set up. ```bash npm run cdk deploy -- \ -c stage=prod \ -c account=123456789012 \ -c region=us-east-1 ``` -------------------------------- ### Full JSON Example for SQS Get Queue Attributes Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/05-data-load/sqs-get-queue-attributes.md This example demonstrates how to configure the SQS Get Queue Attributes step to check the number of messages in a queue. It includes custom configuration for the queue URL and attribute names, output mapping, and a conditional transition based on the queue depth. ```json "check_queue_depth": { "stepInstanceId": "check_queue_depth", "displayName": "Check SQS Queue Depth", "stepType": "DATA_LOAD", "moduleIdentifier": "system/sqs-get-queue-attributes", "customConfig": { "queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/my-processing-queue", "attributeNames": [ "ApproximateNumberOfMessages" ] }, "outputMappings": { "$.steps_output.queue_stats": "$" }, "transitions": [ { "condition": "$.steps_output.queue_stats.attributes.ApproximateNumberOfMessages > 0", "nextStepInstanceId": "process_messages" } ], "defaultNextStepInstanceId": "end_flow" } ``` -------------------------------- ### Full JSON Example for START_FLOW_EXECUTION Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/04-flow-control/start-flow-execution.md This example demonstrates a complete configuration for the START_FLOW_EXECUTION step. It triggers a 'Process Order' flow, passing current item details as initial context and mapping the new flow's ID to a parent flow variable. ```json "trigger_order_processing": { "stepInstanceId": "trigger_order_processing", "displayName": "Trigger Order Processing Flow", "stepType": "START_FLOW_EXECUTION", "moduleIdentifier": "system/start-flow-execution", "literals": { "flowDefinitionId": "process-order-flow", "flowVersion": "LATEST_PUBLISHED" }, "inputMappings": { "initialContextData.orderDetails": "$.currentItem" }, "outputMappings": { "$.flow_variables.triggered_order_flow_id": "$.startedFlowExecutionId" }, "defaultNextStepInstanceId": "next_step_in_parent" } ``` -------------------------------- ### SNS Publisher Configuration Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/08-messaging/sns-publisher.md This example shows how to configure the sns-publisher module with literals for the topic ARN and message attributes, and an input mapping for the payload. ```json "literals": { "topicArn": "arn:aws:sns:us-east-1:123456789012:MyTopic", "messageAttributes": { "eventType": { "DataType": "String", "StringValue": "ORDER_CONFIRMED" } } }, "inputMappings": { "payload": "$.steps_output.build_order_payload" } ``` -------------------------------- ### Full MCP_CALL Step Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/mcp-call.md This comprehensive example configures an MCP_CALL step to perform a web search using a specific connection and tool. It includes input mappings, literals, output mappings, error handling, and defines the next step. ```json "run_web_search": { "stepInstanceId": "run_web_search", "displayName": "Search the Web via MCP", "stepType": "MCP_CALL", "mcpConnectionId": "mcp-conn-search-prod", "toolName": "web_search", "inputMappings": { "query": "$.steps_output.build_query.text" }, "literals": { "max_results": 5, "language": "en" }, "outputMappings": { "$.flow_variables.search_results": "$.result" }, "onError": { "retries": { "count": 2, "intervalSeconds": 5 } }, "defaultNextStepInstanceId": "summarize_results" } ``` -------------------------------- ### Deploy CDK Stack (Example with Custom Domain) Source: https://github.com/allma-dev/allma-core/blob/main/allma.cdk/README.md Example deployment command for the CDK stack with a custom domain and certificate ARN. This configures a custom domain for the deployed website. ```bash npm run cdk deploy -- \ -c stage=prod \ -c account=123456789012 \ -c region=us-east-1 \ -c domainName=docs.example.com \ -c certificateArn=arn:aws:acm:us-east-1:123456789012:certificate/your-cert-id ``` -------------------------------- ### Full S3 Data Loader Configuration Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/05-data-load/s3-data-loader.md A complete example of configuring the S3 Data Loader step to fetch a JSON configuration file, using the flow execution ID in the S3 URI. ```json "load_config_from_s3": { "stepInstanceId": "load_config_from_s3", "displayName": "Load Job Config from S3", "stepType": "DATA_LOAD", "moduleIdentifier": "system/s3-data-loader", "customConfig": { "sourceS3Uri": "s3://my-job-bucket/configs/{{flowExecutionId}}.json", "outputFormat": "JSON", "onMissing": "FAIL" }, "outputMappings": { "$.flow_variables.job_config": "$.content" }, "defaultNextStepInstanceId": "run_job" } ``` -------------------------------- ### Full JSON Example for File Download Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/file-download.md This example demonstrates how to configure the File Download step to fetch an invoice PDF from an API, authenticate using a bearer token from context secrets, stream the response to an S3 bucket with a templated key, and map the S3 pointer to an output variable. ```json { "download_invoice": { "stepInstanceId": "download_invoice", "displayName": "Download Invoice PDF", "stepType": "FILE_DOWNLOAD", "moduleIdentifier": "system/file-download", "sourceUrlTemplate": "https://api.example.com/v1/invoices/{{flow_variables.invoiceId}}/pdf", "method": "GET", "headersTemplate": { "Authorization": "$.secrets.exampleApiToken" }, "destinationBucket": "my-downloads-bucket", "destinationKeyTemplate": "invoices/{{flow_variables.invoiceId}}/{{flowExecutionId}}.pdf", "customConfig": { "timeoutMs": 60000, "verifySsl": true }, "outputMappings": { "$.steps_output.invoice.document": "$.content" }, "defaultNextStepInstanceId": "email_invoice" } } ``` -------------------------------- ### Output Mapping Example for S3 Data Loader Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/05-data-load/s3-data-loader.md Example of how to map the loaded content from the S3 Data Loader into the execution context. ```json "outputMappings": { "$.steps_output.config_file": "$.content" } ``` -------------------------------- ### Full JSON Example: Create 3 Iterations Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/generate-array.md A complete example of configuring the generate-array step to create an array of 3 items, intended to drive a subsequent parallel step. ```json { "create_iterations": { "stepInstanceId": "create_iterations", "displayName": "Create 3 Iterations", "stepType": "DATA_TRANSFORMATION", "moduleIdentifier": "system/generate-array", "literals": { "count": 3 }, "outputMappings": { "$.steps_output.iterations": "$.array" }, "defaultNextStepInstanceId": "run_in_parallel" } } ``` -------------------------------- ### Output Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/05-data-load/ddb-query-to-s3-manifest.md Demonstrates how to map the output of the manifest generation step to be used by subsequent steps, specifically for parallel processing. ```json "outputMappings": { "$.steps_output.user_manifest": "$.manifest" } ``` -------------------------------- ### Input Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/mcp-call.md This example demonstrates how to map data from the flow context into the argument object for an MCP tool. It shows mapping a search query and a result limit. ```json "inputMappings": { "query": "$.steps_output.build_query.text", "max_results": "$.initialContextData.limit" } ``` -------------------------------- ### Clone Allma Repository and Install Dependencies Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/getting-started/quick-start.md Clone the main Allma repository and install all root dependencies. This step is necessary to link all local Allma packages together. ```bash git clone https://github.com/ALLMA-dev/allma-core.git cd allma-core npm install ``` -------------------------------- ### Output Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/mcp-call.md This example shows how to map the `result` from the MCP tool's response into a flow variable named `mcp_result`. ```json "outputMappings": { "$.flow_variables.mcp_result": "$.result" } ``` -------------------------------- ### SNS Publisher Output Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/08-messaging/sns-publisher.md This example demonstrates how to map the output of the sns-publisher step, specifically the SNS message ID, to a desired location in the context. ```json "outputMappings": { "$.steps_output.sns_publish_result": "$" } ``` -------------------------------- ### Full SNS Publisher Step Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/08-messaging/sns-publisher.md This is a complete example of an sns-publisher step configuration, used here to publish an order confirmation event to an SNS topic. It includes literals for topic ARN and message attributes, and input mappings for order and customer IDs. ```json "publish_order_event": { "stepInstanceId": "publish_order_event", "displayName": "Publish Order Confirmation to SNS", "stepType": "MESSAGING", "moduleIdentifier": "system/sns-publish", "literals": { "topicArn": "arn:aws:sns:us-east-1:123456789012:OrderEvents", "messageAttributes": { "status": { "DataType": "String", "StringValue": "CONFIRMED" } } }, "inputMappings": { "payload.orderId": "$.initialContextData.orderId", "payload.customerId": "$.initialContextData.customerId" }, "defaultNextStepInstanceId": "end_flow" } ``` -------------------------------- ### Literals Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/mcp-call.md This example shows how to use the `literals` parameter to include static key/value pairs in the argument object passed to an MCP tool. ```json "literals": { "language": "en", "include_metadata": true } ``` -------------------------------- ### Example Data Context Structure Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/getting-started/key-concepts/data-context.md Illustrates the structure of the Data Context after a step has loaded user profile information. ```json { "userId": "u-123", "profile": { "name": "Jane Doe", "email": "jane.doe@example.com", "rawApiResponse": { "... a large object ..." } } } ``` -------------------------------- ### Full JSON Example: Join Employees with Departments Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/join-data.md A complete example demonstrating a left join between employees and departments using input mappings for data sources and custom configuration for join settings. It selects specific columns from the right dataset. ```json "join_employees_departments": { "stepInstanceId": "join_employees_departments", "displayName": "Join Employees with Departments", "stepType": "DATA_TRANSFORMATION", "moduleIdentifier": "system/join-data", "inputMappings": { "left_source": "$.steps_output.employees", "right_source": "$.steps_output.departments" }, "customConfig": { "left_format": "json", "right_format": "json", "join_keys": ["department_id"], "join_type": "left", "right_select_columns": ["department_name"], "output_format": "json" }, "outputMappings": { "$.steps_output.joined_records": "$.result", "$.flow_variables.joined_row_count": "$.rowCount" }, "defaultNextStepInstanceId": "next_step" } ``` -------------------------------- ### Generate Array Output Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/generate-array.md Example of mapping the generated array to a flow variable named 'iteration_list'. ```json { "outputMappings": { "$.flow_variables.iteration_list": "$.array" } } ``` -------------------------------- ### DynamoDB UpdateItem Output Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/06-data-save/dynamodb-update-item.md Example of mapping the output of a DynamoDB UpdateItem step to flow variables. ```json "outputMappings": { "$.flow_variables.update_result": "$.updatedAttributes" } ``` -------------------------------- ### Full JSON Example for SQS Message Payload Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/compose-object-from-input.md This example demonstrates how to use `compose-object-from-input` to construct a payload that will be sent to an SQS queue in a subsequent step. ```json "build_sqs_message": { "stepInstanceId": "build_sqs_message", "displayName": "Build SQS Message Body", "stepType": "DATA_TRANSFORMATION", "moduleIdentifier": "system/compose-object-from-input", "literals": { "sourceSystem": "AllmaWorkflow" }, "inputMappings": { "customerId": "$.initialContextData.customerId", "eventDetails": "$.steps_output.analyze_event" }, "outputMappings": { "$.flow_variables.message_body": "$" }, "defaultNextStepInstanceId": "send_to_sqs" } ``` -------------------------------- ### Full S3 Data Saver Configuration Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/06-data-save/s3-data-saver.md This example demonstrates a complete configuration for the S3 Data Saver step. It saves the output of a 'generate_summary' step to a JSON file in S3, using the flow execution ID for the filename and specifying the content type. ```json "save_summary_to_s3": { "stepInstanceId": "save_summary_to_s3", "displayName": "Save Summary to S3", "stepType": "DATA_SAVE", "moduleIdentifier": "system/s3-data-saver", "literals": { "destinationS3UriTemplate": "s3://my-app-results/summaries/{{flowExecutionId}}.json", "contentType": "application/json" }, "inputMappings": { "contentToSave": "$.steps_output.generate_summary" }, "outputMappings": { "$.steps_output.s3_save_result": "$" }, "defaultNextStepInstanceId": "end_flow" } ``` -------------------------------- ### DynamoDB Query and Update Output Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/06-data-save/dynamodb-query-and-update.md An example of how to map the output of the DynamoDB Query and Update step to a specific path in the workflow's context. ```json "outputMappings": { "$.steps_output.claimed_jobs": "$.items" } ``` -------------------------------- ### Synchronously Run Sub-Flow Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/04-flow-control/start-sub-flow.md This example synchronously runs a 'Calculate Pricing' sub-flow, passing the current order and customer ID. It waits for the sub-flow to complete and maps the computed total back into the parent flow's variables. ```json "run_pricing_subflow": { "stepInstanceId": "run_pricing_subflow", "displayName": "Run Pricing Sub-Flow", "stepType": "START_SUB_FLOW", "subFlowDefinitionId": "calculate-pricing-flow", "subFlowVersion": "LATEST_PUBLISHED", "subFlowExecutionMode": "SYNC", "inputMappingsToSubFlow": { "initialContextData.order": "$.steps_output.validate_order.validated_data", "initialContextData.customerId": "$.flow_variables.customer_id" }, "outputMappings": { "$.flow_variables.final_price": "$.steps_output.compute_total.amount" }, "defaultNextStepInstanceId": "next_step_in_parent" } ``` -------------------------------- ### S3 List Files Output Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/05-data-load/s3-list-files.md This example demonstrates how to map the output of the S3 List Files step to flow variables for use in downstream steps, such as a loop. ```json "outputMappings": { "$.flow_variables.input_files": "$.files", "$.flow_variables.input_file_count": "$.fileCount" } ``` -------------------------------- ### Full JSON Example for SQS Receive Messages Step Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/05-data-load/sqs-receive-messages.md A complete example of configuring the SQS receive messages step to retrieve up to 5 messages from a specific queue and map the output. ```json "get_messages_from_queue": { "stepInstanceId": "get_messages_from_queue", "displayName": "Get Messages from SQS", "stepType": "DATA_LOAD", "moduleIdentifier": "system/sqs-receive-messages", "customConfig": { "queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/my-work-queue", "maxNumberOfMessages": 5, "deleteMessages": true }, "outputMappings": { "$.steps_output.received_messages": "$.messages" }, "defaultNextStepInstanceId": "process_messages_in_parallel" } ``` -------------------------------- ### Output Schema Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/05-data-load/ddb-query-to-s3-manifest.md Illustrates the structure of the output from the `ddb-query-to-s3-manifest` step, including the S3 pointer to the generated manifest file and the total item count. ```json { "manifest": { "_s3_output_pointer": { "bucket": "your-bucket-name", "key": "manifests/your-exec-id.jsonl" } }, "itemCount": 15000 } ``` -------------------------------- ### SQS Sender Output Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/08-messaging/sqs-sender.md Example of mapping the SQS sender's output, which includes the MessageId, to a specific path in the step's output. ```json "outputMappings": { "$.steps_output.sqs_send_result": "$" } ``` -------------------------------- ### Full Array Aggregator JSON Example for Sum Operation Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/array-aggregator.md A complete example demonstrating the array-aggregator step configuration to calculate the sum of prices from a list of line items. It includes input mappings for the array and literals for the operation and path. ```json "calculate_total_cost": { "stepInstanceId": "calculate_total_cost", "displayName": "Calculate Total Cost", "stepType": "DATA_TRANSFORMATION", "moduleIdentifier": "system/array-aggregator", "literals": { "operation": "sum", "path": "price" }, "inputMappings": { "array": "$.initialContextData.cart.items" }, "outputMappings": { "$.flow_variables.total_cost": "$.result" }, "defaultNextStepInstanceId": "create_invoice" } ``` -------------------------------- ### Full Admin API Endpoint Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/admin-api/index.md Illustrates how a documented endpoint path is resolved against the base URL to form a complete request URL. ```http GET https:///v1/allma/flow-executions ``` -------------------------------- ### Email Start Point Configuration Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/09-triggers/email-start-point.md Configure an email start point to listen on a specific address. Use 'keyword' to differentiate flows from the same address and 'triggerMessagePattern' to extract data from the email body into 'triggeringEmail.triggerPattern'. ```json "support_email_trigger": { "stepInstanceId": "support_email_trigger", "displayName": "Support Email Start Point", "stepType": "EMAIL_START_POINT", "emailAddress": "support@flows.example.com", "keyword": "ORDER-HELP", "triggerMessagePattern": "Order #(\d+)", "defaultNextStepInstanceId": "classify_request" } ``` -------------------------------- ### API Call Output Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/02-api-call.md Map parts of the API_CALL step's output to the flow context. This example saves the response body and status code. ```json "outputMappings": { "$.steps_output.user_profile_data": "$.data", "$.flow_variables.user_api_status": "$.status" } ``` -------------------------------- ### Output Mapping Example for Join Data Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/join-data.md Map the joined 'result' and 'rowCount' to flow variables or subsequent step outputs. This example maps to '$.steps_output.joined_records' and '$.flow_variables.joined_row_count'. ```json "outputMappings": { "$.steps_output.joined_records": "$.result", "$.flow_variables.joined_row_count": "$.rowCount" } ``` -------------------------------- ### In-Memory Parallel Processing Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/how-to-guides/orchestrating-parallel-workloads.md This example demonstrates processing an array of product IDs in parallel. It fetches details for each product via an API call and then formats the output. Use `currentItem` to access the current item in the array within the parallel branch. ```json { "productIds": [ { "id": 101 }, { "id": 102 }, { "id": 103 } ] } ``` -------------------------------- ### Run Allma Admin Shell Development Harness Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/community/contribution-guide.mdx Navigate to the monorepo root and execute this command to start a local development server for the Admin Shell, typically on http://localhost:5173. ```bash npm run dev --workspace=@allma/admin-shell ``` -------------------------------- ### API Call Input Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/02-api-call.md Use inputMappings to provide variables for Handlebars templates in API headers and request bodies. This example shows how to provide an API key for an Authorization header. ```json "inputMappings": { "api_key": "$.initialContextData.secrets.myApiKey" } ``` -------------------------------- ### Full Email Sender Step Configuration Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/08-messaging/email-sender.md A comprehensive example of an Email Sender step instance, demonstrating configuration for sender details, recipients, subject, body, custom headers, and a static S3 attachment. ```json "send_order_confirmation": { "stepInstanceId": "send_order_confirmation", "displayName": "Send Order Confirmation", "stepType": "EMAIL", "from": "noreply@allma.dev", "fromName": "Allma Notifications", "to": "{{steps_output.lookup_customer.email}}", "cc": "fulfillment@allma.dev", "replyTo": "support@allma.dev", "subject": "Your order #{{flow_variables.orderId}} has shipped", "body": "

Thanks for your order!

Your order #{{flow_variables.orderId}} is on its way. Your invoice is attached.

", "customHeaders": [ { "name": "X-Campaign-Id", "value": "order-shipped" } ], "attachments": [ { "filename": "invoice-{{flow_variables.orderId}}.pdf", "s3Pointer": { "bucket": "allma-documents", "key": "invoices/{{flow_variables.orderId}}.pdf" } } ], "outputMappings": { "$.steps_output.send_order_confirmation.messageId": "$.sesMessageId", "$.steps_output.send_order_confirmation.status": "$._meta.status" }, "defaultNextStepInstanceId": "log_notification_sent" } ``` -------------------------------- ### Full SQS Sender Step Example for FIFO Queue Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/08-messaging/sqs-sender.md A complete example of an SQS Sender step configured to send user profiles to a FIFO queue, using the user's ID for message grouping to ensure ordered processing. ```json "queue_user_for_processing": { "stepInstanceId": "queue_user_for_processing", "displayName": "Queue User for Processing", "stepType": "MESSAGING", "moduleIdentifier": "system/sqs-send", "literals": { "queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/UserProfileUpdates.fifo" }, "inputMappings": { "messageGroupId": "$.steps_output.user_profile.id", "payload": "$.steps_output.user_profile" }, "defaultNextStepInstanceId": "next_step" } ``` -------------------------------- ### Zustand Store Reset Example Source: https://github.com/allma-dev/allma-core/blob/main/packages/admin-shell/tests/README.md Demonstrates how to reset the Zustand store's data slice before each test to ensure a clean state. The action functions are stable singletons. ```javascript store.setState({ flowDefinition: null, nodes: [], edges: [], isDirty: false }) ``` -------------------------------- ### Input Mapping Example for Lambda Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/03-custom-lambda-invoke.md Demonstrates how to map data from the flow's context and previous steps into the input payload for a custom Lambda function. ```json "inputMappings": { "user": "$.steps_output.user_profile", "orderId": "$.initialContextData.orderId" } ``` -------------------------------- ### DynamoDB Data Loader Configuration Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/05-data-load/dynamodb-data-loader.md This example demonstrates a DynamoDB QUERY operation on a GSI to retrieve all documents associated with a specific user. It utilizes Handlebars templating to dynamically set the userId in the key condition expression. ```json "get_user_documents": { "stepInstanceId": "get_user_documents", "displayName": "Get User Documents from DynamoDB", "stepType": "DATA_LOAD", "moduleIdentifier": "system/dynamodb-data-loader", "customConfig": { "operation": "QUERY", "tableName": "AppDataTable", "indexName": "UserDocumentsGSI", "keyConditionExpression": "userId = :uid", "expressionAttributeValues": { ":uid": "{{initialContextData.userId}}" } }, "outputMappings": { "$.flow_variables.documents": "$.content" }, "defaultNextStepInstanceId": "process_documents" } ``` -------------------------------- ### SQS Get Queue Attributes Output Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/05-data-load/sqs-get-queue-attributes.md Example of how to map the queue depth attribute to a flow variable. This allows you to store and use the message count in subsequent steps. ```json "outputMappings": { "$.flow_variables.queue_depth": "$.attributes.ApproximateNumberOfMessages" } ``` -------------------------------- ### Literals for START_FLOW_EXECUTION Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/04-flow-control/start-flow-execution.md Use literals for static configuration values, such as the flow version to trigger. This example sets the flow version to LATEST_PUBLISHED and enables execution logs. ```json "literals": { "flowVersion": "LATEST_PUBLISHED", "enableExecutionLogs": true } ``` -------------------------------- ### NO_OP Step Example Output Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/04-flow-control/noop.md Illustrates the structure of the output from a NO_OP step, including original input data and a success message. ```json { "some_input_data": 123, "message": "NO_OP step 'My No-Op Step' executed successfully." } ``` -------------------------------- ### Get Parallel Branch Steps Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/admin-api/execution-monitoring-api.md Retrieves step logs for child branches of a parallel execution. Requires the parent execution ID, parent step instance ID, and parent step start time. ```json { "success": true, "data": { "branch-exec-1": { "branchId": "process_item", "steps": [ ... ] }, "branch-exec-2": { "branchId": "process_item", "steps": [ ... ] } } } ``` -------------------------------- ### Example Prompt Template Content Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/how-to-guides/building-your-first-ai-flow.md This is the content for the 'Summarize Text' prompt template. It uses Handlebars syntax to insert the article text into the prompt for the LLM. ```handlebars Please summarize the following article in two sentences: --- ARTICLE START --- {{text_to_summarize}} --- ARTICLE END --- ``` -------------------------------- ### Mapping Input Data to Prompt Template Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/01-llm-invocation.md Pass simple variables directly to the prompt template using `inputMappings`. This example maps data from `initialContextData.query` to the `user_text` variable in the prompt. ```json "inputMappings": { "user_text": "$.initialContextData.query" } ``` -------------------------------- ### Configure Date Time Calculator with Input Mappings Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/date-time-calculator.md Use inputMappings and literals to provide configuration parameters for the date-time-calculator. This example shows how to calculate a timestamp 1 hour in the future. ```json "inputMappings": { "baseTime": "$.flow_variables.now" }, "literals": { "offsetSeconds": 3600, "operation": "add" } ``` -------------------------------- ### Clone Repository and Navigate Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/community/contribution-guide.mdx Clone your forked repository locally and navigate into the project directory. ```bash git clone https://github.com/YOUR_USERNAME/allma-core.git cd allma-core ``` -------------------------------- ### Generate Array Input Mapping Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/generate-array.md Example of how to map the 'count' parameter to generate an array with 5 items. ```json { "literals": { "count": 5 } } ``` -------------------------------- ### Triggering a Flow with Initial Payload Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/how-to-guides/managing-long-running-processes.md Use this command to start a flow and provide initial data. Replace placeholders with your specific API Gateway URL and flow ID. ```bash curl -X POST 'https://YOUR_API_GATEWAY_URL/trigger/your-flow-id' \ -H 'Content-Type: application/json' \ -d '{"expenseId": "EXP-123", "amount": 500}' ``` -------------------------------- ### UUID with Prefix and Suffix Output Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/generate-uuid.md The output UUID includes the configured prefix and suffix. The example shows a UUID prefixed with 'order-'. ```json { "uuid": "order-123e4567-e89b-42d3-a456-426614174000" } ``` -------------------------------- ### Output Mapping Example from Lambda Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/03-custom-lambda-invoke.md Illustrates how to map the JSON response from a custom Lambda function back into the Allma flow's context or variables. ```json "outputMappings": { "$.flow_variables.premium_details": "$" } ``` -------------------------------- ### SQS Sender Configuration Literals and Input Mappings Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/08-messaging/sqs-sender.md Example of how to configure the SQS sender with literals for queue URL and message group ID, and input mapping for the payload. ```json "literals": { "queueUrl": "https://sqs.us-east-1.amazonaws.com/123456789012/MyWorkQueue.fifo", "messageGroupId": "user-processing" }, "inputMappings": { "payload": "$.steps_output.build_user_payload" } ``` -------------------------------- ### Map Input for Content to Save Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/06-data-save/s3-data-saver.md Use `inputMappings` to specify the data that will be saved to S3. This example maps the output of a previous LLM step named 'summary_step' to the `contentToSave` parameter. ```json "inputMappings": { "contentToSave": "$.steps_output.summary_step" } ``` -------------------------------- ### Core Usage: Create Allma Admin App Source: https://github.com/allma-dev/allma-core/blob/main/packages/admin-shell/README.md Example of setting up the main entry point for an Allma admin application. This includes configuring AWS Amplify, defining a sample plugin with routes and navigation items, and initializing the admin app with the plugin. ```tsx import React from 'react'; import ReactDOM from 'react-dom/client'; import { createAllmaAdminApp } from '@allma/admin-shell'; import { AllmaPlugin } from '@allma/core-types'; import { IconDashboard } from '@tabler/icons-react'; import { Amplify } from 'aws-amplify'; // --- Step 1: Configure AWS Amplify --- // These values come from your Allma CDK deployment outputs. // It's best to provide them via environment variables (e.g., using a .env file with Vite). Amplify.configure({ Auth: { Cognito: { userPoolId: import.meta.env.VITE_COGNITO_USER_POOL_ID, userPoolClientId: import.meta.env.VITE_COGNITO_USER_POOL_CLIENT_ID, }, }, API: { REST: { 'AdminApi': { endpoint: import.meta.env.VITE_API_BASE_URL, } } } }); // --- Step 2: Define or Import Your Plugins --- // A plugin is just an object that conforms to the AllmaPlugin type. // You can build complex features in separate files or even separate packages. const dashboardPlugin: AllmaPlugin = { name: 'DashboardPlugin', routes: [ { path: '/', element:
Welcome to your Custom Allma Dashboard!
, }, ], navItems: [ { label: 'Dashboard', path: '/', icon: IconDashboard, }, ], }; // --- Step 3: Create and Mount the Allma App --- // This function initializes the shell, registers your plugins, and renders the app. createAllmaAdminApp({ plugins: [ dashboardPlugin, // ...add other plugins here ], }); ``` -------------------------------- ### Input Mappings for Join Data Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/join-data.md Map datasets from flow data to the 'left_source' and 'right_source' parameters. This example shows mapping arrays from previous steps. ```json "inputMappings": { "left_source": "$.steps_output.employees", "right_source": "$.steps_output.departments" } ``` -------------------------------- ### Admin API Base URL Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/admin-api/index.md This shows the base URL structure for making requests to the Admin API, including the version segment. ```http https:///v1 ``` -------------------------------- ### DynamoDB UpdateItem Output Schema Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/06-data-save/dynamodb-update-item.md Example of the output schema for a DynamoDB UpdateItem operation, showing the updated attributes and metadata. ```json { "updatedAttributes": { "name": "Jane Doe", "email": "jane.doe@example.com" }, "_meta": { "status": "SUCCESS", ... } } ``` -------------------------------- ### Full JSON Example: Generate Invoice ID Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/generate-uuid.md A complete step configuration that generates a UUID prefixed with 'invoice-' and maps it to the step's output for use in a subsequent step. ```json "generate_invoice_id": { "stepInstanceId": "generate_invoice_id", "displayName": "Generate Invoice ID", "stepType": "DATA_TRANSFORMATION", "moduleIdentifier": "system/generate-uuid", "customConfig": { "prefix": "invoice-" }, "outputMappings": { "$.steps_output.invoice_id": "$.uuid" }, "defaultNextStepInstanceId": "save_invoice" } ``` -------------------------------- ### DynamoDB Query to S3 Manifest Configuration Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/05-data-load/ddb-query-to-s3-manifest.md Example configuration for the `ddb-query-to-s3-manifest` step. It specifies the DynamoDB table, query conditions, and the S3 destination for the manifest file. Supports Handlebars templating for dynamic values. ```json "generate_user_manifest": { "stepInstanceId": "generate_user_manifest", "displayName": "Generate User Data Manifest", "stepType": "DATA_LOAD", "moduleIdentifier": "system/ddb-query-to-s3-manifest", "customConfig": { "query": { "tableName": "MyDataTable", "keyConditionExpression": "PK = :partitionKey", "expressionAttributeValues": { ":partitionKey": "USER#{{initialContextData.userId}}" } }, "destination": { "bucketName": "my-allma-data-bucket", "key": "manifests/{{initialContextData.userId}}-{{flowExecutionId}}.jsonl" } }, "outputMappings": { "$.steps_output.manifest_details": "$" }, "defaultNextStepInstanceId": "process_manifest_in_parallel" } ``` -------------------------------- ### S3 Manifest File Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/how-to-guides/orchestrating-parallel-workloads.md A JSON Lines (.jsonl) file stored in S3, where each line is a valid JSON object. This format is used as input for the S3 Distributed Map mode. ```json {"userId": "user-a", "region": "us-east-1"} {"userId": "user-b", "region": "eu-west-1"} {"userId": "user-c", "region": "us-east-1"} ``` -------------------------------- ### Output Mapping for Aggregated Results Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/04-flow-control/parallel-fork-manager.md This example shows how to map the aggregated results from the PARALLEL_FORK_MANAGER step into the flow context. It stores the 'aggregatedData' output into a new path '$.steps_output.processed_items'. ```json { "outputMappings": { "$.steps_output.processed_items": "$.aggregatedData" } } ``` -------------------------------- ### Preview Production Build Locally Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/README.md Mirrors the CI build and link check process locally before creating a PR. Serves the contents of the './build' directory. ```bash npm run build --prefix docs.allma.dev ``` ```bash npm run serve --prefix docs.allma.dev ``` -------------------------------- ### Output Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/04-flow-control/start-sub-flow.md Define `outputMappings` to specify how the final context data from a synchronous sub-flow should be mapped into the parent flow's context. This is useful for extracting specific results from the completed sub-flow. ```json "outputMappings": { "$.flow_variables.final_price": "$.steps_output.compute_total.amount" } ``` -------------------------------- ### Full JSON Example for Date Time Calculator Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/date-time-calculator.md This step calculates an expiry timestamp for a token that is valid for 15 minutes. It uses the system/date-time-calculator module with specific literals and input/output mappings. ```json "calculate_expiry": { "stepInstanceId": "calculate_expiry", "displayName": "Calculate Token Expiry", "stepType": "DATA_TRANSFORMATION", "moduleIdentifier": "system/date-time-calculator", "literals": { "offsetSeconds": 900, "operation": "add" }, "inputMappings": { "baseTime": "$.startTime" }, "outputMappings": { "$.steps_output.token_details.expiresAt": "$.result" }, "defaultNextStepInstanceId": "issue_token" } ``` -------------------------------- ### Full SCHEDULE_START_POINT Step Instance Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/09-triggers/schedule-start-point.md This JSON object represents a complete step instance configuration for a SCHEDULE_START_POINT trigger. It includes the schedule expression, timezone, enabled status, and a payload template for initial context data. ```json "schedule_weekday_morning": { "stepInstanceId": "schedule_weekday_morning", "displayName": "Weekday Morning Trigger", "stepType": "SCHEDULE_START_POINT", "scheduleExpression": "cron(5 8 ? * MON-FRI *)", "timezone": "America/New_York", "enabled": true, "payloadTemplate": { "source": "nightly-cron", "reportType": "daily-summary", "batchSize": 100 }, "defaultNextStepInstanceId": "load_pending_records" } ``` -------------------------------- ### SQS Receive Messages Output Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/05-data-load/sqs-receive-messages.md Example of mapping the received messages array to a flow variable for parallel processing in a subsequent step. ```json "outputMappings": { "$.flow_variables.messages_to_process": "$.messages" } ``` -------------------------------- ### Define Step Definitions for Import Source: https://github.com/allma-dev/allma-core/blob/main/packages/core-cdk/README.md Structure your step definitions in a JSON file. Each step definition requires an ID, name, description, handler, and optionally a defaultConfig. ```json { "stepDefinitions": [ { "id": "CUSTOM_SEND_EMAIL", "name": "Send a Custom Email", "description": "Sends an email using a predefined template.", "handler": "SEND_EMAIL", "defaultConfig": { "subject": "Default Subject", "template": "default-template" } } ] } ``` -------------------------------- ### Build Allma Packages Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/getting-started/quick-start.md Navigate to the monorepo root and run the build command to compile all Allma packages. ```bash # In the monorepo root (e.g., allma-core/) cd ../.. npm run build ``` -------------------------------- ### DynamoDB UpdateItem Input Mappings Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/06-data-save/dynamodb-update-item.md Example of how to use inputMappings to dynamically set the item key and expression attribute values for a DynamoDB UpdateItem operation. ```json "inputMappings": { "key.PK": "$.flow_variables.user_pk", "expressionAttributeValues.:name": "$.steps_output.get_name.fullName" } ``` -------------------------------- ### Initial Context Data Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/09-triggers/schedule-start-point.md This JSON demonstrates the structure of initial context data when a SCHEDULE_START_POINT trigger fires with a defined payloadTemplate. It includes data from the payload, along with system-provided fields like 'steps_output' and 'flow_variables'. ```json { "source": "nightly-cron", "batchSize": 100, "steps_output": {}, "flow_variables": { "flowExecutionId": "a1b2c3d4-0000-0000-0000-000000000000" } } ``` -------------------------------- ### Array Aggregator Output Mapping Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/array-aggregator.md Map the 'result' from the array-aggregator output to a flow variable. This example shows how to store the calculated average score in a flow variable. ```json "outputMappings": { "$.flow_variables.average_score": "$.result" } ``` -------------------------------- ### Input Mappings for START_FLOW_EXECUTION Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/04-flow-control/start-flow-execution.md Use inputMappings to specify how to construct the payload for the new flow's context. This example maps a flow variable for the flow definition ID and validated order data for the initial context. ```json "inputMappings": { "flowDefinitionId": "$.flow_variables.process_order_flow_id", "initialContextData.order": "$.steps_output.validate_order.validated_data" } ``` -------------------------------- ### Output Mapping Example for POLL_EXTERNAL_API Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/04-flow-control/poll-external-api.md This example demonstrates how to map the data from the final successful API response to an output variable. It saves the 'data' field from the API response to '$.steps_output.processed_video_details'. ```json "outputMappings": { "$.steps_output.processed_video_details": "$.data" } ``` -------------------------------- ### Vitest Project Setup Source: https://github.com/allma-dev/allma-core/blob/main/packages/admin-shell/tests/README.md Two Vitest projects are configured: 'unit' for Node.js environment tests and 'dom' for JSDOM environment tests. Commands are provided to run specific projects or the entire test suite. ```bash npm run test:unit npm run test:dom npm test npm run test:coverage ``` -------------------------------- ### Deploy with CDK Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/getting-started/quick-start.md Execute this command from your deployment project to deploy your Allma stack, including the Admin Shell. ```bash npx cdk deploy --all ``` -------------------------------- ### SQS Get Queue Attributes Output Schema Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/05-data-load/sqs-get-queue-attributes.md The output of the SQS Get Queue Attributes module is a JSON object containing a dictionary of the requested attributes. Numerical values are automatically converted to numbers. ```json { "attributes": { "ApproximateNumberOfMessages": 120, "ApproximateNumberOfMessagesNotVisible": 5 } } ``` -------------------------------- ### Build Documentation Site Assets Source: https://github.com/allma-dev/allma-core/blob/main/allma.cdk/README.md Builds the static assets for the documentation site using npm. This command should be run from the root of the documentation project. ```bash npm install --prefix ../docs.allma.dev npm run build --prefix ../docs.allma.dev ``` -------------------------------- ### Flatten Array - Full JSON Configuration Example Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/docs/reference/step-types/07-data-transformation/flatten-array.md A complete example of configuring the flatten-array module to extract 'id' properties from an array of objects. It specifies the input array, the property path, and maps the result to a flow variable. ```json "extract_ids": { "stepInstanceId": "extract_ids", "displayName": "Extract Processed IDs", "stepType": "DATA_TRANSFORMATION", "moduleIdentifier": "system/flatten-array", "literals": { "path": "id" }, "inputMappings": { "array": "$.steps_output.processed_items" }, "outputMappings": { "$.flow_variables.processed_ids": "$.result" }, "defaultNextStepInstanceId": "log_ids" } ``` -------------------------------- ### Build Static Website Content Source: https://github.com/allma-dev/allma-core/blob/main/docs.allma.dev/README.md Generates static website content into the 'build' directory for hosting. ```bash npm run build ```