Images

From Resco's Wiki
Revision as of 08:15, 3 April 2020 by Jzambor (talk | contribs)
Jump to: navigation, search
Branding and customization

Resco Mobile CRM offers several ways how to work with images. Broadly speaking, there are two large groups of images:

  • Entity images are related to a particular record in your database, such as the photos of your contacts, signatures on an order, or photos of broken machinery collected during an inspection.
  • Project images are related to your app project. They include icons and other static images used in your app.

Entity images can be stored in two locations:

  • On your backend server, in special entities designed to hold binary documents, for example, Annotation / Note.
  • On external document storage, such as SharePoint. Use external document storage for images related to your organization entities and records, if you don’t want to use server database for these, for example, for cost reasons (storing documents in external document servers is cheaper than storing them directly in the CRM server), or you already have existing external storage that you don’t want to migrate. See Documents for more information.

Project images can be stored:

  • In the Images section of Woodford. This is the standard storage for user interface icons.
  • In the Offline HTML section of Woodford. You can put here images used for a more invasive overhaul of the user interface. Also, the static images used in mobile reports are stored here.

Project images

To improve how the Resco Mobile CRM app aligns with your company colors and graphics, or simply to spice up the app a little bit, you can change the images and icons in the app. You can also add new images for custom items, such as map pins, entity icons, form tabs icons, command icons, etc.

Edit an app project and select Images from the Project menu of Woodford to get started.

Working with images

The Images pane shows an alphabetical listing of images available in the app. Multiple variants of each image are often necessary, with different DPI and platform-specific settings.

  • Directories: Images are organized into directories. Select the directory that you want to display. You can also create new directories - click Add Directory.
  • Search bar, along with correct directory selection, allows you to quickly locate the correct image.
  • Common Images: This check box controls whether images that are not platform-specific should be displayed.
  • Platform-specific check boxes: Select which platforms are interesting for you and work with the relevant images only.

Changing a standard image

To replace a standard/default image with a custom image:

  1. Locate the existing icon in the list and click it.
  2. In the Edit Image window, click on the no-image icon and upload a custom icon from your computer.
  3. Click Delete if you want to return to the default icon.
  4. Click Save.

Adding a custom image

If you want to add a picture to the custom item, you can use the default directories or you can create your own directory for storing custom images.

  1. Click Add Directory if you want to create a new one. Select the parent directory and enter a name, then click Create.
  2. Click Add from the toolbar.
    • Select the directory, enter a name, choose a platform and DPI.
    • Click on the no-image icon and upload a custom image from your computer.
  3. Click Add. This creates the new image record in the list.
  4. Adding different versions of the image is easier: Click the placeholder image and upload the correct image.
  5. When you have uploaded all the necessary versions, click Save.

Colorize

If you want to use your picture in the same way as default pictures are used (i.e. picture follows color selected in the theme or view style) you need to enable the Colorize option. It will create a mask from the picture that you add. The picture needs to have an alpha channel. Everything where alpha is different from 0, will be used as a mask and it will follow the color set in theme or view style.

Bulk changes

Bulk import is done by importing a specifically named zip file that contains the images in a specific folder structure – the best way to explore the folder structure is to download the icon package from our WEBSITE. Once you have the file, you need to remove the directories and files that you don’t want to change. This way you won’t need to worry about getting the names of the folders or the structure of the folders wrong.

Please note, that different devices have different screen capabilities, and therefore there are different directories for them (like the Platform option in Images section in Woodford, when adding a new image).

  • MonoDroid – Android devices
  • MonoTouch – iOS (iPhone, iPad)
  • Windows – Windows tablets

Example: We want to place the image into the home section of the app – first, we need to place the image file into the subdirectory Home of the MobileCrm.zip file. The names and sizes of the actual pictures have to follow existing ones as they differ per platform. In this example case, we will add a picture for the iOS.

If users use newer and older iPad/iPhone devices, they need two sizes of the image – this is because the older apple devices have screens with a smaller resolution. Android devices are also divided by LDPI, MDPI, HDPI, XHDPI according to the resolution of the app (you can regulate this in the Android app’s setup).

That’s why we will need a small and a large image version that has a suffix @2x (e.g. account@2x.png). Please check the dimensions of existing images for the reference. Also, the Tabs directory can be interesting for us, if we want to change the images of the associated views. The name prefix of the image for the entity (on Home screen) should be the logic name of the entity. It can be checked in Woodford.

For example, if we want to add only one image to the home screen for our custom entity with name cust1 and overwrite the default image for invoices, we have to create a zip file with the following structure:

MobileCrm\Images.MonoTouch\Home\cust1.png
MobileCrm\Images.MonoTouch\Home\cust1@2x.png
MobileCrm\Images.MonoTouch\Home\invoice.png
MobileCrm\Images.MonoTouch\Home\invoice@2x.png

To import the file, go to your app project, select Images from the Project menu, click Import and upload the zip file.

After the import is done, we can verify the added images by searching for them in the list (use the filters Directory and Folder to get a quicker access to the images) or it can be verified by exporting the Images.zip, or by exporting the Mobile Project, adding an extension .zip to it and inspecting it. Images.zip file should be in the root.

Note The zip should only contain images you want to replace or add, so if you use the sample zip, you need to remove all the default images, otherwise they will be used twice in the project, and the project will increase in the size, resulting to possible problems in synchronization, and increasing the time of synchronization.

Entity images

When designing a custom view or form, you can display images related to your record.

  • To learn more about what view and form images represent in Dynamics, please check this blog post. Blog
  • See also an example of Woodford setup for view and form images in this blog post. Blog

Use Note attachment as image in views

You add pictures that were originally saved as Note attachments to the view and/or to an edit form. This way you can, for example, show the photo of your contact or a picture of your product in the app's forms and views.

To display pictures on a view, you need to do following:

  1. Edit an app project and select the entity from the Project menu.
  2. Click Show UI to display the lists of views, forms, and charts.
  3. Double-click the view to open it for editing.
  4. Click Add Image and select ListNoteImage. This will add a picture item to the view designer.
  5. Adjust the size of other fields of your view to prevent overlap.

By default, the Note where the view picture should be attached must have a subject name set to be exactly “ListImage”. This can be changed using style editor.

  1. Click Edit Styles and select ListNoteImage.
  2. To change the Subject name of the Note, click the ImageQuery field.
  3. By changing the Subject field you set the name of the Note, from where the picture will be taken.
  4. You can also create more ListNoteImage styles in order to use different notes for different views.
  5. Click Save & Close to close the style editor.

If you use multiple ListNoteImage styles, you should make sure to set the correct style in the properties of the image item back in the view designer window.

Now, you need to save these changes, publish the mobile project and synchronize the Mobile CRM application. Then open any Account record in the app, create an associated Note with Subject “ListImage” and attach/capture a picture. This picture is used in the list for this record.

Default / editable images in views

If you use images in views, and there are some records that do not have any image in their Note, you can display a default (placeholder) image instead, so that there is not an empty slot in the view. The placeholder is configured in image styles.

  1. Edit a view.
  2. Click Edit Styles to open the Style editor.
  3. Select an image style and click the ImageQuery parameter.
    Configure image query.png
  4. In the Placeholder Image field, enter the file name of the file, including folder, separated by dots.
  5. Click OK to close the image query. Save and close the style editor. Save the view.
  6. Select Images from the Project menu.
  7. Click Add Directory to create the folder myfolder from the example above.
  8. Add the file mypic.png into the folder.
  9. Click Save.
  10. Publish the project and verify the behavior in the app.

Also, it is possible to set editable images in views. It does not mean that you can edit the image, but you can edit the field, that is represented by it. For example, an option set may be displayed as image, rather than its value as text. And similarly to editable fields, you can change the value with the images.

To find out how to set up these two features, please check this webinar section. Webinar

Use Note attachment as image in forms

You can add a picture to a form exactly like the view. In this example, we display an image on the Account form.

  1. Edit an app project.
  2. Select Account from the Project menu, then click Show UI.
  3. Edit the form.
  4. Click Add Image and select FormNoteImage. A new field called image1 is added to the form.
  5. Select the image. You can rename it by editing the Binding field in the Properties pane (for example to Account Image). To apply the change, just click the image field item.
  6. By default, the Note where the edit form picture should be attached needs to have a subject name exactly “FormImage”. If you need to change the subject name, use styles:
    • Click Edit Styles, select FormNoteImage, then click the ImageQuery field to change the Subject name of the Note.
    • You can also create more FormNoteImage styles and use different notes for different entities. Close the style editor.
  7. If you have multiple FormNoteImage styles, make sure that you set the correct style for the image1 item (Properties pane > Style).
Note If you set the same Note Subject for your view and form, the same image attached to a simple Note will be used for both.

Crop or edit images in forms

In some scenarios, you need to select only a portion of the image, highlight a part of the image, or add some text. You don't have to use an external image editor, you can do this directly in the app.

In Woodford, when you select an image field on a form tab, the Properties pane lists a number of actions, such as Resize Image or Clear (see full list).

The actions that you enable can then be used in the app, for example:

  • when you click the image placeholder to add an image
  • when you click an image on the form
  • when you view an image, from the hamburger menu
  • when you select the Edit image option, you can crop the image, rotate it, add lines and text.

Automatic image processing

In some scenarios, you need to ingest large number images from various sources, and you would like to perform some image normalization automatically, for example, decrease image dimensions or crop image to a certain aspect ratio. This option is available for images added using the Add Media button or using the photo or plus button on a related list. In the following example, we add a new media tab and write an On Load rule that performs the normalization.

  1. Edit an app project, then select an entity from the Project menu, for example, Contact.
  2. Click Add Media to add a new tab to your form, then click OK.
    Configure media tab.png
  3. Click On Load and specify the rule that should be performed.
    On Load rule.png
  4. Select one of the enforcement modes: No Enforcement means that images are not modified; options starting with Auto perform the action autonomously; Crop in Image Editor launches an in-app editor that allows the user to crop the image manually.
  5. Click Save & Close to return to the form designer, then save the form and publish the project.
Tip You can configure this rule for the form of the Note (Annotation) entity. This form includes a hidden media tab called Attachment; i.e., the rule will point to Tabs.Attachment.EnforcementMode.

Entity image (Dynamics)

Microsoft Dynamics 2013 and later includes a special picture field, where you can store images of Accounts, Contacts, Leads, etc. If you use this kind of picture field, you can use it also on Mobile CRM application.

First, make sure that the field Entity Image is enabled for the entities where you want to use them. Select the entity from the Project menu, scroll to Entity Image and verify that the field is enabled.

Once you enable the Entity Image field, the default image set for the record will be automatically displayed on the Contact Information Form. No additional action is needed.

To add entity images to your view, edit the view, click Add Image and select ListEntityImage. The image is added to your view; adjust the size and position of your existing fields to avoid overlap. To preserve the default functionality, we recommend not to edit the ListEntityImage style. You need to save the changes and publish the customization (or proceed to setting up the edit form entity image).

To add entity images to your form, edit the form, click Add Image and select ListEntityImage. The image is added to your form. You can rename the image by editing the Binding field in the Properties pane. To apply the change, you need to click on the image field item.

When changes are saved, the project needs to be published and synchronized with the Mobile CRM app. Entity images will appear on the view and on the edit form for those records that have an entity image.

Change filename of note images

The filename of a note image created using a media tab can be modified.

  1. Using Woodford, edit the form for the Note entity and add the parameter File Name.
    Add filename to form.png
  2. In the app, go to the Note form. Modify the filename and click Save.

It is not possible to change the filename directly on the media tab.