Microsoft Endpoint Configuration Manager connector powered by Jitterbit

The BMC Helix iPaaS Microsoft Endpoint Configuration Manager Connector provides an interface for entering user-provided input such as credentials to create an authenticated Microsoft Endpoint Configuration Manager  (formerly System Center Configuration Manager and Systems Management Server (Microsoft SCCM))  connection. This connection provides the foundation to configure associated Microsoft Endpoint Configuration Manager activities that interact with the connection. Together, a specific Microsoft Endpoint Configuration Manager connection and its activities are referred to as a Microsoft Endpoint Configuration Manager endpoint.

Supported API versions and prerequisites

The Microsoft Endpoint Configuration Manager connector uses the  Microsoft Endpoint Configuration Manager REST API . Refer to the API documentation for information on the schema fields.

The Microsoft Endpoint Configuration Manager connector requires the use of an agent version 10.1 or higher. These agent versions automatically download the latest version of the connector when required.

  • Microsoft Endpoint Configuration Manager version 2002 or above must be installed.
  • Administration Service for Microsoft Endpoint Configuration Manager version 2002 must be enabled and accessible from the Jitterbit Private Agent.

To configure a Microsoft Endpoint Configuration Manager connection

  1. From the design canvas, open the Connectivity tab  of the design component palette.
  2. To open the configuration screen, to configure a Microsoft Endpoint Configuration Manager connection:

    • To configure a new Microsoft Endpoint Configuration Manager connection, use the Show dropdown to filter on Connectors, and then click the Microsoft Endpoint Configuration Manager connector block:
    • To configure an existing Microsoft Endpoint Configuration Manager connection, use the Show dropdown to filter on Endpoints, and then double-click the Microsoft Endpoint Configuration Manager connector block:
  3. On the configuration screen, enter the values described in the following table:

    Tip

    Fields with a variable icon  support using  global variables Project variables , and  Jitterbit variables . Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

    Field nameAction
    Endpoint NameEnter a name to identify the Microsoft Endpoint Configuration Manager connection. The name must be unique for each Microsoft Endpoint Configuration Manager connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Microsoft Endpoint Configuration Manager endpoint, which refers to both a specific connection and its activities.
    Configuration Manager HostEnter the Microsoft Endpoint Configuration Manager Host.
    UsernameEnter the user name to use to log on to the Microsoft Endpoint Configuration Manager.
    PasswordEnter the password for the selected user name.
    KDCEnter the name of the domain defined as the Key Distribution Center (KDC) for your Microsoft Endpoint Configuration Manager.
    RealmEnter the domain name of the realm to use with the Microsoft Endpoint Configuration Manager.


     

    Important

    If you click Delete while creating a new connection, an error is displayed. For more information, see  Component Dependencies, Deletion, and Removal .

  4. Click Save Changes.
    After configuring a Microsoft Endpoint Configuration Manager connection, you can configure one or more Microsoft Endpoint Configuration Manager activities associated with that connection to be used either as a source (to provide data within an operation) or as a target (to consume data within an operation).

 To create a Microsoft Endpoint Configuration Manager activity

  1. From the design canvas, open the Connectivity tab  of the design component palette.
  2. Use the Show dropdown to filter on Endpoints, and then click the Microsoft Endpoint Configuration Manager connection block to display activities that are available to be used with a Microsoft Endpoint Configuration Manager connection:

    The following activities are available. For more information about configuring these activities, see the specific activity section. 

    Activity nameDescription
    GetFinds an asset at a Microsoft Endpoint Configuration Manager endpoint and is intended to be used as a source in an operation. 
    QueryFinds assets at a Microsoft Endpoint Configuration Manager endpoint based on the query and is intended to be used as a source in an operation.
  3. To create an activity that can be configured, see drag the activity block from the palette to the operation.

For more information about the parts of an operation and adding activities to operations, see  Operation Creation and Configuration .

Microsoft Endpoint Configuration Manager Get activity

A Microsoft Endpoint Configuration Manager Get activity finds a single asset record from a Microsoft Endpoint Configuration Manager endpoint and is intended to be used as a source to provide data to an operation. After configuring a Microsoft Endpoint Configuration Manager connection, you can configure as many Microsoft Endpoint Configuration Manager activities as you like for each Microsoft Endpoint Configuration Manager connection.

To configure a Microsoft Endpoint Configuration Manager Get activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity brick.

  2. On the configuration screen, enter a name and specify the activity settings:

    Field nameAction
    NameEnter a name to identify the Microsoft Endpoint Configuration Manager Get activity. The name must be unique for each Microsoft Endpoint Configuration Manager Get activity and must not contain forward slashes (/) or colons (:).
    Select an Object for the Resource

    This section displays objects for the resources available in the Microsoft Endpoint Configuration Manager endpoint. When reopening an existing activity configuration, only the selected object for the resource is displayed instead of reloading the entire object for the resource list.

    • Selected Object: After an object for the resource is selected, it is listed here.

    • Search: Enter any part of the object for the resource name into the search box to filter the list of object for the resources. The search is not case-sensitive. If the object for the resources are already displayed within the table, the table results are filtered in real time with each keystroke. To reload object for the resources from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon  or the word Refresh to reload object for the resources from the Microsoft Endpoint Configuration Manager endpoint. This may be useful if you have recently added object for the resources to Microsoft Endpoint Configuration Manager. This action refreshes all metadata used to build the table of object for the resources displayed in the configuration.

    • Selecting an Object For the Resource: Within the table, click anywhere on a row to select an object for the resource. Only one object for the resource can be selected. The information available for each object for the resource is fetched from the Microsoft Endpoint Configuration Manager endpoint:

      • Name: The object for the resource name from Microsoft Endpoint Configuration Manager.

      • Description: The object for the resource description from Microsoft Endpoint Configuration Manager. 

        Tip

        If the table does not populate with available object for the resources, the Microsoft Endpoint Configuration Manager connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

    Unique IDEnter the unique ID of the object to be retrieved by the Microsoft Endpoint Configuration Manager Get activity.


  3. Click Next.

  4. Review the request and response data schemas. 
    The data schemas list the fields available for the Microsoft Endpoint Configuration Manager Get activity.
    If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
    The Microsoft Endpoint Configuration Manager connector uses the Azure Alerts REST API version 2019-03-01 . For more information about the schema fields, see the API documentation.

  5. Click Finished.
    After a Microsoft Endpoint Configuration Manager activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. For more information, see Activity Actions Menu .

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows.

Microsoft Endpoint Configuration Manager Get activity operation patterns

Microsoft Endpoint Configuration Manager Get activities can be used as a target with these operation patterns:

  • Transformation Pattern
  • Two-Target Archive Pattern (as the first source only)
  • Two-Transformation Pattern (as the first or second source)

Other patterns cannot be used for Microsoft Endpoint Configuration Manager Get activities. See the validation patterns on the  Operation Validity  page.

A typical use case is to use a Microsoft Endpoint Configuration Manager Get activity in the Two-Transformation Pattern. In this example, the first transformation (Get Request) creates a request structure that is passed to the Microsoft Endpoint Configuration Manager Get activity (MECM Get). The second transformation (Get Response) receives the response structure, which is then written to a variable by a Variable Write activity (Write Get Response) and a message is then logged by the Write to Operation Log script:

Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the  operation logs .

To configure a Microsoft Endpoint Configuration Manager Query activity

A Microsoft Endpoint Configuration Manager Query activity finds assets at a Microsoft Endpoint Configuration Manager endpoint and is intended to be used as a source to provide data to an operation. After configuring a Microsoft Endpoint Configuration Manager connection, you can configure as many Microsoft Endpoint Configuration Manager activities as you like for each Microsoft Endpoint Configuration Manager connection.

To configure a Microsoft Endpoint Configuration Manager activity, complete the following steps:

  1. After you add the activity to an operation, double-click the activity brick.

  2. On the configuration screen, enter a name and select an object for the resource: 

    Field nameAction
    NameEnter a name to identify the Microsoft Endpoint Configuration Manager Query activity. The name must be unique for each Microsoft Endpoint Configuration Manager Query activity and must not contain forward slashes (/) or colons (:).
    Select an Object for the Resource

    This section displays objects for the resources available in the Microsoft Endpoint Configuration Manager endpoint. When reopening an existing activity configuration, only the selected object for the resource is displayed instead of reloading the entire object for the resource list.

    • Selected Object: After an object for the resource is selected, it is listed here.

    • Search: Enter any part of the object for the resource name into the search box to filter the list of object for the resources. The search is not case-sensitive. If object for the resources are already displayed within the table, the table results are filtered in real time with each keystroke. To reload object for the resources from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon  or the word Refresh to reload object for the resources from the Microsoft Endpoint Configuration Manager endpoint. This may be useful if you have recently added object for the resources to Microsoft Endpoint Configuration Manager. This action refreshes all metadata used to build the table of object for the resources displayed in the configuration.

    • Selecting an Object For the Resource: Within the table, click anywhere on a row to select an object for the resource. Only one object for the resource can be selected. The information available for each object for the resource is fetched from the Microsoft Endpoint Configuration Manager endpoint:

      • Name: The object for the resource name from Microsoft Endpoint Configuration Manager.

      • Description: The object for the resource description from Microsoft Endpoint Configuration Manager.

    Tip: If the table does not populate with available object for the resources, the [Microsoft Endpoint Configuration Manager connection](./connection.md) may not be successful. Ensure you are connected by reopening the
    connection and retesting the credentials.


  3. Click Next.

  4. Build the query to use when retrieving asset records. 
    The Build Your Query step is used to set conditions on a query using the object fields and apply paging to a query.

    Tip

    Fields with a variable icon  support using  global variables Project variables , and  Jitterbit variables . Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

    Field nameAction
    SearchEnter any part of a field name into the search box to filter the list of fields for the selected object. The search is not case-sensitive. The listed results are filtered in real time with each keystroke.
    Refresh

    Click the refresh icon  or the word Refresh to reload fields of the object from the Microsoft Endpoint Configuration Manager endpoint.

    Select AllWhen using the search box to filter, you can use this checkbox to select all visible fields at once.
    Select FieldsSelect the checkboxes of the fields you want included in the query to have them automatically added to the SELECT statement in the Query String. You can also Select All of the fields at once using the checkbox.
    Conditions

    To add conditional clauses, use the fields below as input to help construct the clauses, which then appear in the Query String text box.

    • Object: Field: Use the dropdown to select a field from the selected object.
    • Operator: Use the dropdown to select an operator that is appropriate for the field data type:

      OperatorLabelDescription
      =Equals
      !=Not equals
      LIKE 'string'LikeLike string
      LIKE 'string%'Starts withStarts with string
      LIKE '%string'Ends withEnds with string
      LIKE '%string%'ContainsContains string
      <Less than
      <=Less or equal
      >Greater than
      >=Greater or equal
    • Value: Enter the desired value to use with the dropdown selections. 

      When using global variables in the conditions of a WHERE clause, it is recommended to specify a default value so that script testing is possible. Otherwise, since global variables obtain their value at runtime, the syntax may be invalidated during testing or no data may be returned if no default value is specified.

    • Add: Click to automatically construct the clause based on the dropdown selections and entered value. The conditional clause is added to the Query String text box.
    • Remove All: Click to remove all entered conditional clauses.
    Paging

    To add a paging clause (a limit on the number of records with an optional record offset), you can use the dropdown to set the paging limit and the field to enter an offset. If an offset is not specified, it defaults to 0. A single paging clause is supported. If paging clause is not included, all records are returned.

    • Apply: Click to automatically construct the clause based on the dropdown selections and entered value. The automatically constructed paging clause appears in the the Query String text box.

    • Remove: Click to remove a paging clause that has been applied.

    Query StringAs you select fields, specify conditions, and set paging, the query statement in this text box is autopopulated with the selected fields, conditions, and paging limits.
    Test QueryClick to validate the query. If the query is valid, a sample of up to 10 records retrieved from the query is displayed in a table. If the query is not valid, relevant error messages are displayed. The query must be valid and validated through this button in order to enable the Next button. microsoft_endpoint_configuration_manager-query-activity-2b.png

  5. Click Next.

  6. Review the request and response data schemas. 
    The data schemas list the fields available for the Microsoft Endpoint Configuration Manager Query activity.
    If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process. In the transformation mapping process, map target fields by using source objects, scripts, variables, custom values, and more.
    The Microsoft Endpoint Configuration Manager connector uses the Azure Alerts REST API version 2019-03-01 . For more information about the schema fields, see the API documentation.

  7. Click Finished.
    After a Microsoft Endpoint Configuration Manager activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity Actions Menu  for details.

To complete the configuration of the operation, add and configure other activities, transformations, or scripts as steps in an operation. You can also configure an operation's settings, which include the ability to chain operations together that are in the same or different workflows.

Microsoft Endpoint Configuration Manager Query activity operation patterns

Microsoft Endpoint Configuration Manager Query activities can be used as a target with these operation patterns:

  • Transformation Pattern
  • Two-Target Archive Pattern (as the first source only)
  • Two-Transformation Pattern (as the first or second source)

Other patterns cannot be used for Microsoft Endpoint Configuration Manager Query activities. See the validation patterns on the  Operation Validity  page.

A typical use case is to use a Microsoft Endpoint Configuration Manager Query activity in the Transformation Pattern. In this example, the Microsoft Endpoint Configuration Manager Query activity (MECM Query) generates a response structure that is received by the transformation (Query Response), which is then written to a variable by a Variable Write activity (Write Query Response) and a message is then logged by the Write to Operation Log script:

Tip

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the  operation logs .

Related topics

The following documents provide troubleshooting information for authentication related issues:

Clock skew too great for Kerberos authentication

Invalid service principal name in Kerberos authentication

Was this page helpful? Yes No Submitting... Thank you

Comments