Idomoo's App for Salesforce has many technical aspects that are important to understand in order to create a smooth experience.


Idomoo PV Projects

Idomoo PV Projects hold all the information needed to be able to generate videos with Salesforce data. These records hold information about the Idomoo project that needs to be used, how to map fields needed for the video, and what media to output.
The following notes help demistify some of these settings:

  • Data Points: An Idomoo project is called a storyboard. When you select a storyboard during the project setup stage, the app learns which data points are needed. You can then map the fields from Salesforce to the storyboard. However, it's important to note that only Contact object fields can be used directly. You can workaround this limitation by copying other data points to the Contact objects before rendering or by using merge field magic on the Parameters Mapping field of the Idomoo PV Project record, to access a limited set of data beyond the Contact object.
  • Output Settings: By default the following media is generated: An HLS video & a JPG. In the Idomoo PV Project setup you can also choose a landing page. However, if you want to generate different types of media, such as GIF, captions or transcripts, watermarked videos or images, you can do that using Output Configurations (Output Config, for short). Read more about Output Config here. You can use the JSON body attached to this article as a starting point to build your output config from.
    Using Output Config automatically disables the landing page drop-down menu, as the landing page becomes part of the configuration.
  • What Media: If you're not sure what media you are about to generate, you can always look at the Idomoo PV Project record's Output Details section and see how many of each type of media is going to be created.


Campaigns

Campaigns, which manage contacts for media generation, have been enhanced with new fields under the Idomoo PV Project section of the campaign details page. Here's a list of them with explanations:

  • Idomoo PV Project: The name of the last Idomoo PV Project used to generate videos in this campaign.
  • Statistics ID: This should be the same as your campaign ID. It helps see the relevant statistics in Idomoo's Analytics.
  • Total Records: The amount of campaign members in the campaign.
  • Successful Requests: the amount of campaign members that already have media generated for them. This changes as media is generated.
  • Failed Requests: The number of campaign members for whom media generation was attempted but failed. You can drill down into each campaign member to understand the specific reason for the failure.
  • Total Requests: This field tracks the total number of media generation requests initiated using this campaign. Clicking "Generate Videos" triggers media generation for all campaign members, even ones that already had media generated for them, ensuring any updates to the storyboard or Idomoo PV project are reflected.


API burst rates and Idomoo concurrency limits both impact API request success. While Salesforce controls burst rates, exceeding Idomoo's concurrency limits for your account can lead to blockage. To ensure smooth operation, the number of campaign members you can include before clicking "Generate Videos" is limited to your concurrency limit. If your campaign has more members, only the first batch matching the limit will be processed. By default, the concurrency limit is set to 10 per minute, though it can be increased significantly. Contact Idomoo support for further assistance.


Campaign Members

Campaign member records hold the output of the video generation process. Here are some considerations:

  • Not all fields are filled. This is because not all media is requested on each Idomoo PV project. Moreover, some media is not recorded, as by using ouput configs you can end up with any number of different kinds of media. The rule to remember is this:
    The root of the filename is always the same. The only things that change are any suffixes used and the file extension.
    MP4 files have an .mp4 extension. HLS files have an .m3u8 extension. GIFs and JPGs have a .gif and .jpg extensions respectively. If your output config holds suffixes, note what these are and add them before the extension after an underscore.


Apex Class

The Idomoo Apex Class is the best way to generate videos as it turns your project into an automated, business as usual, controlled flow.

The automation can control the trigger of the whole process, which contact records become campaign members, and what to do with the generated media links after generation occured.

Automatically adding contacts to a campaign triggers media generation only for those new contacts, unlike manually clicking "Generate Videos" which processes the entire list. This allows you to efficiently generate media for a larger number of campaign members over time with greater ease.