Workflow and ServiceDesk Community

 View Only

Get User List 

Jun 13, 2012 09:40 AM

Get User List

Component definition

This component returns a list of users that are found in Active Directory.

Component icon

[Insert component icon image file here.]

Description of component output paths

The component output paths are described in the following table:

Property

Description

Found

This path is followed if a user list was found based on the search criteria.

Not Found

This path is followed if no user list was found based on the search criteria.

Error

This path is followed if Active Directory returned an error. The error is placed in the Error Message Name variable.

Description of component tabs and their properties

The properties on the Input tab in the Get User List component are listed and described in the following table:

Property

Description

Search Type

Lets you select whether to return a list of all users or a list of users based on search criteria.

Search Type options:

  • All Users

    Returns a list of all users.

  • Set of Fields

    Lists the criteria that you can set for your search. You can specify the user search criteria by setting one or more of the options.

Match Any Criteria

Lets you select whether all search criteria must be met.

The properties on the Output tab in the Get User List component are listed and described in the following table:

Property

Description

Error Message Name

The name of the error message variable

This variable gets populated with the error message, if one was received during the retrieval process. This error message is the only exception handling available for this component.

Found Users Variable Name

The name of the Found Users variable

This variable gets populated with the data of the found users.

The properties on the Settings tab in the Get User List component are listed and described in the following table:

Property

Description

Directory Searcher Timeout

Unknown

Component Class Name

The class name of this component. This property is not editable, but useful if you call Symantec support.

Description

The description of this component. This property lets you describe how the component is used. You can use it to provide any wanted documentation for this component.

This description is included in the model reports that are created when you click Plugins > Generate Business Model.

Location

The physical location of the top left point of this component on the workflow model.

Name

The name of this component. You can change the name.

If you changed the component name when you double-clicked it on the workflow model, the changed name appears here.

Override Background Color

This property lets you change the background color of this component.

To Do

This property lets you record what you still need to do with the component. Use this property to help you remember the configuration that you want to apply to this component.

The text that you enter for this property appears at the bottom of the component editor. If you enter text for this property, a checklist symbol appears on the component in the workflow model.

Is Enabled

This property lets you enable or disable the component. By default, components are enabled. When a component is disabled, it has no effect on the Project. Uncheck Is Enabled to disable the component.

  • Execution Outcome

    If a component with more than one outcome path is disabled, you must select which outcome path you want the component to take. Click the Execution Outcome drop-down list and select the outcome path for the workflow to follow.

  • Disabled Mapping

    If the component has output parameters, you must configure all output parameters with fixed data to pass on. This configuration can be performed in the Disabled Mapping option.

The properties on the Context tab in the Get User List component are listed and described in the following table:

Property

Description

Setup Properties Input Method

Unknown

Setup Properties Input Method options:

  • Get Settings From the Default Properties

    Lets you use the Active Directory settings in the project properties.

  • Custom Settings

    Lets you use unique Active Directory settings for this component only.

Server Name

Lets set up the value for the name of the Active Directory server.

Server Port

Lets you set up the value for the port that Active Directory uses

Authentication Token

Lets you set up the value for the security token that contains the Administrator account and the password for the Administrator account.

Domain

Lets you set up the value for the name of the Active Directory domain.

Container Option

Unknown

Container Option options:

  • Pick

    Unknown

  • Specify

    Unknown

Custom Container

Unknown

Container Type

Lets you select the branch of the Active Directory tree on which you want to perform the action.

Container Type options:

  • Entire Domain

    Unknown

  • Builtin

    Unknown

  • Users

    Unknown

  • Computers

    Unknown

  • Organization Unit

    Unknown

Organization Path

Lets you set up the path to the organization unit on which to perform the action.

Connection information

[If this component connects to a process or product outside Workflow, insert the definition of the connection string and/or authentication requirements to make that connection.]

Component settings

[Describe any setting options that change the way this component behaves.]

Use cases

[Name each use case that you include below.]

Example use case 1

[Describe the use case. Insert screen shots or package files. Insert a description of how the settings are configured. Insert additional information about the use case.]

Example use case 2

[Describe the use case. Insert screen shots or package files. Insert a description of how the settings are configured. Insert additional information about the use case.]

Statistics
0 Favorited
1 Views
0 Files
0 Shares
0 Downloads

Tags and Keywords

Related Entries and Links

No Related Resource entered.