The Clarizen delete activity available within the Clarizen Connector allows you to delete existing records in a connected Clarizen instance using Jitterbit.
This page describes how to delete existing Clarizen records using an example of deleting an existing task by ID in Clarizen from source data provided in an XML file through Jitterbit. This example deletes the same example file used in the Clarizen Connector Create and Clarizen Connector Update examples.
EXAMPLE: For reference, see the Jitterpak ClarizenExample.jpk and accompanying files in ClarizenSampleFiles.zip . Unzip the ClarizenSampleFiles.zip to your "C:\" drive, or if you unzip to another directory make sure to edit the source and target directories in the operations. If this is your first time using a Jitterpak see Importing a Jitterpak.
This example is used for demonstration purposes only and does not cover all options available in the product; please refer to Design Studio for more comprehensive documentation.
The following sections are divided up into beginning the delete activity, defining the operation components, and deploying and executing the operation.
Creating a Clarizen Delete Operation
- Within your project within Jitterbit Studio, there are several ways to start a new Clarizen delete activity. Each of the following options will start the Clarizen Delete Wizard to guide you through the process.
- Go to File > New > Connectors > New Clarizen Delete.
- In the tree on the left under Connectors, right-click on the Clarizen category, then select New Clarizen Delete.
- In the tree on the left under Connectors, double-click on the Clarizen category, then right-click on Clarizen Delete Activities and select New Clarizen Delete.
- In the top toolbar, click the connector icon (orange jigsaw piece) . In the popup, select Clarizen, then select Clarizen Delete.
- The Endpoint screen of the Clarizen Delete Wizard should open in the main view of Studio. This screen asks to select the endpoint that you would like to delete records from. You should have already set up your endpoint in Clarizen Connector Endpoint. Use the dropdown to select the appropriate endpoint. Click Next when finished.
The Object screen of the Clarizen Delete Wizard asks you to select the object that you would like to delete records from. In this example we want to delete an existing task in Clarizen, so we select the "Task" object, then click Finish to continue.NOTE: If you have a lot of objects available in your Clarizen instance, you may need to wait a moment for them to load. You can also enter an object name into the Filter field. Try the Refresh button if the results are not what you expect.
Jitterbit will then proceed with creating a Clarizen API request and response structure that will allow records to be deleted within your connected Clarizen instance. A new tab should appear in Studio called Clarizen Delete Activities. You can rename your delete activity here if desired; in the example ours is called "Example Clarizen Delete Task." You can also use the + - buttons or arrows to expand all elements within each structure.
- Next, on the same screen, click the button Create Operation located under Use in an Integration in the upper right corner. This will create the Jitterbit operation that will delete the existing task in Clarizen.
A new tab should open in Studio called Operations, containing a graphical representation of the delete activity.NOTE: The icons for Source, Request, Response, and Target in the image above are placeholders for the operation components, which we will define in the next section.
Save your operation by clicking either the single disk icon to save just this operation or the multiple disk icon to save all changes in your integration project. You should see the asterisk on the Operations tab and operation title disappear as your new update activity is now created and saved to your project.
Defining the Operation Components
Next we need to define the other components of the operation that appear within the graphical representation, including Source, Request, Response, and Target.
For each, the instructions below direct you to return to the graphical representation of the operation you have created and double-click each icon to configure each component. As an alternative, you could also create the Source, Request, Response, and Target separately and then drag and drop them from the tree on the left directly onto the icons in the visual representation of your operation.
For purposes of this walkthrough, we provide the following examples for reference above: Jitterpak ClarizenExample.jpk and accompanying files in ClarizenSampleFiles.zip. Many different types of data can be used for each component of the operation. To learn more about additional customization options, refer to the Design Studio section of our documentation.
Source: In the example, we use an XML file as the input request to delete an existing task with the provided ID below. An ID must be included in the source for a delete activity, and can either be the external ID or internal ID (full ID) in the format of /<object_type>/<external_id>.
NOTE: A Clarizen delete activity must use the internal or external ID of the entity within Clarizen in order to associate the delete with the correct object. The Clarizen full internal ID includes the entity name in the format of /<object_type>/<external_id> (e.g. /Task/jw47joqmno25rh7l5azcmo3o26), while the Clarizen external ID will default to the ID only, e.g. jw47joqmno25rh7l5azcmo3o26.NOTE: A variety of source types are available in Jitterbit. See Sources for more.
To use the XML file, first double-click on the Source icon, then click the button Create New Source and give your source a Name (e.g. ClarizenDelete_Task_Request.xml). Next, for this example, we are using a Private Agent with local files enabled, and thus select a Type of "Local File" and then Browse to the location. If you are using the example files, the Folder is 'C:\ClarizenSampleFiles' and the Get Files is 'ClarizenDelete_Task_Request.xml'.
Target: Double-click on the Target icon. In the example, we will output the ID and status to an XML file to make sure the operation was successful. Click the Create New Target button, give your target a Name (e.g. ClarizenDelete_Task_Response.xml), and again select a Type of "Local File" and Browse to a location on the Private Agent where we want to save the data. In the example, the Folder is 'C:\ClarizenSampleFiles' and the Filename is 'ClarizenDelete_Task_Response.xml'.NOTE: You can also output to a variety of different target types. The type does not have to be the same as the source type. See Targets for options.
Request: Double-click on the Request icon and select Create New Transformation. This will open the Transformation Wizard which will walk you through creating the request.NOTE: Additional information on request structures is provided under Transformations.
- On the first screen, Name, provide a Name for your transformation or leave as the default. Then use the Source dropdown to select "Clarizen Function Request." Click Next to continue.
- On the next screen, Source, select the radio button for Delete, then click Next. On the following screen, use the dropdown to select the delete operation (e.g. "Example Clarizen Delete Task"), then click Finish.
The Transformations tab should open where you can complete your mapping. Use the + to expand the source and target items in each tree. Then drag and drop each field you would like to be mapped from one tree to the other. Drag the 'id' field on the input side to the 'id' field on the output side. Your transformation mapping should look similar to that shown below:
Response: Double-click on the Response icon and select Create New Transformation. This will open the Transformation Wizard which will walk you through creating the response.NOTE: Additional information on response structures is provided under Transformations.
- On the first screen, Name, provide a Name for your transformation or leave as the default. Then use the Target dropdown to select "Clarizen Function Response." Click Next to continue.
- On the next screen, Target, select the radio button for Delete, then click Next. On the following screen, use the dropdown to select the delete operation (e.g. "Example Clarizen Delete Task"), then click Finish.
The Transformations tab should open where you can complete your mapping. Use the + to expand the source and target sides. In this example we will create the output response so that it includes the ID, status, and any error messages in the response. Click and drag the "OUTPUT" folder from the left side (source side) to the "OUTPUT" folder on the right side (target side). Your mapping screen should now look similar to that below.
Deploying and Executing the Operation
With the Clarizen update activity fully configured, we are ready to deploy and execute the operation.
- From the Operations tab, click the deploy icon.
- Then click the execute icon to place the operation in the queue for execution.
- In the lower portion of the screen, the Operation monitor should indicate that your operation was run successfully. If not, you can double-click the Status icon to view any log messages.
You should also now see the output response that was mapped to your target file. In the example, the file is now created in 'C:\ClarizenSampleFiles\ClarizenDelete_Task_Response.xml'. Since the operation was run successfully, we see the ID of the task in Clarizen and a status of '1' indicating success.
- In addition, when you check your Clarizen instance, you should find that the deleted task no longer exists.