Getting asset details from Microsoft Endpoint Configuration Manager by using Jitterbit Harmony
BMC Helix iPaaS, powered by Jitterbit provides a pre-built integration template to retrieve asset details from Microsoft Endpoint Configuration Manager, formerly System Center Configuration Manager and Systems Management Server (Microsoft SCCM), to any application. To use the integration template with the values defined out of the box, you update the project variables with details of your systems and deploy the integration template. Then configure the RestAPI call to get the asset details from Microsoft Endpoint Configuration Manager in JSON or HTML format.
Use case | Microsoft Endpoint Configuration Manager to target application | Target application to Microsoft Endpoint Configuration Manager |
---|---|---|
Retrieve asset details | Retrieves asset details from Microsoft Endpoint Configuration Manager to applications that provide RestAPI calls to generate HTTP requests | NA |
Target application to Microsoft Endpoint Configuration Manager data flow
The following image gives an overview of the data flow for retrieving asset data from Microsoft Endpoint Configuration Manager to the integrated application:
Before you begin
You require the following items to successfully set up and use this integration:
Required versions | Microsoft Endpoint Configuration version MECM 2002 or later |
---|---|
Authentication and permissions | Administrator access to the application to which asset details are sent |
Jitterbit Harmony subscription | A valid
BMC Helix iPaaS
|
Task 1: To download and import the integration template project file
Download the Get Asset Details from Microsoft Endpoint Configuration Manager (SCCM) Update 2022-07-01
file.
This file contains the BMC Helix iPaaS Cloud Studio project Retrieve Asset Details for MECM.Important
Your ability to access product pages on the EPD website is determined by the license your company purchased.
- As an administrator, log in to BMC Helix iPaaS and navigate to the Cloud Studio.
- On the projects page, click Import.
- Click Browse to and then select the Get Asset Details from Microsoft Endpoint Configuration Manager (SCCM) Update.json file you downloaded.
The Project Name and Organization fields are automatically populated depending on the values defined. - From the Environment list, select the environment to which you want to import this integration template, and click Import.
The project opens after the integration template is imported.
To open the project file at a later time, select the environment where the integration templates are available, select the Retrieve_Asset_Details_From_MECM project, and click View/Edit.
Task 2: To add a new Microsoft Endpoint Configuration Manager endpoint configuration
Before you can successfully use the integration template, you must update the query action of the Microsoft SCCM connector and update the transformations.
- To open the project file, select the environment where the integration templates are available, select the Retrieve_Asset_Details_From_MECM project and click View/Edit.
- To delete the query action, perform the following steps:
- On the Components tab, select End Points > Microsoft Endpoint Configuration Manager Endpoint >Microsoft Endpoint Configuration Manager Endpoint> Query System Information and click View
- Click ... and select Delete.
- To delete the Microsoft Endpoint Configuration Manager endpoint, perform the following steps:
- From the Show menu in the Connectors pane, select Endpoints.
- Double-click Microsoft Endpoint Configuration Manager.
- On the Configure Microsoft Endpoint Configuration Manager page, click Delete.
To configure a new Microsoft Endpoint Configuration Manager endpoint, perform the following steps:
To add a new query action to the 1.1 Get Asset Details workflow, perform the following steps:
To update the field mappings in the transformation element of the 1.1 Get Asset Details workflow, perform the following steps.
Task 3: To update the project variables for the integration template
- Next to the Environment name, click the ellipsis ... and select Project Variables.
- Update the following project variables:
Access points and authentication details for Microsoft SCCM and BMC Helix iPaaS applications
Project variable Action Microsoft SCCM Default_Output_Format Select the output format of the asset details information. By default, this option is set to HTTP. You can select HTTP of JSON. MECM_Host Enter the Microsoft Endpoint Configuration Manager host URL. MECM_Username Enter the user ID to access Microsoft Endpoint Configuration Manager. MECM_User_Password Enter the password of the user to access Microsoft Endpoint Configuration Manager. MECM_KDC Enter the Kerberos host for Microsoft Endpoint Configuration Manager.
MECM_Realm Set the realm for Microsoft Endpoint Configuration Manager.
BMC Helix iPaaS
Jitterbit_Url Enter the URL to access BMC Helix iPaaS.
Jitterbit_User Enter the user ID to access BMC Helix iPaaS.
Jitterbit_User_Password Enter the password of the user ID to access BMC Helix iPaaS.
Webhook API variables
Project variables Action Jitterbit_Project_Name Enter the name of the project for which the Webhook API must be created.
By default, this field is blank and uses the current project name where we are running the API script.
Jitterbit_Operation_Name Enter the name of the operation to run when the Webhook API is triggered. By default, this value is empty. This value is added to the BMC Helix iPaaS Jitterbit API.
Jitterbit_Integration_API_Name Enter the name for the Webhook API that is created in Microsoft Endpoint Configuration Manager.
By default, this value is set to Retrieve Asset Details From MECM.
Jitterbit_Integration_API_Method Enter the RestAPI method used by the Webhook API.
Valid values include:
- GET (Default)
- POST
- PUT
- DELETE
This value is added to the BMC Helix iPaaS Jitterbit API.
Jitterbit_Integration_API_Response_Type Enter the RestAPI response type used by the Webhook API created. This value is added in the BMC Helix iPaaS Jitterbit API.By default, set to VARIABLE.
Jitterbit_Integration_API_Security_Profile_Type Enter a security profile type.
Valid values include:
- BASIC (Default)
- ANONYMOUS
- APIKEY
Enter comma separated values to select multiple profile types (APIKEY,BASIC).
A security profile type defines the authentication type to be used by the Webhook API. This value is added in the BMC Helix iPaaS Jitterbit API.
Important:
- For profile types supported by the source application, the security profiles are automatically created by the integration template when you enable the integration.
- BMC Helix iPaaS does not support OAuth authentication for this application.
Jitterbit_Integration_API_Security_Profile_Name_Suffix Enter a suffix to be added to the name of security profiles created. Jitterbit_Integration_API_Security_Profile_BASIC_Auth_Username For security profile type BASIC, enter the user name to be used to create the security profile.
This user name is used for authentication by the Jitterbit API and the Webhook API.
Jitterbit_Integration_API_Security_Profile_BASIC_Auth_Password For security profile type BASIC, enter the password for the security profile created.
This password is used for authentication by the Jitterbit API and the Webhook API.
Jitterbit_Integration_API_Security_Profile_ApiKey_Name For security profile type APIKEY, enter the name of the APIKEY to set on the security profile.
This APIKEY is used for authentication by the Jitterbit API and the Webhook API.
BHIP_API_TimeOut
Enter a value, in seconds, for an API timeout. The minimum value must range between 30 and 180. By default, the value is set to 90.
Task 4: To deploy and enable the project
To deploy the project and then enable the integration:
- To deploy the project, next to the project name, click the ellipsis ..., and select Deploy Project.
- To enable the integration, next to the Enable Integrations workflow, click the ellipsis ..., and select Deploy.
The following image shows the steps to deploy the project and enable it by deploying the workflow:
After you enable the integration, and create a custom action to get asset details, you can request asset details from the Microsoft Endpoint Configuration Manager.
(Optional) Task 5: To set the time for API debug mode
By default, the debug mode is set to 2 hours after you run the integration. Debug logs are updated for the time set for the debug mode. To increase the debug mode for a longer period of time, perform the following steps:
- In BMC Helix iPaaS, powered by Jitterbit, select API Manager > My APIs.
- Open Retrieve Asset Data API.
- Select Enable Debug Mode Until: and set it for the required date and time.
- Save and publish the API.
(Optional) Task 6: To update the asset detail fields displayed in your output
By default, the following asset details are displayed:
You have the option to modify the fields you want to display in your output.
Log in to BMC Helix iPaaS as a developer and navigate to the Cloud Studio.
Select the environment where the integration templates are available.
- Select the Retrieve_Asset_Details_From_MECM project and click View/Edit.
- Expand the Retrieve Asset Details workflow.
- From the 1.1 Get Asset Details workflow, select Query System Information and click View/Edit.
- Click Step 1 and select the object from which you want to view the fields.
- Click Step 2 and select the fields to add to your output.
- Click Next, and then on Step 3, click Finished .
- From the 1.1 Get Asset Details workflow, select Transform Response and click View/Edit.
- Select and click Clear Schema.
- After the mappings are cleared, to update the schema mappings, click Automap Exact Matches.
The output file displays the details of the fields that you selected.
Example: Retrieving asset details from Microsoft Endpoint Configuration Manager to Remedy with Smart IT
You can use the Retrieve Asset Details from MECM integration template to retrieve asset details from Microsoft Endpoint Configuration Manager to any application that provides the RestAPI for HTTP calls, like Smart IT. This example describes the configuration required to retrieve asset details into Smart IT.
After you have deployed the integration template, create a new custom action for the Asset or Incident form in Smart IT, and add the HTTP URL to the configuration. The action added to the Incident or Asset view displays the details of the asset from Microsoft Endpoint Configuration Manager in a new window.
To configure a custom action in Smart IT to retrieve asset details from Microsoft Endpoint Configuration Manager
- As an administrator, log in to SmartIT.
- Select More > Configuration > Screen Configuration.
- Click Add/Remove Actions from the incident or asset view.
For example, to configure the asset details action button to the Incident form, click Add/Remove Actions of the Incident View.
By default, the list of actions is alphabetically ordered. You can customize the ordering using the Custom Order option. - Click Add Action and enter a name for the action in the Action Name field, for example, Get Asset Details.
- In Action Type section, click Client Side URL.
- Select all supported platforms.
- In the URL/URI field, enter the service URL from the integration template.
Append the queryParameter, and select causalCI, for example,https://BMCID0391.jitterbit.net/BMCEnv/RetrieveAssetDetailsFromMECM?queryParameter[causalCI].
- In the Localized Labels to Show section, select languages that are supported and enter the Label Text for localization.
The Label Text will be shown as a menu item in the More menu of an Incident. - Click Save.
Now, when a user selects the Get Asset Details action from a Smart IT ticket, details of the asset are retrieved from Microsoft Endpoint Configuration Manager and displayed in a new tab in the format selected in the integration template.
For additional details about adding a client side URL as a custom action, see
Configuring client-side URL action
Workflows included in the integration template
The integration template includes workflows for the basic configuration and each integration use case. The following tables describe the operations defined in each workflow.
Enable Integration
This workflow defines the operations required to enable the integration after all the required project configurations are completed. The following operations are included in this workflow:
Operation name | Actions performed |
---|---|
Enable integration | Sets up the required details for the integration |
Login to Jitterbit | Logs in to BMC Helix iPaaS by using the credentials provided in the project variables |
Check Custom API and Security Profiles exist | Verifies if any custom APIs or security profiles exist for the Microsoft Endpoint Configuration Manager integration |
Delete API and Security Profile if needed | Deletes existing APIs or security profiles, if required |
Create Security Profiles and Custom API | Creates the security profiles and RestAPIs in BMC Helix iPaaS |
Publish Custom API | Publishes the custom APIs |
Retrieve Asset Details
This workflow retrieves the asset data from Microsoft Endpoint Configuration Manager, and generates the selected output. The following operations are included in this workflow:
Operation name | Actions performed |
---|---|
Initial Process and Main Process | Sets up the required details for getting asset details from Microsoft Endpoint Configuration Manager |
Get Asset Details | Gets the asset details in HTML or JSON format. By default, results are formatted in the HTML format. |
Build Error Response | Defines the error details if the operation generates an error Important: If no data is found, a message is sent as the HTML output. The JSON output is blank. |
Comments
Log in or register to comment.