Module 12: How to Use the Advanced Editor
Introduction to the Advanced Editor 👩💻
The Advanced Editor in Rise-X is a powerful tool that unlocks advanced customisation for workflows and asset types, extending beyond the capabilities of the drag-and-drop builder.
This module will give you the overview of what the Advanced Editor can do and show you a little bit about how to use it. However, the Advanced Editor is complex to use and so we will point you towards other knowledge base articles that cover how to set up specific functionality.
Key Functionality Enabled by the Advanced Editor ⚡️
- Integrations:
- Send data to an external software.
- Receive data back and perform actions such as start a work item, fill in data, create an asset, etc by using our open APIs.
- Conditions:
- Conditionally hide or show components or whole sections based on a rule.
- Set up other conditions in the workflow so that it fits to your business process (e.g. skip a task in the workflow if a condition is met, send this data to this software if this condition is met, or invite these users if this condition is met)
- We have designed Rise-X so that any complex real world business process can be replicated on Rise-X. It is just a matter of setting up the, sometimes, complex business logic.
- Workflow Controls:
- Link workflows and asset types together to fit your Rise-X ecosystem to your business processes.
- Define rules that set certain colours and status text on work cards.
- Define the content and format of the data in the columns that show in the table overview of all the work items in a workflow.
- Components:
- Access to new components like the comments and related work table.
- New functionality for existing components such as:
- Validations either stopping a workflow or raising a warning flag.
- Advanced default values.
- Enable time zone selection and define date format for date components.
- Define colour codes and labels for specific ranges in a slider component.
- Activities:
- Additional activities such as:
- Creating new work items when a user submits a task.
- Update an existing work item when a user submits a task.
- Create new assets and fill them with data when a user submits a task.
- Customise the email that is sent when a task is submitted.
Accessing the Advanced Editor 🤔
- Open a workflow or asset type in the No-Code Builder.
- Workflow editor or asset type editor permission is required.
- Click the Advanced Editor button “< >” (located in the top-right corner).
Advanced Editor Layout 📝
- Left Panel: Navigate between workflow/asset type elements (e.g., components, activities, actions).
- Right Panel: Configure settings for the selected element.
- Auto-Save: Changes are saved automatically.
Example of Using the Advanced Editor ✍️
There’s a lot of functionality available in the advanced editor that can take time to learn and understand. We hope that this example of using the Advanced Editor gives you some insight into how this tool can be used to help you set up complex business ecosystems on Rise-X.
Configuring Conditional Components
Scenario: Hide a "Status Update" text field unless the user selects "High Priority”.
- In a workflow create a select component (for “Low Priority” and “High Priority” and a text component (for the status update).
- This can be done in the No-Code Builder.
- Open up the advanced editor.
- Navigate to the select component by clicking on Steps > {step name} > {task name} > Layouts > {layout name} > {section name} > {select component name}.
- Copy the value in the “dataPath” value from the select component.
- e.g. from “dataPath”: “$.taskOne.selectComponent” you would copy “$.taskOne.selectComponent”.
- Navigate to the text component.
- Change this property on the text component.
- “condition”: “’{$.taskOne.selectComponent}’ == ‘High Priority’”
- Paste the dataPath for the select component.
- Notice how both the dataPath and the value are wrapped in ‘single quotation marks’.
- Notice how the dataPath is wrapped in {}.
- Notice how two == are used.
- Check there are no validation errors and then exit out of the Advanced Editor.
- Your progress will be saved automatically.
- Publish your workflow.
- Done 🎉
- Now when you start a new work item the text component will be hidden until you select the “High Priority” option on the select component.
Using the Knowledge Base with the Advanced Editor 📑
To learn how to set up other functionality using the Advanced Editor we have dedicated pages on other parts of the knowledge base.
- Combined Guides: For features partially supported by the No-Code Builder (e.g. number components), the Knowledge Base provides instructions for both No-Code and advanced configurations.
- Advanced Editor Exclusive: Check out the Advanced Editor section on the knowledge base for functionality that the Advanced Editor uniquely enables.
- API Documentation: We also have a separate section in the knowledge base for API documentation.
Key Takeaways 🔑
- The Advanced Editor enables complex customisations beyond the drag-and-drop builder.
- Refer to the Knowledge Base for guidance on advanced configurations.
Continue Learning 🚶♀️➡️
- The next module in the Rise-X Academy covers how to integrate other systems with Rise-X, check it out here.