Prepare and Update Resource File for SMP

The mWorkOrder application resource file resources_mworkorder.zip on Windows platform is used as an example to demonstrate the procedure. Do your branding changes in the zip file that is provided by Innovapptive initial deployment.

To prepare and update the resource file:

  1. Download the resources_mworkorder_zip file to the local drive.
  2. Extract the resource_mmworkorder.zip file.
    The following folder structure is displayed when you extract.

  3. Navigate to the iOS folder. (Same file and settings are applicable for iOS, Android, and Windows).
  4. Open the file settings.json in Notepad/Notepad++ (any standard text file editor) and make the changes to following properties as required.

    As a best practice, create and maintain the backup of the original or modified file with a different name.

    Property Description
    AppName Helps you identify the Innovapptive product name.
    • Conditions: Use uppercase alphabets.
    • Possible Values: Based on the product, refer to the table below. For example, Mobile Work Order.
    Environment Helps you identify the landscape that the mobile application is connected to. This value is displayed on the Login page of the mobile app.
    • Conditions: None
    • Possible Values: Development/Quality/Production.
    ShowDemoButton
    • Set to True to display the Sample Data button on the application Login page that helps the user view the demo data. If this value is set to false, button is not displayed.
    • Conditions: Use lowercase alphabets.
    • Possible Values: true/false
    hcolor
    • Custom header color for application. Provides the ability to customize the app screen elements, such as the header bar, to meet your corporate branding needs. Work with your appropriate branding team to identify the color that meets your enterprise palette.

      Tip: Use the Google Hex color picker to identify the Hex color code value that needs to be set up. To find the hex color code, go to www.google.com and search for “hex color picker.” Select the desired color and you will see the color code.

    • Conditions: Use the Hex color code value based on the color you would like to see on the mobile app screen elements.
    • Possible Values: As required. For example, #42c2f4
    OfflineStatusColor
    • Configure the color of your choice for the status bar that is displayed on top of the screen when the device is not connected to the network.
    • Tip: Use the Google Hex color picker to identify the Hex color code value that needs to be set up. To find the hex color code, go to www.google.com and search for “hex color picker.” Select the desired color and you will see the color code.
    For example, the parameter value could be configured as "OfflineStatusColor":"#DF264D" in the json file.
    isUnregisterRequired Set the value as False to disable the unregister feature in application.
    isEULARequired Set the value as False to disable the EULA agreement screen in application.
    TouchId Set the value as True to enable the Touch ID feature in application.
    AppPassCode Set the value as True to enable the App Passcode feature in application.
    ForgotPwd Set the value as True to enable the Forgot Password feature in application.
    ForgotPwdLink Set the value as True to display the website link to reset password.
    ForgotPwdMsg Set the value as True to display the message to reset password.
    Languages
    • Languages that are configured in the settings.json file are displayed to the user as a drop-down menu for selection. Additional languages can be added provided the language is available in SAP and the necessarytranslations are maintained.
      Syntax:
      {"id":<SequenceNumber>,"key":"<SAPLanguageCode>","value":
      "<LanguageName>"}
      
    • Conditions: Use the Hex color code value based on the color you would like to see on the mobile app screen elements.
    • Possible Values: Languages supported by SAP. For example, {"id":1,"key":"E","value":"English"}
      Note: For RACE Dynamic Forms, only English language is supported.
    Timeout
    • Description & Use: The application idle Timeout (in minutes). This setting allows the administrator to specify the automatic time out when apps are left idle.
    • Possible Values: As required. For example, D30.
  5. For each environment (Development, Quality, and Production), review and update the content block in entirety.
    Note: Values described in the following table are case sensitive and are recommended to be used in the same format as mentioned in the Description section. All the values are mandatory.
    Parameter Description
    Server

    The DNS/HostName of the SMP servers, which will be used for mobile application connection. For example: smp.innovapptive.com

    Port
    • The application establishes the communication to the server based on the port number.
    • Possible Values: 8080, 8081. For example, HTTP/HTTPs (SMP default HTTP port 8080, HTTPs 8081, and custom ports for proxy)
    ApplicationID
    • ID configured in SMP and the mobile application will use it to connect to server for the registration.
    • Condition: Use the same application ID as defined in SMP.
    • Possible Values: Based on the product, refer to the table below. For example: com.innovapptive.mworkorder.
    SecurityType
    • Used to identify the security type configured in SMP server for the application. Security types are used based on authentication mechanism/login mechanism selected for the application.
    • Condition: Use the same security profile name as defined in SMP. For example, Basic Authentication (SSO2), SAML Authentication (SAML) and x509 authentication(x509) mechanisms.
    https
    • Used to identify the protocol type. The default value should be set to false.
    • Condition: Use lowercase alphabets.
    • Possible Values: true/false.

    Whitelist [ApplicationID]

    All Innovapptive applications require connection settings for RACE services and may also require other connection settings.

    mWorkOrder application requires connection setting for RACE, EQUIPMENT, FUNCTIONALLOCATION, and ATTACHMENT. For Example, com.innovapptive.race, mwo.equipment, mwo.funloc and mwo.attach.

    Whitelist [StoreName]

    The name Offline stores for whitelist ApplicationIDs. RACE store is common for all Innovapptive applications.

    mWorkOrder application requires to configure for following StoreName – RACE, EQUIPMENT, FUNCTIONALLOCATION, and ATTACHMENT.

    The following screenshot shows sample settings file with the configuration details.

  6. ApplicationID and AppName depend on the app that you configure. Use the following table to configure:
    Name APP ID AppName
    Mobile Asset Tag com.innovapptive.massettag MASSETTAG
    Mobile Inventory com.innovapptive.minventory MINVENTORY
    Mobile Service Order com.innovapptive.mserviceorder MSERVICEORDER
    Mobile Shopping Cart com.innovapptive.mshop MSHOP
    Mobile Worklist com.innovapptive.mworklist MWORKLIST
    Mobile Work Order com.innovapptive.mworkorder MWORKORDER
    RACE Dynamic Forms com.innovapptive.racedynamicforms RACEDYNAMICFORMS
  7. Save the settings.json file.
  8. Update the image files.

    Replace the .png image files with your brand images. Ensure that the file format, image size, quality, resolution, and so on match the default images that are being replaced.

  9. Compress the following files with the updated files from Part 1 & 2 into a zip file with the name resources_ios.zip. Ensure that the content and filenames match.
    • App_BG_iPad_Landscape.png
    • App_BG_iPad_Protrait.png
    • App_BG_iPhone.png
    • App_Logo.png
    • settings.json