Bulk Upload and Triggering Ushurs using the .csv File
  • 20 Sep 2024
  • 4 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Bulk Upload and Triggering Ushurs using the .csv File

  • Dark
    Light
  • PDF

Article summary

Ushur provides a convenient tool to create the .csv template.  Using this method helps eliminate errors during creation of the .csv files, especially when there are a large number of columns.

You can upload a maximum of 20 MB files. For a larger file size, we recommend using the SFTP method of file upload.

The bulk upload method addresses the following key information to help manage the triggers:

  • What are the files which are being triggered?

  • Who are the recipients of the file?

  • When are the files triggered?

The bulk upload method ensures that there are checks various levels to avoid automatic triggering of Ushurs and helps monitor and check if you really want to upload the correct files to avoid unnecessary triggering of Ushurs. Do ensure to review the files so that Ushurs are triggered based on a specific time and need.

Prior to uploading the .csv files for triggering the Ushurs, ensure to create the trigger variables.

Note

Trigger variable is a type of variable defined by citizen developers within the Ushur platform that determines the conditions for triggering an engagement.

  1. Login to your account, create and activate an Ushur.

  2. Go to the Variables tab on the Dashboard.

  3. Create the following variables:

    1. PrimaryKey of type uid_sendPrimaryKeyId

    2. TiggerValue of type uid_triggersend

    3. UshurName of type uid_ushurname

    4. Date of type uid_senddate (optional)

      1. If this variable is not created, then Ushurs will be triggered immediately.

      2. Use this field only to schedule Ushurs at a future date.

      3. The values should be provided in “MM/DD/YYYY HH:MM AM/PM” format only.

    5. PhoneNumber of type uid_sendPhoneNo (optional).

  4. On the left side, tick the checkbox against PrimaryKey and click Update Keys.

  5. From the Meta Data tab, click on Example Files, open and edit the downloaded CSV file and save it with the following data.
    Date,PrimaryKey,TriggerValue,UshurName,PhoneNumber
    03/29/2021 09:15 AM,1,yes,TestMetadata,+91<ph_no>

  6. Drag and drop the .csv file on to the Bulk Upload space. Alternatively, click anywhere in the Bulk Upload space and select the file manually. When editing .csv files, we recommend to use a plain text editor instead of Excel to avoid occasional changes in the field formats. 

  7. Click on the Example files and select .csv to refer to a template.

  8. Drag and drop the .csv file in the Bulk Upload pane.

    1. You should see “Contains Triggers=Yes” on this pop-up only if the uploaded file contains the mandatory trigger variables

    2. Click Confirm after you have ensured to upload the correct file. If the upload file contains triggers, it will be displayed in the confirmation dialog box.

  9. The file will be uploaded with this message:

  10. Click the Upload History and view files and its related information.

Analyzing the Upload History of the Meta Data

The Upload History panel, provides detailed information on the bulk files that are uploaded to help view, analyze and take necessary actions.

  1. Access Upload History Panel
    Navigate to the Upload History panel to access detailed information on bulk file uploads.

  2. View Upload History

    1. Click the View Upload History button to open a dialog box displaying the upload history information.

    2. This panel allows you to view and analyze the details of the uploaded files and take any necessary actions based on the provided information.

  3. Entries Displayed

    1. You can view a maximum of 25 entries in the upload history at one time.

  4. Refresh Data

    1. To ensure that the most recent data is displayed, click the Refresh button. This will fetch the latest information available for upload history.

  5. Filter by Date Range

    1. To view upload history for a specific date range, use the Calendar Icon.

    2. Select the desired date range to filter the upload history accordingly.

  6. Toggle Between Upload Sources

    1. You can toggle between viewing the history of UI uploads or SFTP uploads.

    2. Use the toggle option to switch between these two sources of uploads as needed.

  7. The Delete option is provided as an option to terminate the launch of the triggers in the uploaded file. You can click this if you wish to stall the triggers.

  8. The Upload History panel displays the following information that you can analyze:

    • Filename - The name of the uploaded file in the .csv file format

    • Time stamp - The time at which the file was uploaded.

    • File Upload Status - Displays the status of the file upload.

      • Launch to Save - Click this to launch and trigger the Ushurs.

      • Completed - The triggers have been successfully launched and completed.

      • Errors - Indicates that there were some errors that occurred during the trigger.

    • Records - Indicates the total number of records that were parsed in the uploaded file.

    • Success - Indicates that all the records were successfully parsed.

    • Errors - Indicates format errors in the uploaded file.

    • Triggered Status - Indicates if the triggers was launched or not.

    • Initiated - The number of Ushurs launched from these records based on the Ushur Trigger specification.

    • Scheduled - The number of Ushurs that are executed from these records.

    • Reports - Provides and an option to download and review the error reports

  9. Click Launch to Save to trigger the Ushur and click Launch in the following dialog box.

  10. Once the triggers are launched and completed, you can click the Download drop-down to view specific information about the files and errors such as such as invalid entry or empty entries in the uploaded file.

  11. You can download the Reports Error log of these records and it will be saved by default as a .xls file. A sample error log will look like this:


Was this article helpful?