Versions Compared

Old Version 1

changes.mady.by.user Shilpa

Saved on

compared with

New Version 2

changes.mady.by.user Shilpa

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Appsplus panel macro confluence macro
data{"features":["title","icon","rounded","collapsible","border"],"title":"General Guidelines. **Delete before publishing**","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

**Delete Before Publishing**

  • Always use title casing for Heading formats 1 and 2.

  • Always use active voice.

  • Do not use "Please" anywhere in the document.

  • Screenshots

    • Always use the New Form UI.

    • Be optically similar. Max size corresponding gridline to 1000 px size, as in the style guide.

    • Do not capture Snap borders when showing configurations in the Examples section. You can add a border in the editor here.

    • See Image Style Guide for details.

  • Examples must always use first-person plural references. You can use the second-person if needed depending upon the example's content.

In this article

Table of Contents
minLevel1
maxLevel2
absoluteUrltrue

Overview

You can use this Snap to remove an existing member to an existing specified group name in Active Directory. This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Active Directory Basic Auth Account for information on setting up this type of account.

...

Prerequisites

  • Valid client ID.

  • A valid account with the required permissions.

...

  • .

Support for Ultra Pipelines

 

...

Ultra Pipelines

...

...

Works in 

...

Ultra Pipelines. 

Limitations

None.

Known Issues

None.

Snap Input and Output

...

Views

Type of View

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

Binary

Binary or

Document

  • Min: 0

  • Max: 1

  • Mapper

  • Copy

  • ..

    • Requires the EDI data and internal ID as a JSON document

    A document containing the details of the member to be removed.

    Output

    Document

    Binary

    Binary or Document

    • Min: 1

    • Max: 1

    • ..

    • ..

    The EDI transaction ID and order confirmation

    • Copy

    A confirmation message about the removed member.

    Snap Settings

    ...

    data{"features":["title","icon","rounded","collapsible","border"],"title":"Documenting Fields Based On Data Type/UI Element","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false}

    **Delete Before Publishing**

    Choose from the following sentences to document specific field types.

    Drop-down lists/Option Buttons (radio buttons):

    You must list the LoV and describe them if their meaning isn't apparent. In this case, format the LoV in italics, regular font for the LoV's description. In either case, list the LoVs as a bullet list.

    ...

    <State what the should do in this field>. The available options are: <bullet list of LoVs>
    Specify the Salesforce API to be used. The available options are:...

    ...

    Note

    Field names marked with an asterisk ( * ) are mandatory.

    Field Name

    Field Type

    Field Dependency

    Description

    Label*

    String

    N/A

    The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.

    Default Value: Remove Member
    Example: Remove Member

    Distinguished name*


    String

    N/A

    The LDAP API references an LDAP object by its distinguished name (DN). A DN is a sequence of relative distinguished names (RDN) connected by commas. An RDN is an attribute with an associated value in the form attribute=value, normally expressed in a UTF-8 string format.  The typical RDN attribute types include: 

    DC = domainComponent, CN = commonName, OU = organizationalUnitName,O = organizationName, STREET = streetAddress, L = localityName,ST = stateOrProvinceName, C = countryName, UID = userid.

    This field is applicable only to existing users. If the user does not exist, create an entry using the Create Entry Snap first.

    Example: A distinguished name for an LDAP entry can be represented as: 

    CN=AbcUser,CN=Users,DC=server,DC=company,DC=com. 

    In this example, to refer to the entire user list, you can remove the initial attribute, CN=AbcUser.

    Default value: [None]

    Note

    You can also use special characters in the Distinguished name field with the exception of forward slash "/". See the section Using Special Characters in Distinguished Name below.

    Group name*

    String

    N/A

    The name of the group as RDN (Relative distinguished name) in which you would like to remove the user.

    Example: CN=DemoGroup,CN=Users,DC=server,DC=company,DC=com

    Default value: [None]

    Note

    When removing a member from a group, make sure that the member and the group already exist. Members and groups can be created by the Create Entry Snap.

    Pass through

    Checkbox

    N/A

    Select to include the entire input data in the Snap's output. The Snap includes this data within the $original field in the output. 

    Default value: Not selected

    Snap Execution

    Dropdown

    N/A

    Select one of the three following modes in which the Snap executes:

    ...

    • Validate & Execute.

    ...

    •  Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime.

    ...

    • Execute only.

    ...

    •  Performs full execution of the Snap during Pipeline execution without generating preview data.

    ...

    • Disabled.

    ...

    •  Disables the Snap and all Snaps downstream from it

    ...

    Check boxes:

    ...

    If selected, <Snap behavior>.
    If selected, an empty file is written when the incoming document has no data.

    ...

    Select to <action>
    Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
    Select to execute the Pipeline during validation.

    Text Fields

    • Describe what the user shall specify in this field. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
      Enter the name for new account.
      Specify the account ID to use to log in to the endpoint.
      Required if IAM Role is selected.
      Do not use this field if you are using batch processing.

    Numeric Text Fields

    • Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
      The number of records in a batch.
      The number of seconds for which you want the Snap to wait between retries.
      The number of seconds for which the Snap waits between retries.
      Use the following special values:
      * 0: Disables batching.
      * 1: Includes all documents in a single request.

    Notes in field descriptions

    • Confluence’s new editor does not allow nesting of most macros inside another macro, especially the Note/Alert/Warning/Info (Panel) macros inside a table macro and Excerpt macros inside Expand or Panel Macro+ macros. So, as a workaround use the Footnotes approach as mentioned below:

      • Assign numbers at the Note locations in the form of follow through phrases like See Note 2 below this table. or such.

      • Add your Notes---an appropriate Note/Alert/Warning/Info (Panel) macro---immediately below the macro (for example, Table macro) beginning the content with the corresponding number assigned.

    Note

    Field names marked with an asterisk ( * ) are mandatory.

    Field Name

    Field Dependency

    Description

    • .

    ...

    Default Value: Execute Only
    Example: 

    Label*

    None.

    The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.

    Default Value: ELT Database Account
    Example: ELT RS Account

    Field set

    Specify advanced parameters that you want to include in the request.

    This field set consists of the following fields:

    • Field 1

    • Field 2

    • Field 3

    Field 1*

    Debug mode check box is not selected.

    Field 2

    None.

    Validate & Execute

    Troubleshooting

    Error

    Reason

    Resolution

    Account validation failed.

    The Pipeline ended before the batch could complete execution due to a connection error.

    Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.

    Examples

    Excluding Fields from the Input Data Stream

    We can exclude the unrequired fields from the input data stream by omitting them in the Input schema field set. This example demonstrates how we can use the <Snap Name> to achieve this result:

    <screenshot of Pipeline/Snap and description>

    Download this Pipeline. 

    Downloads

    Info

    1. Download and import the Pipeline into SnapLogic.

    2. Configure Snap accounts as applicable.

    3. Provide Pipeline parameters as applicable.

    Attachments
    patterns*.slp, *.zip
    sortByname

    ...

    See Also

    • Endpoint Doc Link 1

    • Endpoint Doc Link 2

    • Endpoint Doc Link 3

    ...

    Cannot remove the member

    Error while removing the member from the group. Entered values are invalid.

    Please verify the entered values for the distinguished name and group are valid.

    ...

    See Also

    Active Directory Add Member

    Active Directory Snap Pack

    https://docs-snaplogic.atlassian.net/wiki/spaces/SD/pages/1438341/Getting+Started

    ...