The Mosyle integration allows IT teams to view all devices and users within their organization. By having this data within FMX, these IT teams can create tickets on their behalf, and audit what they have available.
This article will explain how to set up your Mosyle integration with FMX for your users. These instructions are for users who have purchased the Mosyle integration and have already been added to prismatic. If you are interested in adding this integration please reach out to your account manager at FMX. Once an FMX team member reaches out you can begin the process with the below steps.
**The Mosyle Device integration needs to set up prior to the users being set up. If you have not done that see this support article. **
Create Custom Field
Add this custom field in your FMX site before starting the integration steps. This custom field needs to be in FMX prior to the steps being completed so that you will be able to map the correct Mosyle field to correct FMX field.
Add the following required Mosyle Custom field in FMX for the integration:
- Mosyle User ID - add this custom field for Users & Contacts, that is a text field. Make sure that you do not limit the permitted user types for this field so that the integration can work properly.
The following fields are optional Mosyle fields you can add as custom fields in FMX. These can be updated later as well. All of these custom fields need to be added in FMX for users and contacts, as text fields and that are not limited in their permitted user types:
- Account
- assigned_devices
- deviceudid_devices
- id
- Locations
- manageappleid
- name
- serial_number_ios
- type
**See this support center article for how to add custom fields in FMX**
Go to the Integrations Settings
In your FMX site go to your admin settings. Then go to the tab that says “Integrations”. In this section you will see all of the integrations you have on your FMX site through Prismatic. Prismatic is a platform that you will use to set up the integration between Mosyle and FMX. The platform is embedded into FMX and you will use it via the integrations tab. To access your integration to begin the setup process select the integration you would like to work on. If you do not see the Mosyle integrations reach out to your primary contact at FMX.
Mosyle Users
Go to the integrations settings tab in your admin settings. To set up the Mosyle integration for your users select “Mosyle Users’ in this tab. In order to start this process click the “Reconfigure” button.
1. Initial Configuration
For this step there is nothing that you need to do to complete this. Select "Next" to move on to the configuration section.
2. Authentication
*This is the same information from the Mosyle device integration. If you have not set up the Mosyle device integration see this support article for details.*
Next, fill out the following fields in the "FMX API Connection" section:
- Hostname - this is your FMX hostname. This can be found in the URL of your site and it is the text before “.gofmx.com”. For example: https://fmxschool.gofmx.com/. The bolded text is your hostname.
- Password - this is the password of the FMX integration user you added for the device setup integration
- API User Email - this is email address of the integration user you added for the device setup integration
Fill out the fields in the "Mosyle Connection" section.
-
accessToken
- Same token from device setup
-
Email
- Email address for your Mosyle account
-
Password
- Password for that Mosyle account
After you have entered in all the information in the authentication fields click the next button.
3. User Mapping
In this section you will select which user types from Mosyle you want to include in the integration, as well as their respective user type in FMX, and whether they should be added as a user or contact. Only types selected below will be synced with FMX.
In the type mapping section choose a "Mosyle Type" from the first drop down, then select corresponding FMX user type from the "FMX User Type" dropdown. Then choose whether you want them to be a user or contact in FMX.
Choose to "Override Existing User Permissions" or not. When the box is checked the above user type and user/contact selection will be applied to existing users in FMX belonging to this Mosyle type. Otherwise, they will only be applied to new users.
Choose to "Override Existing Accessible Building" or not. When the box is checked the accessible building mapped in the next step will be applied to existing users in FMX belonging to this Mosyle Type. Otherwise, it will only be applied to new users.
** If users need to have multiple accessible buildings in FMX "Override Existing Accessible Building" needs to be turned off. In FMX you can update the user to add more buildings.**
Continue this process for all the Mosyle users you would like to do this for by selecting the "+ Add to Type Mapping" button to add more.
Next match the "Mosyle Account" with a respective building in FMX. These mappings will be used when assigned accessible buildings in FMX. Continue this process until all of the buildings are mapped.
4. Field Mapping
In this section you will map the fields from Mosyle to custom fields in FMX.
First choose the user custom field in FMX that you want the Mosyle user ID to map to.
Next select the "+Add to Optional Custom Fields" button and choose from the optional Mosyle fields listed in the drop down to map to an FMX custom field by matching the fields in each drop down menu. If you did not create custom fields for these prior to configuration in FMX you can reconfigure the integration to map these later.
Lastly match the Mosyle udid to the udid custom field in FMX. Doing this will bring in device assignments directly from Mosyle to FMX. Assignments will then have to be managed in Mosyle if an update is made. If you would like to manage assignments in FMX only then leave this field blank.
Select the "Finish" button when you are done.
Updating the Integration
If changes need to be made to your integration you can update it at any time. To do this go back to the Integration Settings tab in FMX. Then find the integration and select "Reconfigure".