Metadata Query-based Actions Automation
About the automation
Use this automation to write and run advanced SPARQL queries.
Important
This automation is only for advanced users who are trained on using SPARQL queries for automation. You must submit a request with your Customer Success Director to get this automation enabled for your organizations.
Important things to note
The way you write SPARQL queries for this automation is a little different than how you would write the queries from the query editor available in the product from the Project Workspace.
The key differences are:
Unlike the queries created from the query editor, the automations run without any context derived from the UI, so you need to be provide this context with the explicit FROM clause in the query (in most cases FROM :current).
Similarly, all prefixes used in the query must be defined explicitly in the PREFIX statements.
Important
To make sure the SPARQL queries for the automation are created correctly and are working, create a project with no connected dataset and test your queries in that project before adding them to the automation.
Configuring the automation
Important
Only Organization administrators can view, configure, and run automations.
To configure the automation:
On the Organization profile page, go to the Automations tab.
In the Automation templates section, locate the Query-based Actions template. Click the Configure button.
In the Configure Query-based Actions window, on the first screen set the following and click Next.
Automation name: A name for the automation.
Automation description: A brief description.
In the Configure Query-based Actions window, on the next screen add the SPARQL Query and click Next.
On the last screen, set a schedule for the automation. You can set it to run daily, weekly, or monthly at a specific time. Once activated, the automation will execute on the scheduled day and time (within a 30-minute window of the scheduled time). Click Save and continue.
Enabling automations
Once you have finished setting up the automation, the next step is to turn it on. This action will enable the automation to run.
To enable an automation:
On the Organization profile page, go to the Automations tab.
In the Automation section, locate the automation you want to enable and open it by clicking it.
Click the Enable automation button. This option is available only for automations that have never been enabled. If you enable an automation and then disable it, it cannot be enabled again.
Giving the service account access to right resources
When you create the automation and save it, a new service account gets created and shows in the Service accounts list and the Members list on the Organization profile page. By default, the name of the user is the same as the name of the automation.
Before running the automation, make sure you give this user access Edit access to the ddw-catalog dataset.
If the automation is reading input from another dataset, then give View access to that dataset. If the permissions are not set properly, the automation will not work.
Running the automation
Important
Automations with a configured schedule will automatically run at the specified time. However, you can also choose to run them manually if needed.
To run the automation:
On the Organization profile page, go to the Automations tab.
In the Automation section, locate the automation you want to run. Open the Automation details page.
Click the Run button. You also get an option to set a schedule for running the automation.
After the automation is done running, a report is generated and made available in the Project created for the automation.
Viewing the report
To view the automation run report:
On the Organization profile page, go to the Resources tab.
From the Resources tab of the Organization profile page, locate the Project that contains the report for the automation. View the details captured by the automation. Each time the automation runs, it adds a new report to the same project.
Viewing automation run history
Important
If the automation history is missing in the History tab, simply edit and resave the automation. This action triggers a version upgrade for the automation, prompting the system to begin capturing the automation history.
To view the automation run history:
On the Organization profile page, go to the Automations tab.
In the Automations section, from the list of Activated or Archived automations, select the automation for which you want to view the automation history.
On the History tab of the automation, you can view the following details.
Table 1.Item
Details
ID
A unique identifier for the automation run.
Start
Relative time when the automation run was started. For example, 5 minutes ago, 3 months ago, etc. Hover over the field value to see the exact date and time.
Triggered by
Recorded every time the automation runs.
Possible values:
Scheduled: Automation ran on the schedule day and time.
User: A user clicks the Run automation button manually.
Status
The current status of the automation run.
Possible values:
Running: The automation is currently running.
Success: The automation completed successfully.
Error: An error occurred while running the automation.
Editing automations
To edit an automation:
On the Organization profile page, go to the Automations tab.
In the Automations section, from the Activated or Pending Activation tabs, select the automation you want to edit. Note that Archived automations cannot be edited.
Click the Edit Automations button. Follow the wizard to make any necessary adjustments to the automation configuration. The new configurations will take effect the next time the automation runs.
Archiving automations
Important
Once you archive an automation it cannot be enabled again. Only active automations can be archived.
To archive an automation:
On the Organization profile page, go to the Automations tab.
In the Automation section, from the Activated tab, locate the automation you want to archive and open it.
Click the Archive automation link.The archived automation is moved to the Archived tab.
