Note: You can only add macros if you are an admin user.

Macro bars are unique for each stage of a document. So, first open an existing document on the stage (status) where you want the button to appear. 

For example if you want to provide a "Send" button for an estimate when it is marked as "draft" navigate to the daft stage of the estimate board. 

You will need to open a document in order to add the macro button. So in this example, if you don't have any draft estimates you will need to create one in-order to complete the Tutorial. (It's important to note you need to open a document on the precise stage where you want the button to show.)

Once you have your estimate open hover over the macro tool bar at the top of the window and click the edit button.

This switches the bar into edit mode

Click on the add macro button, this opens the macro button editor.

First design your button

  1. Select an icon from the drop-down (optional).
  2. Enter some text for your button name.
  3. Select the color of your button from the drop-down.

Note: As you set the options from your button a 'preview' updates in the left column.

Set the access rights for your button

You can give all your team to access to your button, or just your admin users. Checking this box will hide the button from agents and technicians.

You can learn more about user roles in Tudodesk here.

Select a command (optional)

The command menu has more that 5 in-built automated functions, including automation's into third-party API's such as Vend POS and Print Node:

  1. Send a canned email.
    If you select this option you can choose a pre-defined canned email from the selection list. This will send the defined email to the customer of the document. Any template tags will be inserted from the underlying document.
  2. Create a task. If you select this option you can enter a title for your task and select who the task is assigned to. If you use auto assignment the task is assigned to the agent running the macro.
  3. Send a canned SMS. If you select this option, have SMS enabled on your account, and the customer has a mobile phone number on their account. This will send a canned SMS text message. Any template tags will be inserted from the underlying document.
  4. Silent print Ticket (Star WEBPRNT). This option requires an installed Star (WEBPRNT compatible) printer and the IP address configured under settings. This will trigger automatic printing of the underlying document to the receipt printer. For set-up instructions read this article:
  5. Integrations API. This option will trigger third-party integrations such as sending tickets to Vend POS and automatic printing of documents to any printer using Print Node. Please read the following articles for help:

Update the document status(optional)

You can automatically set the status of the current (source) document by selecting any of the allowed status's from the drop-down list. Note you can not mark a document as draft or paid.

Assign an agent to the source document

Sometimes you need to re-assign documents at certain times of your workflow for example you might want to assign all new estimates to your sales person. You can do this with the assign command.

You can choose to assign a specific agent or auto assign the acting agent who runs the macro (the session user).

Change the source document archive status

Setting archive policies (closing of documents) is an important aspect of managing your paper-work. When a document is finished with, it's good practice to archive it. You can automatically set the archive status of the source document using this option.

You can learn more about archiving here

Create a new document (Copy the source).

One of the more powerful functions of a macro is it's ability to automate the creation of new documents. Tasks such as sending an invoice after an estimate has been accepted can be rolled into a single button click. You can also mark the document as archived helping you "enforce" well designed processes that not only get the job done quickly, but do all the tidying up at the same time. This removes all the process
from your agents and rolls it into one single process.

Setting the type of document you want to create:

Select the board (document) you want to create from the drop-down.

The copy function has a number of options.

  1. Open the document create dialog in copy mode.
    This options places the most control in the hands of the acting agent as it opens the document create view and allows the agent to edit the details before the document is created. It even allows the agent to cancel the operation.
  2. Open in edit mode (most poplar)
    This creates the document as a direct copy of the source document but opens the document in edit mode into view so the acting agent can edit it in "draft mode"
  3. Auto status set
    This allows you to set the status of the document after it is created and is useful as you can mark a document as "sent". This options should be used with caution since it allows no agent intervention and can fire automated events such as document sends. Sending invoices that are direct copies of estimates, queuing jobs, sending shipping notes and review requests are some of the best use cases for this option.

Publish your macro

Once you are happy with your macro settings click the publish button to save the macro and embed it into your document macro bar for other agents to use.


It's advisable to create at least one test document to test your macro and the observe the results.

Did this answer your question?