Audit Trail
Last updated
Last updated
The Nected Audit Trail is a feature that allows you to track all changes made to your Nected account. This includes changes to your rules, datasets, connectors, global variables, system API keys, and auth configs.
The Nected Audit Trail is a valuable tool for a variety of purposes, including:
Troubleshooting: If you are experiencing problems with your Nected workspace, you can review the Audit Trail to identify the source of the issue. For example, if a rule is not working as expected, you can check the Audit Trail to see when the rule was last modified and who made the changes.
Security and compliance: The Audit Trail can help you to monitor user activity and detect suspicious behavior. For example, you can use the Audit Trail to identify users who are accessing or modifying sensitive data without authorization. Additionally, the Audit Trail can help you to comply with industry regulations that require organizations to track all changes to their IT systems.
To navigate to the Audit Trail, click on the "Audit Trail" link in the left-hand sidebar of the Nected dashboard.
The Audit Trail screen in Nected provides a comprehensive overview of all changes made within your workspace. It serves as a vital tool for tracking, monitoring, and understanding the history of events and actions within your Nected account. Each change is meticulously recorded, with detailed information presented in an easily accessible format.
The Audit Trail screen comprises several columns, each offering specific insights into the changes and events that have occurred in your workspace:
Date: This column displays the date and time when a change or event took place.
Type: The "Type" column categorizes the nature of the event or change. It indicates whether the change relates to a simple rule, decision table, rule set, dataset, connector, global variables, system API key, or auth config.
Simple Rule: Simple rules are the fundamental building blocks of Nected's rule-based systems. They typically encompass straightforward rules with a set of conditions and corresponding actions. A "Create" event indicates the formation of a new simple rule. When a user modifies an existing rule, an "Update" event is recorded. The "Publish" event suggests that the rule has been successfully deployed to a specific environment. "Test via Console" means running the rule using the Console feature to validate its functionality. A "Delete" event signifies the removal of a simple rule. And finally a “Call via API” event signifies the execution of the rule through an API call.
Decision Table: Decision tables are used to define and manage complex business logic by mapping multiple conditions to corresponding outcomes. The event types for decision tables mirror those of simple rules. You'll find "Create" events for new decision tables, "Update" events for modifications, "Publish" events for deploying the decision table, "Test via Console" for validation testing, “Call via API” for execution of the rule, and "Delete" for removing decision tables.
Rule Set: Rule sets are containers for organizing multiple simple rules and decision tables. A "Create" event occurs when a new rule set is generated. "Update" events involve changes made to the rule set structure. "Publish" events indicate the deployment of the rule set to an environment. "Test via Console" signifies the testing of the entire rule set using the Console. "Delete" events mark the removal of rule sets. And the “Call via API” signifies the execution of the rule.
Dataset: Datasets are used to access, manage, and manipulate data from connected databases or other data sources. A "Create" event represents the introduction of a new dataset. "Update" events encompass modifications to the dataset's structure or configuration. "Publish" events indicate the deployment of the dataset to a specific environment. "Delete" events are recorded when datasets are removed from the workspace.
Connector: Connectors are essential for linking Nected to external systems, such as databases or APIs. A "Create" event is logged when a new connector is established. "Update" events capture modifications to connector configurations. "Publish" events reflect the deployment of connectors to a particular environment. "Delete" events signify the removal of connectors from the workspace.
Global Variables: Global variables are used for managing the settings and parameters of remote systems, such as external databases. A "Create" event is registered when a new global attribute is set up. "Update" events occur when configurations are modified. "Publish" events represent the deployment of global attributes to a specific environment. "Delete" events document the removal of global attributes.
System API Key: System API keys are authentication tokens that allow secure communication between Nected and external systems. A "Create" event is recorded when a new system API key is generated. "Update" events pertain to changes in the API key's settings or parameters. "Delete" events indicate the removal of system API keys from the workspace.
Auth Config: Auth configs are used to configure authentication settings for interactions with external systems. A "Create" event is registered when a new auth config is created. "Update" events capture changes to the authentication configuration. "Publish" events show the deployment of auth configs to specific environments. "Delete" events signify the removal of auth configurations.
Actions: An "Actions" event is registered when an API call is made as part of a rule's action. In Nected, rules can include actions that involve interacting with external systems or services via API calls. This event type captures the execution of such actions, whether they involve sending data to a remote API, retrieving information from an external service, or triggering specific functions in third-party systems. Actions in rules enable users to automate processes, integrate with external tools, and expand the capabilities of their workflows.
Event: Here, you can find a description of the specific event, such as "Created," "Updated," "Published," "Tested via Console," “Call via API,” and "Deleted." This column provides clear details on the actions performed.
Create: A "Create" event indicates the inception or generation of a new component or entity within your Nected workspace. When this event is logged, it signifies that a user has created a new rule, dataset, connector, global attributes, system API key, or auth configuration. The user has initiated the creation of a new item, and this event represents the start of its existence.
Update: An "Update" event is recorded when changes are made to an existing component or entity. This event highlights modifications, adjustments, or enhancements to a rule, dataset, connector, global attributes, system API key, or auth configuration. The "Update" event informs users that the previously established entity has been altered, potentially affecting its behavior or functionality.
Publish: The "Publish" event signifies the deployment or activation of a component in a specific environment. For instance, when a rule, dataset, connector, or global attributes is published, it means that it is now operational and ready to execute its defined functions within the chosen environment. This event marks the transition from a developmental or testing phase to an active, production-ready state.
Test via Console: "Test via Console" is an event associated with the validation and assessment of rules. When a user runs a test on a rule via the Nected Console, it falls under this category. This event is especially useful for users who want to ensure that their rules function correctly and yield the expected outcomes. While running a test, the system evaluates the rule's behavior, and any issues or errors are recorded as part of the test results.
Call Via API: The "Call Via API" event represents the execution of a rule and the rule action through API calls. Users can integrate Nected with external systems using the API and then trigger actions in response to specific conditions. This event demonstrates the interaction with external systems or data sources through API endpoints, and it allows users to automate tasks and workflows.
Delete: A "Delete" event is logged when a user decides to remove or eliminate a component or entity from their Nected workspace. This event indicates the intentional removal of a rule, dataset, connector, global attributes, system API key, or auth configuration. When a component is deleted, it is permanently erased from the workspace and can no longer be used in any operations or workflows.
Status: The "Status" column indicates the outcome of the event—whether it was successful or if any errors occurred during execution. Additionally, for certain events, you can see the runtime of the event.
Note: When a user closes a window in the middle of an event, especially when running a test via the Console, only the runtime will be displayed in the "Status" column, and the success or error message may not be available.
Mode: This column specifies whether the event took place in the "Staging" or "Production" environment.
User: The "User" column identifies the user who initiated the event. For events like testing rules via the Console, where the system conducts the tests, the "User" column may not display any user information.
Root Node: The "Root Node" is the parent element or node related to the event. For events like creating, updating, or deleting, the "Root Node" may be indicated as "None" because these events are linked directly to the root node itself.
IP Address: The "IP Address" column shows the IP address from which the event was performed. This information is particularly helpful for tracking event origins.
At the top of the Audit Trail screen, you'll find a set of tabs that facilitate efficient event filtering. These tabs are designed to help you quickly locate specific events based on various criteria:
Search Bar: You can use the search bar to find a particular event by its unique ID or name.
Filtering Drop downs: Three dropdown menus allow you to filter events based on specific attributes:
Types: Filter by event type, such as simple rule, decision table, rule set, dataset, connector, global attributes, system API key, or auth config.
Status: Filter events by success or error status.
Mode: Sort events based on the environment in which they occurred—either "Staging" or "Production."
Date Range: The date range allows you to narrow down events based on specific dates. You can set a starting date and ending date to filter events within a particular timeframe.
With these advanced filtering options and the detailed information provided in the columns, the Audit Trail screen in Nected empowers you to effectively track and manage changes within your workspace. It enhances visibility, transparency, and accountability, ensuring that you have a comprehensive understanding of all the events that impact your Nected account.
The "Audit Log" screen in Nected serves as a comprehensive tracking tool for administrators, enabling them to monitor all changes made to their account. This includes modifications to various elements such as rules, datasets, connectors, global attributes, system API keys, and authentication configurations. The "Audit Log" screen provides valuable insights into these changes, helping administrators maintain account security and track account usage trends.
The "Audit Log" screen displays detailed information for each event, allowing administrators to gain a clear understanding of what occurred:
Date and Time of Change: The timestamp of when a change was made, down to the minute, is recorded.
Type of Change: The type specifies the category of the change, such as "Rule Set," "Simple Rule," "Dataset," "Connector," "Global Attributes," "Decision Table," "System API Key," or "Auth Config."
Event: The event signifies the nature of the change, whether it involved the creation, update, test via console, call via API, Publish, or deletion of an element.
Status: The status reflects whether the event was executed successfully or resulted in an error. The runtime of the event is also recorded for further context. In cases where a user closes a window during an event, only the runtime is displayed, as the event's status remains unknown.
Mode: The mode highlights whether the event occurred in the "Staging" or "Production" environment, providing clarity regarding the context of the change.
User: The user field identifies the administrator who initiated the change, except in cases where an event is system-triggered, as seen in tests conducted via the Console.
IP Address: The IP address is Nected’s IP address.
ID: The ID is a unique identifier for each event and varies based on the event type. For regular events like creation, deletion, updating, or publishing, the ID appears as an alphanumeric string (e.g., "6540966756a40764f25858d2"). However, for "test via Console" events, the ID is preceded by "rule:" if the event pertains to a rule, "connector:" for connectors, "dataset:" for datasets, and "action:" for actions (e.g., "rule:6540966756a40764f25858d2"). This ID is crucial for tracking and referencing events.
Input/ Output Log: This log displays the input and output values of both rules and workflows, including parent and child elements within a ruleset and workflow.
In specific cases where an event has parent or children events, typically observed during testing via the Console, the "Audit Log" screen provides additional information about these related events. This information includes:
Date and Time of Change: The timestamp for each associated event.
Type of Change: The type specifies the category of each related event.
Name: The name identifies the specific element for each event.
Event: The event signifies the nature of the change for each related event.
Mode: The mode highlights whether each related event occurred in the "Staging" or "Production" environment.
User: The user field identifies the administrator responsible for each associated event.
Root Node: The root node, applicable mainly to events like creation, updating, deletion, or publishing, designates the parent element of the event. In cases where events are inherently rooted, such as creating a rule, the rule itself serves as its own root node.
IP Address: The IP address indicates the location from which each event took place.
To capture the input and output values, execution details, and errors of rules and workflows, Nected also provides an Auditing Option. It provides a comprehensive log of all input/output along with error messages/logs during the process, ensuring transparency and traceability of actions taken as well as being able to debug the error.
By default, Only the main events, metadata, and macro details are tracked and no input/output is stored for any rule & workflow
To enable the input/output logging, you need to first enable the Audit logging inside the setting tabs of the rule/ workflow for which you want to validate the input-output logging.
Both in the rule editor and the workflow editor, you can find the Auditing option in the settings section. By default, the “Auditing” button is toggled off.
After enabling the Auditing option, now just test your rule and then go to the “Audit Trail” page. Inside the audit trail page, you can see the rule you’ve tested, click on that rule, and that will open the Audit log window. Inside the audit log window, now you can see the dedicated section for input and output.
Select the existing rule, after selection, you will see a window. In that window Auditing Button will be there. This button can be Enabled or Disabled. by default it is disabled. you can use this button to track the input attributes and output values of a rule execution
By default, the Button is Disabled, and only metadata, macros, and main events are tracked. To view tracked data, navigate to the audit trail and select the recent rule execution. you will see all the event details.
Only Information Like Date, Type of Rule, Environment, User, ID and Status Message can be seen when this button is disabled.
When the Button is Enabled, sensitive changes like input and output values are also tracked. Use this feature cautiously, as all attribute values and API keys present inside the rule will be tracked in the audit trail and it can be exposed in the records. the user should take his/her own risk to use this feature.The Input Attributes and OutPut Values of rule execution is displayed in audit trail when this button is enabled.
Select the existing Workflow, after selection you will see a window. In that window select setting icon after selecting you can find Auditing Button. This button can be Enabled or Disabled. by default it is disabled. You can use this button to track input attributes and output values of Parent and Child Node Execution in a workflow
By default, the Button is Disabled, and only metadata, macros, and main events of parent and child node are tracked. To view tracked data, navigate to the audit trail and select the recent rule execution. you will see all the event details.Only Information Like Date, Type of workflow node, Environment, User, ID and Status Message can be seen when this button is disabled
When the Button is Enabled, sensitive changes like input and output values are also tracked. Use this feature cautiously, as all attribute values and API keys present inside the workflow will be tracked in the audit trail. and it can be exposed in the records. the user should take his/her own risk to use this feature.
To access the "Audit Log" screen, administrators need to navigate to the Audit Log page within the Nected dashboard. Once on the Audit Log page, administrators can efficiently utilize filtering and sorting options to streamline their audit log analysis. These filters include date, event type, name, event status, mode, user, root node, IP address, and a date range.
The "Audit Log" screen is a powerful tool for administrators, providing the necessary oversight and transparency to ensure the security, integrity, and efficient operation of their Nected account.
