Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Department

IT Development

Purpose

Explain how you can create automated reports by applying all the parameters and filters to receive the report when you want.
At the moment only can be applied to commissions and orders.

Estimated Time

5 minutes

The Estimated time can be in m,h,d (Minutes, Hours, Days)

Introduction & Previous Concepts

An automated report helps the user to create recurring reports by adding custom filters, the period, and the date that you want that be executed.

To create new automated reports, you have to add orders or commissions so you can read the documentation to generate orders and configure the commissions.

Procedure

  1. When you want to add a new automated report, you have to go to the commission's dashboards or the orders page to select the button with the filter icon.

  2. You have to add your custom filters and click on the icon with 3 dots and select “the create automated reports” option and it will open a drawer like this:

    1. In this drawer, we can see the fields that are necessary to create an automated report.

      1. *Alias: Name or title of the automated report.

      2. *Period: Range of dates that the report will take to be executed.

        1. The available options are:

          1. Last seven days

          2. Last fourteen days

          3. Last thirty days

          4. Last week

          5. Last two weeks

          6. Last three weeks

          7. Last month

          8. Last two months

          9. Last three months

          10. Last quarterly

          11. Last half of the month

          12. Custom Period: When you select this option, then you can set up a custom period days and a custom period type. There are two validations to it: If you select the week type, then the number of weeks can not be more than thirteen. On the other hand, if you select the day type, then the number of days can not be more than ninety.
            Note: You can not add more than ninety days or thirteen weeks.

      3. *Repeat: This field indicates how often the automated report will be executed.

        1. The available options are:

          1. Daily

          2. Every seven days

          3. Every fourteen days

          4. Every twenty-one days

          5. Every thirty days

          6. Weekly

          7. Every two weeks

          8. Every three weeks

          9. Every half of the month: When you select this option, then you can set up how many days after the half of the month will the automated report be executed.

          10. Monthly

          11. Every two months

          12. Every Quarterly

          13. Custom repeat: When you select this option, then you can set up a custom period days and a custom period type.

      4. *Start On and time delivery range: This field indicates when the report will be executed for the first time(date and time).
        Note: All fields marked with an “*” are mandatory

  3. When you finish setting up all parameters, you will be able to see in the “examples” section an example of the next four times they will be executed and the date ranges they will be applied.

  4. To create a new automated report, you can click the green save button.

Automated Reports section.

To see all automated reports created for you, go to the “automated reports“ section, Here you will be able to see a list of the all records. If you have the “manage all automated reports” permission you will be able to see other users' records.

If you have the “manage all automated report” permission you will see two available filters:

  1. Search by user: it will search all the reports created by the user you type.

  2. See only my automated reports: it will search all the reports created by you.

  3. Report type: it will search by report type. Those could be commissions or orders.

On the other hand, if you do not have the permissions, then, only the following filter will appear:

  1. Report type: it will search by report type. Those could be “commissions“ or “orders”.

The reporting table looks like this:

  1. User: The person who creates the automated report.

  2. Alias: The name of the automated report.

  3. Type: Commissions or orders.

  4. Period: Range of dates that the report will take to be executed

  5. Repeat: Indicates how often the automated report will be executed

  6. Schedule at: The next date it will be executed.

  7. Executions: How many executions there are.

  8. Created at: The date it has been created.

You will see the following options:

  1. View generated reports (If you have executions).

  2. Delete automated reports.

Best Result

Worst Result

Links & Resources

  • No labels