Addin installation failed after updating with code for mobile integration

[DunhamGitHub]

How to debug not being able to load Outlook Addin with mobile code (desktop version can be added)? I do not see any feedback in the Console!?

---

Sideloading my (demo) DESKTOP .xml Manifest works, after updating it for MOBILE it does not! (Manifest files attached as reference)

outlook-manifest_mobile.zip

I have updated it with the snipped from: https://github.com/OfficeDev/office-js-docs-pr/blob/main/docs/outlook/add-mobile-support.md.

When I am trying to add it (in Outlook Web) I get an error,

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OfficeApp
  xmlns="http://schemas.microsoft.com/office/appforoffice/1.1"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:bt="http://schemas.microsoft.com/office/officeappbasictypes/1.0"
  xmlns:mailappor="http://schemas.microsoft.com/office/mailappversionoverrides/1.0"
  xsi:type="MailApp">
    <Id>ed1c6f1c-d94f-4aa3-8032-0df4f0736201</Id>
    <Version>2023.11.27.21</Version>
    <ProviderName>Digital WorkMate DWM</ProviderName>
    <DefaultLocale>en-US</DefaultLocale>
    <DisplayName DefaultValue="Digital WorkMate DWM"/>
    <Description DefaultValue="Boost your productivity"/>
    <IconUrl DefaultValue="https://www.digitalworkmate.com/icons/icon-160.png"/>
    <HighResolutionIconUrl DefaultValue="https://www.digitalworkmate.com/icons/icon-512.png"/>
    <SupportUrl DefaultValue="https://www.digitalworkmate.info"/>
    <AppDomains>
        <AppDomain>www.digitalworkmate.com</AppDomain>
    </AppDomains>
    <Hosts>
        <Host Name="Mailbox"/>
    </Hosts>
    <Requirements>
        <Sets>
            <Set Name="Mailbox" MinVersion="1.1"/>
        </Sets>
    </Requirements>
    <FormSettings>
        <Form xsi:type="ItemRead">
            <DesktopSettings>
                <SourceLocation DefaultValue="https://www.digitalworkmate.com/outlook/index.html"/>
                <RequestedHeight>450</RequestedHeight>
            </DesktopSettings>
        </Form>
    </FormSettings>
    <Permissions>ReadWriteItem</Permissions>
    <Rule xsi:type="RuleCollection" Mode="Or">
        <Rule xsi:type="ItemIs" ItemType="Message" FormType="Read"/>
    </Rule>
    <DisableEntityHighlighting>false</DisableEntityHighlighting>
    <VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides" xsi:type="VersionOverridesV1_0">
        <Requirements>
            <bt:Sets DefaultMinVersion="1.3">
                <bt:Set Name="Mailbox"/>
            </bt:Sets>
        </Requirements>
        <Hosts>
            <Host xsi:type="MailHost">
                <DesktopFormFactor>
                    <FunctionFile resid="Commands.Url"/>
                    <ExtensionPoint xsi:type="MessageReadCommandSurface">
                        <OfficeTab id="TabDefault">
                            <Group id="msgReadGroup">
                                <Label resid="GroupLabel"/>
                                <Control xsi:type="Button" id="msgReadCreateSO">
                                    <Label resid="ButtonCreateSO.Label"/>
                                    <Supertip>
                                        <Title resid="ButtonCreateSO.Label"/>
                                        <Description resid="ButtonCreateSO.Tooltip"/>
                                    </Supertip>
                                    <Icon>
                                        <bt:Image size="16" resid="Icon16"/>
                                        <bt:Image size="32" resid="Icon32"/>
                                        <bt:Image size="80" resid="Icon80"/>
                                    </Icon>
                                    <Action xsi:type="ShowTaskpane">
                                        <SourceLocation resid="ButtonCreateSO.Url"/>
                                    </Action>
                                </Control>
                            </Group>
                        </OfficeTab>
                    </ExtensionPoint>
                </DesktopFormFactor>
                <MobileFormFactor> 
					<ExtensionPoint xsi:type="MobileMessageReadCommandSurface">
						<Group id="mobileMsgRead">
							<Label resid="ButtonCreateSO" />
							<Control xsi:type="MobileButton" id="msgReadCreateSO">
								<Label resid="ButtonCreateSO.Label" />
								<Icon xsi:type="bt:MobileIconList">
									<bt:Image size="25" scale="1" resid="ribon-icon-25" />
									<bt:Image size="25" scale="2" resid="ribon-icon-25" />
									<bt:Image size="25" scale="3" resid="ribon-icon-25" />
				
									<bt:Image size="32" scale="1" resid="ribon-icon-32" />
									<bt:Image size="32" scale="2" resid="ribon-icon-32" />
									<bt:Image size="32" scale="3" resid="ribon-icon-32" />
				
									<bt:Image size="48" scale="1" resid="ribon-icon-48" />
									<bt:Image size="48" scale="2" resid="ribon-icon-48" />
									<bt:Image size="48" scale="3" resid="ribon-icon-48" />
								</Icon>
								<Action xsi:type="ShowTaskpane">
									<SourceLocation resid="readTaskPaneUrlMobile" />
								</Action>
							</Control>
						</Group>
					</ExtensionPoint>
				</MobileFormFactor>
            </Host>
        </Hosts>
        <Resources>
            <bt:Images>
                <bt:Image id="Icon16" DefaultValue="https://www.digitalworkmate.com/icons/icon-16.png"/>
                <bt:Image id="Icon32" DefaultValue="https://www.digitalworkmate.com/icons/icon-32.png"/>
                <bt:Image id="Icon80" DefaultValue="https://www.digitalworkmate.com/icons/icon-80.png"/>
                <bt:Image id="Icon160" DefaultValue="https://www.digitalworkmate.com/icons/icon-160.png"/>
                <bt:Image id="Icon512" DefaultValue="https://www.digitalworkmate.com/icons/icon-512.png"/>
                <bt:Image id="ribon-icon-25" DefaultValue="https://www.digitalworkmate.com/icons/icon-512.png"/>
                <bt:Image id="ribon-icon-32" DefaultValue="https://www.digitalworkmate.com/icons/icon-512.png"/>
                <bt:Image id="ribon-icon-48" DefaultValue="https://www.digitalworkmate.com/icons/icon-512.png"/>
            </bt:Images>
            <bt:Urls>
                <bt:Url id="ButtonCreateSO.Url" DefaultValue="https://www.digitalworkmate.com/Outlook/EMail.Info"/>
            </bt:Urls>
            <bt:ShortStrings>
                <bt:String id="GroupLabel" DefaultValue="Digital WorkMate"/>
                <bt:String id="ButtonCreateSO.Label" DefaultValue="Import E-mail"/>
            </bt:ShortStrings>
            <bt:LongStrings>
                <bt:String id="ButtonCreateSO.Tooltip" DefaultValue="Create a sales order from e-mail"/>
            </bt:LongStrings>
        </Resources>
    </VersionOverrides>
</OfficeApp>

How to determine the reason for failure?

[AlexJerabek]

Hi @DunhamGitHub,

Thanks for reporting this. @samantharamon could you please help investigate?

[samantharamon]

Hi @DunhamGitHub,

Thank you for reaching out. Your add-in's manifest needs to specify the VersionOverrides 1.1 element to use <MobileFormFactor>. While it's mentioned in Add support for add-in commands in Outlook on mobile devices, I understand that it isn't immediately obvious in the code snippet, so I created PR OfficeDev/office-js-docs-pr#5014 to clarify this. Here's an updated version of your snippet.

<VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides" xsi:type="VersionOverridesV1_0">     
    <VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides/1.1" xsi:type="VersionOverridesV1_1">
        ...
        <MobileFormFactor> 
            <ExtensionPoint xsi:type="MobileMessageReadCommandSurface">
                <Group id="mobileMsgRead">
                    <Label resid="GroupLabel" /> <!-- I updated this to match the label ID in the Resources section. -->
                    <Control xsi:type="MobileButton" id="msgReadCreateSO">
                        <Label resid="ButtonCreateSO.Label" />
                        <Icon xsi:type="bt:MobileIconList">
      	                    <bt:Image size="25" scale="1" resid="ribon-icon-25" />
                            <bt:Image size="25" scale="2" resid="ribon-icon-25" />
      	                    <bt:Image size="25" scale="3" resid="ribon-icon-25" />

	                    <bt:Image size="32" scale="1" resid="ribon-icon-32" />
 	                    <bt:Image size="32" scale="2" resid="ribon-icon-32" />
	                    <bt:Image size="32" scale="3" resid="ribon-icon-32" />

	                    <bt:Image size="48" scale="1" resid="ribon-icon-48" />
	                    <bt:Image size="48" scale="2" resid="ribon-icon-48" />
	                    <bt:Image size="48" scale="3" resid="ribon-icon-48" />
                        </Icon>
                        <Action xsi:type="ShowTaskpane">
 	                    <SourceLocation resid="readTaskPaneUrlMobile" />
                        </Action>
                    </Control>
                </Group>
            </ExtensionPoint>
        </MobileFormFactor>
        ...
    </VersionOverrides>
</VersionOverrides>

I also noted that the resid value of the group label in the <MobileFormFactor> element isn't defined in the <Resources> section. Updating the value to GroupLabel (or a new string of your choosing) should do the trick.

Let me know if you still continue to run into issues when sideloading.

[DunhamGitHub]

Thank you for your reply. I have made the changes. I get "failed" as return.

a) Am I correct in assuming that there is 0 feedback as to why the addin installation fails? (Also not in the Console)

b) In your example code you put <VersionOverridesV1_0"><VersionOverridesV1_1">. So VersionOverrides 1_1 is a child of 1_0?

c) Updates .xml below (I have the <VersionOverrides 1_0 /><VersionOverridesV1_1 /> on the same level):

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<OfficeApp
  xmlns="http://schemas.microsoft.com/office/appforoffice/1.1"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:bt="http://schemas.microsoft.com/office/officeappbasictypes/1.0"
  xmlns:mailappor="http://schemas.microsoft.com/office/mailappversionoverrides/1.0"
  xsi:type="MailApp">
    <Id>ed1c6f1c-d94f-4aa3-8032-0df4f0736201</Id>
    <Version>2023.11.27.21</Version>
    <ProviderName>Digital WorkMate DWM</ProviderName>
    <DefaultLocale>en-US</DefaultLocale>
    <DisplayName DefaultValue="Digital WorkMate DWM"/>
    <Description DefaultValue="Boost your productivity"/>
    <IconUrl DefaultValue="https://www.digitalworkmate.com/icons/icon-160.png"/>
    <HighResolutionIconUrl DefaultValue="https://www.digitalworkmate.com/icons/icon-512.png"/>
    <SupportUrl DefaultValue="https://www.digitalworkmate.info"/>
    <AppDomains>
        <AppDomain>www.digitalworkmate.com</AppDomain>
    </AppDomains>
    <Hosts>
        <Host Name="Mailbox"/>
    </Hosts>
    <Requirements>
        <Sets>
            <Set Name="Mailbox" MinVersion="1.1"/>
        </Sets>
    </Requirements>
    <FormSettings>
        <Form xsi:type="ItemRead">
            <DesktopSettings>
                <SourceLocation DefaultValue="https://www.digitalworkmate.com/outlook/index.html"/>
                <RequestedHeight>450</RequestedHeight>
            </DesktopSettings>
        </Form>
    </FormSettings>
    <Permissions>ReadWriteItem</Permissions>
    <Rule xsi:type="RuleCollection" Mode="Or">
        <Rule xsi:type="ItemIs" ItemType="Message" FormType="Read"/>
    </Rule>
    <DisableEntityHighlighting>false</DisableEntityHighlighting>
    <VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides" xsi:type="VersionOverridesV1_0">
        <Requirements>
            <bt:Sets DefaultMinVersion="1.3">
                <bt:Set Name="Mailbox"/>
            </bt:Sets>
        </Requirements>
        <Hosts>
            <Host xsi:type="MailHost">
				<DesktopFormFactor>
					<FunctionFile resid="Commands.Url"/>
					<ExtensionPoint xsi:type="MessageReadCommandSurface">
						<OfficeTab id="TabDefault">
							<Group id="msgReadGroup">
								<Label resid="GroupLabel"/>
								<Control xsi:type="Button" id="msgReadCreateSO">
									<Label resid="ButtonCreateSO.Label"/>
									<Supertip>
										<Title resid="ButtonCreateSO.Label"/>
										<Description resid="ButtonCreateSO.Tooltip"/>
									</Supertip>
									<Icon>
										<bt:Image size="16" resid="Icon"/>
										<bt:Image size="32" resid="Icon"/>
										<bt:Image size="80" resid="Icon"/>
									</Icon>
									<Action xsi:type="ShowTaskpane">
										<SourceLocation resid="ButtonCreateSO.Url"/>
									</Action>
								</Control>
							</Group>
						</OfficeTab>
					</ExtensionPoint>
				</DesktopFormFactor>
            </Host>
        </Hosts>
        <Resources>
            <bt:Images>
				<bt:Image id="Icon" DefaultValue="https://www.digitalworkmate.com/icons/icon-512.png"/>
            </bt:Images>
            <bt:Urls>
                <bt:Url id="ButtonCreateSO.Url" DefaultValue="https://www.digitalworkmate.com/Outlook/EMail.Info"/>
            </bt:Urls>
            <bt:ShortStrings>
                <bt:String id="GroupLabel" DefaultValue="Digital WorkMate"/>
                <bt:String id="ButtonCreateSO.Label" DefaultValue="Import E-mail"/>
            </bt:ShortStrings>
            <bt:LongStrings>
                <bt:String id="ButtonCreateSO.Tooltip" DefaultValue="Create a sales order from e-mail"/>
            </bt:LongStrings>
        </Resources>
    </VersionOverrides>
    <VersionOverrides xmlns="http://schemas.microsoft.com/office/mailappversionoverrides/1.1" xsi:type="VersionOverridesV1_1">
		<Requirements>
			<bt:Sets DefaultMinVersion="1.3">
				<bt:Set Name="Mailbox"/>
			</bt:Sets>
		</Requirements>
		<Hosts>
			<Host xsi:type="MailHost">
				<DesktopFormFactor>
					<FunctionFile resid="Commands.Url"/>
					<ExtensionPoint xsi:type="MessageReadCommandSurface">
						<OfficeTab id="TabDefault">
							<Group id="msgReadGroup">
								<Label resid="GroupLabel"/>
								<Control xsi:type="Button" id="msgReadCreateSO">
									<Label resid="ButtonCreateSO.Label"/>
									<Supertip>
										<Title resid="ButtonCreateSO.Label"/>
										<Description resid="ButtonCreateSO.Tooltip"/>
									</Supertip>
									<Icon>
										<bt:Image size="16" resid="Icon"/>
										<bt:Image size="32" resid="Icon"/>
										<bt:Image size="80" resid="Icon"/>
									</Icon>
									<Action xsi:type="ShowTaskpane">
										<SourceLocation resid="ButtonCreateSO.Url"/>
									</Action>
								</Control>
							</Group>
						</OfficeTab>
					</ExtensionPoint>
				</DesktopFormFactor>

				<MobileFormFactor> 
					<ExtensionPoint xsi:type="MobileMessageReadCommandSurface">
						<Group id="mobileMsgRead">
							<Label resid="GroupLabel" /> <!-- I updated this to match the label ID in the Resources section. -->
							<Control xsi:type="MobileButton" id="msgReadCreateSO">
								<Label resid="ButtonCreateSO.Label" />
								<Icon xsi:type="bt:MobileIconList">
									<bt:Image size="25" scale="1" resid="Icon" />
									<bt:Image size="25" scale="2" resid="Icon" />
									<bt:Image size="25" scale="3" resid="Icon" />
		
									<bt:Image size="32" scale="1" resid="Icon" />
									<bt:Image size="32" scale="2" resid="Icon" />
									<bt:Image size="32" scale="3" resid="Icon" />
			
									<bt:Image size="48" scale="1" resid="Icon" />
									<bt:Image size="48" scale="2" resid="Icon" />
									<bt:Image size="48" scale="3" resid="Icon" />
								</Icon>
								<Action xsi:type="ShowTaskpane">
										<SourceLocation resid="ButtonCreateSO.Url"/>
								</Action>
							</Control>
						</Group>
					</ExtensionPoint>
				</MobileFormFactor>
			</Host>
		</Hosts>
		<Resources>
			<bt:Images>
				<bt:Image id="Icon" DefaultValue="https://www.digitalworkmate.com/icons/icon-512.png"/>
			</bt:Images>
			<bt:Urls>
				<bt:Url id="ButtonCreateSO.Url" DefaultValue="https://www.digitalworkmate.com/Outlook/EMail.Info"/>
			</bt:Urls>
			<bt:ShortStrings>
				<bt:String id="GroupLabel" DefaultValue="Digital WorkMate"/>
				<bt:String id="ButtonCreateSO.Label" DefaultValue="Import E-mail"/>
			</bt:ShortStrings>
			<bt:LongStrings>
				<bt:String id="ButtonCreateSO.Tooltip" DefaultValue="Create a sales order from e-mail"/>
			</bt:LongStrings>
		</Resources>
	</VersionOverrides>
</OfficeApp>