Customizing the K2 Workspace for iOS App
This topic describes what options are available when customizing the K2 Workspace for iOS app so that you can brand it or distribute a customized version of it using Mobile Device Management (MDM) software.
You can customize the K2 Workspace for iOS app in two ways: configure the K2 Workspace for iOS app using MDM software or brand the app by configuring the AppIcon and Sign In logo.
You can customize the following settings in the K2 Workspace for iOS app. Default values are used if you don't configure your own values, except for K2 Server:
Configuration Key | Value Type | Configuration Value and Example | Description |
---|---|---|---|
Custom Logo (Company Logo) Key: company_logo |
String | URL that points to your company logo (the image must be available on the internet and referenced in URL format) - Example: "https://www.k2.com/k2logo.png" | Custom Logo for the Sign In page. |
App Theme Key: app_light_theme |
Boolean | Use a light or dark theme. Values: True/False. True for Light theme, False for Dark theme. | The theme of the K2 Workspace for iOS app. The Light theme is the default. |
Configure App Theme Key: configure_theme |
Boolean | Uses theme configured by Administrator. Values: True/False. True uses the theme configured by your administrator, False uses the theme set on the your device. | Uses the theme configured for the K2 Workspace for iOS app based on the settings provided by the Administrator on MDM or in your device settings. |
Accent Color Key: app_color_accent |
String |
The RGB color used for buttons and highlighting. Specify the color by its hex code, such as #FF0000 for red or #0000FF for blue (the default). |
Color of the buttons and highlighting. |
K2 Server Key:server_url |
String |
URL of your K2 server in the format {scheme}://{domain}, for example "https://www.k2.com" If you don't specify a value for your K2 Server during the MDM configuration, you are shown the server screen and you must specify a server URL before signing in to the app.
|
The K2 Server URL for signing in to the app. Specify the full URL , including the protocol such as HTTP or HTTPS. If you don't specify a K2 Server, every user must enter one on their Sign In page. |
This section describes how you can brand the K2 Workspace for iOS app and distribute it using Mobile Device Management (MDM) software. Note that you can only customize the K2 Workspace for iOS Device AppIcon and Sign In page logo image, referred to as the AppIcon and Logo in the table below. Follow the steps below to brand your K2 Workspace for iOS app.
Once you have branded the K2 Workspace for iOS app you can use the branded unsigned app (IPA file) in your MDM software to further configure app settings such as the color accent, K2 Server, and App Theme.
- Obtain the unsigned release IPA for the K2 Workspace for iOS app from here.
- Change the .ipa extension to .zip.
- Extract the contents of the .zip file.
- Select the Show Package Contents option on the Mobile.app file, using the OS X File Explorer.
- Replace the following logo icons to make sure the new logo is shown everywhere in the app and in iOS.
Icon Size Where the icon is used AppIcon20.png 20px Icon used in the app, such as app icons and settings icon AppIcon20@2x-1.png 20px Icon used in the app, such as app icons and settings icon AppIcon20@2x.png 20px Icon used in the app, such as app icons and settings icon AppIcon20@3x.png 20px Icon used in the app, such as app icons and settings icon AppIcon29.png 29px Icon used in the app, such as app icons and settings icon AppIcon29@2x-1.png 29px Icon used in the app, such as app icons and settings icon AppIcon29@2x.png 29px Icon used in the app, such as app icons and settings icon AppIcon29@3x.png 29px Icon used in the app, such as app icons and settings icon AppIcon40.png 40px Icon used in the app, such as app icons and settings icon AppIcon40@2x-1.png 40px Icon used in the app, such as app icons and settings icon AppIcon40@2x.png 40px Icon used in the app, such as app icons and settings icon AppIcon40@3x.png 40px Icon used in the app, such as app icons and settings icon. AppIcon60@2x.png 60px Icon used in the app, such as app icons and settings icon AppIcon60@3x.png 60px Icon used in the app, such as app icons and settings icon AppIcon76.png 76px Icon used in the app, such as app icons and settings icon AppIcon76@2x.png 76px Icon used in the app, such as app icons and settings icon AppIcon83_5@2x.png 83px Icon used in the app, such as app icons and settings icon AppIcon1024.png 1024px Icon used in the app, such as app icons and settings icon Logo72.png 72px Logo on the Sign In page Logo72@2x.png 72px Logo on the Sign In page Logo72@3x.png 72px Logo on the Sign In page - If your provisioning profile does not match com.k2.workspace (the K2 Bundle ID), then you must change the Bundle ID to match your provisioning profile by following these steps:
- Open the info.plist file.
- Change the Bundle ID to match your certificate and provisioning profile.
- Change the app display name.
- Zip the Payload folder to create a ZIP file.
- Rename the Payload.zip file to an IPA file.
- Distribute the IPA file using your preferred distribution software or continue to configure the app via MDM software.
There are multiple ways to customize the K2 Workspace for iOS app in Microsoft Intune. The following high-level steps use the iOS and the Enrolled Devices options in Microsoft Intune. You can use the iOS or Line of Business (LOB) options provided in Microsoft Intune to add the K2 Workspace for iOS app, and configure the app with or without enrollment. For more information on the other available options to add the K2 Workspace for iOS app to Microsoft Intune , customizing the app and assigning the app to specific users and groups, see Add an iOS line-of-business app to Microsoft Intune and Assign apps to groups with Microsoft Intune for more information.
You can also configure App protection policies (APP), which are rules that ensure an organization's data remains safe or contained in a managed app. A policy can be a rule that is enforced when the user attempts to access or move "corporate" data, or a set of actions that are prohibited or monitored when the user is inside the app. A managed app is an app that has app protection policies applied to it, and can be managed by Microsoft Intune. See the How to create and assign app protection policies for more information.
Use the following high-level steps to customize the K2 Workspace for iOS app using in Microsoft Intune using the iOS with enrollment option.
- Get a Microsoft Intune license and add it to your Azure Active Directory Portal.
- Create new or edit existing groups in Azure Active Directory containing K2 Workspace for iOS users.
- Open the Microsoft Intune page in Azure Active Directory, click Device Enrollment, and select the iOS Enrollment option.
- Select Apple MDM Push Certificate.
- Select the I grant Microsoft Permission to send both user and device information to option.
- Download the CSR.
- Create an MDM push certificate (steps are provided in Microsoft Intune).
- Enter your organization's Apple account and click Enroll.
- Your organization's App Store (iOS App Store) page opens toon the Managed Apps page. Search for the K2 Workspace for iOS app and click Approve. You must approve the K2 Workspace for iOS app in order for it to display in Microsoft Intune.
- Select the Keep approved when app requests new permissions option on the Approval settings page.
- Install the Intune Company Portal app on all mobile devices. You use the Intune Company Portal app on your user's devices (those who need the MDM app) to download the MDM app on their device. Ensure the Intune Company Portal app is installed on all devices.
- Click Apps and select the K2 Workspace for iOS app. Select the Assignments option. This is where you add groups that need the K2 Workspace for iOS MDM app.
- Click Add group. On the Assignment type option select Required.
- Click the Included Groups option. Select YES for the Make this app required for all users and Make this app required on all devices options.
- Click Select groups to include and search and add the group you created in step 2, Click Select, OK and then OK again.
- Once you are returned to the Assignments page, click Save.
- Open the Client Apps page and click App configuration policies. Click Add.
- Provide a Name, Description and Device Enrollment Type option. Select the Managed Devices option.
- Select iOS in the Platform option. Click the Select the required app option and choose the K2 Workspace for iOS app. Click OK.
- On the Add configuration policy page click Configuration settings.
- On the Configuration settings page, select the Use configuration designer option from Configuration settings format drop-down.
- Select the options you want to configure on your K2 Workspace for iOS MDM app, such as the custom logo, server address, and theme based on the information table above. Click OK.
- Provide values for the options you want to configure, and then click OK.
- Click Add on the Add configuration policy page. The policy is added to Add configuration policy page.
- Click the policy in the Add configuration policy page. The [Policy Name] - Assignments page opens.
- Click Assignments and add the group you created in step 2. Click Select and then Save.
- Make sure your device is registered during the Microsoft Intune Company Portal setup in Work Profile Setup section. If the device is not registered, then you may not see the app in the Intune Company Portal app.
- Open the Intune Company Portal app on one of your mobile devices. Install the MDM app on the device using the APPS page in the Intune Company Portal app.
- If the K2 Workspace for iOS MDM app is not available yet tap Sync in the Settings page of the Intune Company Portal app. Once complete, the K2 Workspace for iOS MDM app is be available and ready to use.
- The K2 Workspace for iOS MDM app is installed and ready to use.
You can configure the K2 Server URL setting of the K2 Workspace for iOS app without using MDM software to edit the app package. Follow the steps below to configure the K2 Server URL:
- Obtain the unsigned release IPA for the K2 Workspace for iOS app from here.
- Change the .ipa extension to .zip.
- Extract the contents of the .zip file.
- Launch OS X File Explorer and select the Show Package Contents option on the Mobile.app file.
- Open the Config.plist file.
- Add your K2 server URL to the ServerURL value and save the Config.plist file.
- Zip the Payload folder to create a .zip file.
- Rename the Payload.zip file to an .ipa file.
- Distribute the IPA file using your preferred distribution software.