MicroStrategy ONE

Creating and Managing Transmitters

A transmitter is a MicroStrategy software component that Distribution Services uses to package subscribed reports and documents into files or emails, and send those files or emails to recipients.

Distribution Services comes with multiple types of transmitters: email (SMTP), file, print, FTP, and mobile. For example, a file transmitter packages and delivers reports in the form of files (PDF, HTML, MS Excel, plain text, and CSV formats) to file storage locations on network computers. A print transmitter sends reports to network printers for printing.

When a user subscribes to a MicroStrategy report, the report is sent to the appropriate transmitter for packaging and delivery. For example, if the report is to be delivered to a file location on a network computer, the report is sent to a file transmitter for conversion to the appropriate file format for delivery. Similarly, if the report is to be delivered in the form of an email to a user's email address, the report is sent to an email transmitter for appropriate packaging and delivery.

A transmitter uses the settings specified in devices to determine how reports are packaged and delivered to the required delivery location. For example, some devices may indicate that reports should be packaged using MIME encoding, but others might specify UUEncoding. For information on devices and their settings, see Creating and Managing Devices.

Notification for transmission failures can be configured for email transmitters as described below. Notification for file and print transmission failures can be configured at the project level, using the Project Configuration Editor.

You create and configure transmitters using the Transmitter Editor.

Recommended Maintenance Tasks for Transmitters

Periodically verify all email addresses where delivery success or failure notification emails are being sent. You can see these email addresses in the Transmitter Editor, on the Notification tab.

Best Practices for Working with Transmitters

  • Configure a device to use each type of transmitter and test a delivery using the devices to make sure the transmitters are effective and the devices are working.
  • You can easily test an email transmitter by using the Save to File check box on the Email Transmitter Editor's Message Output tab.
  • To quickly create a new transmitter, duplicate an existing transmitter (such as an out-of-the-box transmitter provided by MicroStrategy), and then change its settings as required.

Viewing and Modifying a Transmitter and Accessing the Transmitter Editor

Using the Transmitter Editor, you can view and modify the definition of a transmitter, rename the transmitter, duplicate the transmitter, and so on.

To View a Transmitter or Modify its Settings

  1. From the Developer Folder List, expand Administration, expand Delivery Managers, and select Transmitters.
  2. In the Transmitter List area on the right, right-click the transmitter that you want to view or change settings for.
  3. Select Edit.
  4. Change the transmitter settings as desired.
  5. Click OK.

Creating a Transmitter

In Developer, you can create the following types of transmitters:

  • Email: An email transmitter transforms a subscribed report or document and attaches it to an email and sends the email to the inbox of the recipient.
  • File: A file transmitter transforms a subscribed report or document into a file (PDF, HTML, Microsoft Excel, plain text, or CSV format) and sends the file to a file storage location such as a folder on a network computer.
  • Print: A print transmitter sends the subscribed report or document to a network printer.
  • FTP: An FTP transmitter sends the subscribed report or document to an FTP server.
  • Mobile: An iPad or iPhone transmitter sends the subscribed report or document to a user's iPad or iPhone.

When a user subscribes to a MicroStrategy report, the report is sent to the appropriate transmitter for packaging and delivery. For example, if the report is to be delivered to a file location on a computer, the report is sent to a file transmitter for packaging and delivery. Similarly, if the report is to be delivered in the form of an email to an email recipient, the report is sent to an email transmitter for packaging and delivery.

You create new transmitters when you need a specific combination of properties and settings for a file, email, print, FTP, or mobile transmitter to package files.

A quick way to create a new transmitter is to duplicate an existing transmitter and then edit its settings to meet the needs for the new transmitter. This is a time-saving method if a similar transmitter already exists, or you want to duplicate the default MicroStrategy transmitter. To duplicate a transmitter, right-click the transmitter that you want to duplicate and select Duplicate.

You create and configure transmitters using the Transmitter Editor.

Creating an Email Transmitter

An email transmitter creates an email and transforms the subscribed report or document into an attachment to the email, then sends the email to the inbox of the recipients who subscribed to the file.

Once an email transmitter is created, you can create email devices that are based on that transmitter. When you create a device, the transmitter appears in the list of existing transmitters in the Select Device Type dialog box. The settings you specified above for the email transmitter apply to all email devices that will be based on the transmitter.

To Create an Email Transmitter

  1. From the Developer Folder List, expand Administration, expand Delivery Managers, and select Transmitters.
  2. Right-click in the Transmitter List area on the right, select New, and select Transmitter.
  3. Select Email and click OK.
  4. Change the transmitter settings as desired.
  5. Click OK.

Creating a File Transmitter

A file transmitter transforms a subscribed report or document into a file format that the user chooses while subscribing to the report or document. The file transmitter then sends the file to a file storage location on a network computer.

Once a file transmitter is created, you can create file devices that are based on this transmitter. When you create a device, the transmitter appears in the list of existing transmitters in the Select Device Type dialog box. The settings you specified above for the file transmitter apply to all file devices that will be based on the transmitter.

For information on creating a file device, see Creating and Managing Devices.

To Create a File Transmitter

  1. From the Developer Folder List, expand Administration, expand Delivery Managers, and select Transmitters.
  2. Right-click in the Transmitter List area on the right, select New, then select Transmitter.
  3. Select File and click OK.
  4. Change the transmitter settings as desired.
  5. Click OK.

Creating a Print Transmitter

A print transmitter sends the subscribed report or document to a network printer.

Once a print transmitter is created, you can create print devices that are based on the transmitter. When you create a device, the transmitter appears in the list of existing transmitters in the Select Device Type dialog box. The settings you specified above for the print transmitter apply to all print devices that are based on the transmitter.

For information on creating a print device, see Creating and Managing Devices.

To Create a Print Transmitter

  1. From the Developer Folder List, expand Administration, expand Delivery Managers, and select Transmitters.
  2. Right-click in the Transmitter List area on the right, select New, and select Transmitter.
  3. Select Print and click OK.
  4. Change the transmitter settings as desired.
  5. Click OK.

Creating an FTP Transmitter

An FTP transmitter transforms a subscribed report or document into a file format that the user chooses while subscribing to the report or document. The FTP transmitter then sends the file to a location on an FTP server.

Once an FTP transmitter is created, you can create FTP devices that are based on the transmitter. When you create a device, the transmitter appears in the list of existing transmitters in the Select Device Type dialog box. The settings you specified above for the FTP transmitter apply to all FTP devices that will be based on the transmitter.

For information on creating an FTP device, see Creating and Managing Devices.

To Create an FTP Transmitter

  1. From the Developer Folder List, expand Administration, expand Delivery Managers, and select Transmitters.
  2. Right-click in the Transmitter List area on the right, select New, then select Transmitter.
  3. Select FTP and click OK.
  4. Change the transmitter settings as desired.
  5. Click OK.

Creating an iPad Transmitter

An iPad transmitter is used to push real-time updates of reports or documents to a user's iPad. The transmitter transforms the subscribed report or document into a form that can be displayed on the iPad, then it sends the report or document to the subscriber's iPad.

After an iPad subscription transmitter is created, you can create iPad delivery devices that are based on the transmitter. When you create a device, the transmitter appears in the list of existing transmitters in the Select Device Type dialog box.

For information on creating an iPad device, see Creating and Managing Devices.

To Create a iPad Subscription Transmitter

  1. From the Developer Folder List, expand Administration, expand Delivery Managers, and select Transmitters.
  2. Right-click in the Transmitter List area on the right, select New, and then Transmitter.
  3. Select iPad Push Notifications and click OK.
  4. Specify a name and description for the transmitter. The description should include information about settings for this transmitter to help users distinguish it from other transmitters, so they know when to choose this transmitter when associating devices with it.
  5. Click OK.

Creating an iPhone Transmitter

An iPhone transmitter is used to push real-time updates of reports or documents to a user's iPhone. The transmitter transforms the subscribed report or document into a form that can be displayed on the iPhone, then sends the report or document to the subscriber's iPhone.

After an iPhone transmitter is created, you can create iPhone delivery devices that are based on the transmitter. When you create a device, the transmitter appears in the list of existing transmitters in the Select Device Type dialog box.

For information on creating an iPhone device, see Creating and Managing Devices.

To Create a iPad Subscription Transmitter

  1. From the Developer Folder List, go to Administration > Delivery Managers > Transmitters.
  2. Right-click in the Transmitter List area on the right, select New, and then Transmitter.
  3. Select iPhone Push Notifications and click OK.
  4. Specify a name and description for the transmitter. The description should include information about settings for this transmitter to help users distinguish it from other transmitters, so they know when to choose this transmitter when associating devices with it.
  5. Click OK.

Deleting a Transmitter

You can delete a transmitter if you no longer need to use it.

You cannot delete a transmitter if devices depend on the transmitter. You must first delete any devices that depend on the transmitter.

To Delete a Transmitter

  1. From the Developer Folder List, expand Administration, expand Delivery Managers, and select Transmitters.
  2. In the Transmitter List area on the right, right-click the transmitter that you want to delete.
  3. Select Delete. The Confirm Delete Object message is displayed. See the prerequisite above to be sure you have properly prepared the system to allow the transmitter to be deleted.
  4. Click Yes.