Build Your "Hello World" Workflow
We'll create a simple "Hello World" workflow using Platform NX in this use case. The workflow will involve setting up an application, configuring resources, defining activities, and testing the workflow.
Creating a "Hello World" Workflow using Platform NX:
Step 01: Access Platform NX Dashboard
Log in to the Platform NX dashboard.
Step 02: Create Application
Now, navigate to the homepage and select "Application" under the "Create new project" section.
Name the application as "Hello World."
Step 03: Create New Workflow
Select the application from the left-hand menu.
Click on the Application folder, and then choose "Workflows."
Click "Add a Workflow" to create a new workflow for your application.
You will see a workflow canvas page displayed.
Step 04: Define Trigger (Adding REST Service Trigger)
Initiate your workflow by selecting a trigger event, such as receiving an email, a new entry in a database, or accessing a REST service. This initial step automates your processes seamlessly, improving operational efficiency without the need for manual intervention or coding.
Add a trigger.
Select "REST Service" trigger from the available options.
Define the path as "/test/hello-world".
Save after setting this up.
After setting up the REST service trigger, you may have the option to add request parameters. Depending on your requirements, you can include headers, query parameters, or path parameters if needed.
Note: For a simple "Hello World" scenario, you might not need to include any request parameters.
Step 05: Add a Response Activity
Add a response activity to the workflow.
In the response activity configuration, set the response body to "Hello, World!".
If you're configuring a response activity in Platform NX and need to specify the response body as JSON for a "Hello World" scenario, you can format it as follows:
{
"message": "Hello, World!"
}In this JSON response, the key "message" is associated with the value "Hello, World!". You can adjust the key and value as needed to match your specific requirements. This JSON structure ensures that the response body is properly formatted and easily consumable by the requester.
Step 06: Publish Workflow
After completing configuration, publish the workflow.
Provide a version comment (e.g., "Version 1").
Step 07: Deploy the Workflow
After publishing, deploy your workflow to make it active and available for use.
Click on the "Deploy" button located in the top-right corner.
After clicking the "Deploy" button, a dialog box will appear on your screen.
This dialog box prompts you to specify deployment details such as:
Selected Workflow: Provide a name for the deployed workflow.
Deployment Name: Enter the depolyment name.
Environment: Choose the environment in which the workflow will be deployed (e.g., development, production).
Version: Specify the version of the workflow to be deployed.
Click "Deploy " to deploy the workflow.
After successful deployment, a success message will be displayed.
The message will contain information such as version, build date, server URL, environment, and status.
Click on the "Promote" button to proceed.
Step 08: Test the Workflow
Access the test page to verify the functionality of the deployed API.
Use the API testing feature to paste the request URL and configure authentication, parameters, headers, key, value, and body as needed.
Test the API to ensure it works as expected.
By following these steps, you can create and deploy a "Hello World" workflow using Platform NX. This workflow simply responds with a static message when triggered by a GET request to the specified endpoint.
Last updated