Activities

Connect to eDirectory

This activity connects to eDirectory.The Output of this activity should be used as input for all Connection parameters used for activities placed under eDirectory category.

Activity Parameters

The Connect to eDirectory activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Ldap Host (text box editor type) (type: string): the eDirectory Ldap Host.
Ldap Port (text box editor type) (type: Int32): the eDirectory port.
Login DN (text box editor type) (type: string): the login DN used for connecting to eDirectory.
Password (password editor type) (type: string): the password for the provided username.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the connection. (This parameter is used only when the user wants to send an encripted password from outside the task, for example Flowster Portal).
Root (combo box control) (type: string): the root type: LDAP or GC.
Secure Connection (combo box control) (type: string): this can be used as input when you need a secure connection.
Username (text box editor type) (type: string): the the username of the SQL Server Administrator.

The Read Only Output variable are the possible output values that the activity will provide:

Connection (type: object): outputs an Active Directory Connection. This parameter should be used as input for all Connection parameters used for activities placed under Active Directory category.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Connect to Active Directory activity:

Disconnect from Active Directory

This activity disconnects from Active Directory.

Activity Parameters

The Disconnect from Active Directory activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection (text box editor type) (type: object): the Active Directory Connection. The output parameter from Connect To Active Directory activity should be used as Input here.

Add Computer to Group

This activity adds a computer to specified group.

Activity Parameters

The Add Computer to Group activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Computer (text box editor type) (type: string): the the entry path of the computer or bind this parameter with the output parameter of a Get Entry activity.
Group (text box editor type) (type: string): the the LDAP path for the group bind this parameter with the output parameter of a Get Entry activity.

Add Group to Group

This activity adds a group to another group.

Activity Parameters

The Add Group to Group activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Connection: the connection object output by the Connect To Active Directory activity.
Group (text box editor type) (type: string): the LDAP path for the group bind this parameter with the output parameter of a Get Entry activity.
Group to be Added (text box editor type) (type: string): the entry path of the group to be added or bind this parameter with the output parameter of a Get Entry activity.

Add User to Group

This activity adds specified user to specified group.

Activity Parameters

The Add User to Group activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Group (text box editor type) (type: string): the LDAP path for the group bind this parameter with the output parameter of a Get Entry activity.
User (text box editor type) (type: string): the entry path of the user or bind this parameter with the output parameter of a Get Entry activity.

Change User Password

This activity changes the password of a user account.

Activity Parameters

The Change User Password activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Entry (text box editor type) (type: string): the entry path or bind this parameter with the output parameter of a Get Entry activity.
Password (password editor type) (type: string): the password for the provided username.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password. (This parameter is used only when the user wants to send an encrypted password from outside the task, for example Flowster Portal).

Computer Exists

This activity checks in the Active Directory if specified computer has an entry in 'Computer' class.

Activity Parameters

The Computer Exists activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Check Entry By (text box editor type) (type: string): specify Active Directory attribute; default value is set to 'sAMAccountName'.
Value (text box editor type) (type: string): the value for selected attribute in Check Entry By parameter.

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: boolean): outputs True or False to reflect if computer exists or not in the specified AD path.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Computer Exists activity:

Create Computer

This activity creates a new entry of class 'Computer' in Active Directory.

Activity Parameters

The Create Computer activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Attributes (text box editor type) (type: string): enter computer specific Attributes for the new created computer.
CN String (text box editor type) (type: string): the CN String value of the place where the computer will be created. For Example: 'CN=TEST'.
CSV Attributes (text box editor type) (type: string): overrides the 'Attributes' parameter. The values must be entered with the format: "Attribute1Name,Attribute1Value;Attribute2Name,Attribute2Value".
Parent Entry (text box editor type) (type: string): the parent entry for the new created computer.
sAMAccountName (text box editor type) (type: string): the sAMAccountName for the new computer.

The Read Only Output variable are the possible output values that the activity will provide:

Entry Path (type: string): outputs the path of the new created computer.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Create Computer activity:

Create Group

This activity creates a new entry of class 'Group' in Active Directory.

Activity Parameters

The Create Group activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Attributes (text box editor type) (type: string): enter group specific Attributes for the new created group.
CN String (text box editor type) (type: string): the CN String value of the place where the group will be created. For Example: 'CN=TEST'.
CSV Attributes (text box editor type) (type: string): overrides the 'Attributes' parameter. The values must be entered with the format: "Attribute1Name,Attribute1Value;Attribute2Name,Attribute2Value".
Group Type (combo box control) (type: string): choose the type of the group you want to create.
Parent Entry (text box editor type) (type: string): the parent entry for the new created group.
sAMAccountName (text box editor type) (type: string): the sAMAccountName for the new group.

The Read Only Output variable are the possible output values that the activity will provide:

Entry Path (type: string): outputs the path of the new created group.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined variables, ready to be used by the Create Group activity:

Create User

This activity creates a new entry of class 'User' in Active Directory.

Activity Parameters

The Create User activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Attributes (text box editor type) (type: string): enter user specific Attributes for the new created group.
CN String (text box editor type) (type: string): the CN String value of the place where the user will be created. For Example: 'CN=TEST'.
CSV Attributes (text box editor type) (type: string): overrides the 'Attributes' parameter. The values must be entered with the format: "Attribute1Name,Attribute1Value;Attribute2Name,Attribute2Value".
Parent Entry (text box editor type) (type: string): the parent entry for the new created user.
Password (text box editor type) (type: string): the password for the User.
Password Binding (text box editor type) (type: string): bind to a variable containing the encrypted password for the User. (This parameter is used only when the user wants to send an encripted password from outside the task, for example Flowster Portal)
sAMAccountName (text box editor type) (type: string): the sAMAccountName for the new user.

The Read Only Output variable are the possible output values that the activity will provide:

Entry Path (type: string): outputs the path of the new created user.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Create User activity:

Delete Entry

This activity deletes specified entry from Active Directory.

Activity Parameters

The Delete Entry activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Entry (combo box control) (type: string): the entry path or bind this parameter with the output parameter of a Get Entry activity.

Edit Computer Account Status

This activity allows Enable/Disable for an Active Directory computer account.

Activity Parameters

The Edit Computer Account Status activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Action (combo box control) (type: string): choose to Enable/Disable the specified computer account.
Entry (text box editor type) (type: string): the entry path or bind this parameter with the output parameter of a Get Entry activity.

The Read Only Output variable are the possible output values that the activity will provide:

Output Status (type: boolean): outputs the result status. If the operation succeeded then TRUE, otherwise FALSE.

Edit Entry

This activity edits specified attribute values of a specified input entry.

Activity Parameters

The Edit Entry activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Attribute (text box editor type) (type: string): the attribute for which you want to edit values.
Attributes (text box editor type) (type: string): the attributes as a collection for the AD entry that you want to edit.
CSV Attributes (text box editor type) (type: string): overrides the 'Attributes' parameter. The values must be entered with the format: "AttributeName1,Attribute1Value;Attribute2Name,Attribute2Value".
Date Format (text box editor type) (type: string): if 'Value Type' is 'DateTime', enter the date format string. For example: dd.MM.yyyy; if no value is entered, the system defaults are used.
Entry (text box editor type) (type: string): the entry path or bind this parameter with the output parameter of a Get Entry activity.
Value Type (combo box control) (type: string): choose Data type for the edited value.
Value(s) (text box editor type) (type: string): enter value(s) for attribute, separated by ','.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Edit Entry activity:

Edit User Account Status

This activity allows Enable/Disable or Lock/Unlock for an Active Directory account.

Activity Parameters

The Edit User Account Status activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Action (combo box control) (type: string): choose to Enable/Disable or Lock/Unlock the specified user account.
Attempts (text box editor type) (type: string): the number of allowed bad password attempts.
Entry (text box editor type) (type: string): the entry path or bind this parameter with the output parameter of a Get Entry activity.

The Read Only Output variable are the possible output values that the activity will provide:

Output Status (type: boolean): outputs the result status. If the operation succeeded then TRUE, otherwise FALSE.

Get Entries by Filter

This activity retrieves a collection of Active Directory entries (paths) based on the input filters.

Activity Parameters

The Get Entries by Filter activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Filter By (combo box control) (type: string): the property name by which you want to filter the results (ex: name, sAMAccountName).
Filter Value (text box editor type) (type: string): the value (for the 'Filter by' parameter) by which you want to filter the results.
Location (text box editor type) (type: string): the Active Directory path from where you want to retrieve the entries.
Object Class (combo box control) (type: string): choose the class of the entries you want to retrieve.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Get Entries by Filter activity:

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: collection<collection<collection<string>>>): returns a collection of entries (their paths and attributes).To use the elements of the collection, use Get Element From Collection activity.
Output Rows (type: int32): outputs the number of rows retrieved.

Get Entry

This activity gets specified entry from Active Directory.

Activity Parameters

The Get Entry activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Get Entry By (combo box control) (type: string): select the Active Directory attribute.
Value (text box editor type) (type: string): the value for selected attribute.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Get Entry activity:

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: object): outputs entry object from Active Directory.
Output Entry Path : outputs the resulted entry path. This output will be used by the most of the Active Directory activities as an entry value.

Get Entry Attributes

This activity gets specified entry and retrieves a collection containing the attributes and their corresponding values.

Activity Parameters

The Get Entry Attributes activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Entry (text box editor type) (type: string): the entry path or bind this parameter with the 'Output entry path' parameter of a Get Entry activity.
Selected Attribute (text box editor type) (type: string): specify an attribute for which you want a separate output.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Get Entry Attributes activity:

The Read Only Output variable are the possible output values that the activity will provide:

: outputs a collection of Groups and their AD paths.To use the elements of the collection, use Get Element From Collection activity.
Output Rows Count: output Rows Count.
Selected Attribute Multiple Output: outputs a collection of values of the specified 'Selected Attribute' parameter.To use the elements of the collection, use Get Element From Collection activity.
Selected Attribute Single Output: outputs a single value (first) of the specified 'Selected Attribute' parameter.

Get Entry SID

This activity returns the SID object and string equivalent of an AD Entry.

Activity Parameters

The Get Entry SID activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Entry (text box editor type) (type: string): the entry path or bind this parameter with the output parameter of a Get Entry activity.

The Read Only Output variable are the possible output values that the activity will provide:

SID (type: string): SID string of the specified AD Entry.
SID Object (type: byte[ ]): an array of byte representing the SID Object.

Get Account Expires

This activity returns the value of AD property 'accountExpires'.

Activity Parameters

The Get Account Expires activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Entry (text box editor type) (type: string): the entry path or bind this parameter with the output parameter of a Get Entry activity.

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: string): outputs the value of the 'accountExpires' property as String.

Get User Account Status

This activity returns information about an entry, regarding the account status,password,account expiration date, email.

Activity Parameters

The Get User Account Status activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Entry (text box editor type) (type: string): the entry path or bind this parameter with the output parameter of a Get Entry activity.

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: collection<string>): outputs a collection of attributes and their values for the specified entry.
Output Status (type: boolean): outputs the result status. If the operation succeeded then TRUE, otherwise FALSE.

Get User Groups

This activity retrieves a collection containing the groups the user is a member of.

Activity Parameters

The Get User Groups activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Entry (text box editor type) (type: string): the user entry path or bind this parameter with the output parameter of a Get Entry activity.

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: collection<collection<string>>): outputs a collection of Groups and their AD paths. To use the elements of the collection, use Get Element From Collection activity.
Output Rows Count (type: int32): outputs Rows Count of the returned values.

Get Users in Group

This activity retrieves a collection containing the users of a specified group.

Activity Parameters

The Get Users in Group activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Attributes (text box editor type) (type: string): the attributes to retrieve for found users, in addition to the 'Path' attribute, which is retrieved by default. The attributes must be separated by ','. For example: name,distinguishedName,sAMAccount.
Group Name (text box editor type) (type: string): the group name.
Group Path (text box editor type) (type: string): the group entry path or bind this parameter to the output parameter of Get Entry activity; this parameter overrides the 'Group Name' parameter.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Get Users in Group activity:

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: collection<collection<string>>): outputs a collection of Users and their AD paths.To use the elements of the collection, use Get Element From Collection activity.
Output Rows Count (type: int32): outputs Rows Count for retrieved users.

Group Exists

This activity checks in the Active Directory if specified group has an entry in 'Groups' class.

Activity Parameters

The Group Exists activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Check Entry By (text box editor type) (type: string): specify Active Directory attribute; default value is set to 'sAMAccountName'.
Value (text box editor type) (type: string): the value for selected attribute in Check Entry By parameter.

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: boolean): outputs a boolean value to reflect if group exists or not in the specified AD path.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Group Exists activity:

Is Member

This activity validates if user, group or computer-account is member of a specified Active Directory group.

Activity Parameters

The Is Member activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Entry Path (text box editor type) (type: string): the entry path that you want to verify if it's a member of the specified group (for example the 'Output entry path' parameter value from a 'Get Entry' activity).
Group Path (text box editor type) (type: string): the group path (for example the 'Output entry path' parameter value from a 'Get Entry' activity).

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: boolean): outputs True if the Entry is member of the specified Group and False otherwise.

Move Entry

This activity moves a specified entry to a new location in Active Directory.

Activity Parameters

The Move Entry activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Entry (text box editor type) (type: string): the entry path of the user or bind this parameter with the output parameter of a Get Entry activity.
Entry New Location (text box editor type) (type: string): the new location path for entry.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Move Entry activity:

Remove Computer from Group

This activity removes specified computer from specified group.

Activity Parameters

The Remove Computer from Group activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Computer (text box editor type) (type: string): the entry path of the computer or bind this parameter with the output parameter of a Get Entry activity.
Group (text box editor type) (type: string): the LDAP path for the group.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Remove Computer from Group activity:

Remove Group from Group

This activity removes group from specified group.

Activity Parameters

The Remove Group from Group activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Group (text box editor type) (type: string): the LDAP path for the group.
Group to be Removed (text box editor type) (type: string): the entry path of the group you want to be removed or bind this parameter with the output parameter of a Get Entry activity.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Remove Group from Group activity:

Remove User from Group

This activity removes specified user from specified group.

Activity Parameters

The Remove User from Group activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Group (text box editor type) (type: string): the LDAP path for the group.
User (text box editor type) (type: string): the entry path of the user or bind this parameter with the output parameter of a Get Entry activity.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Remove User from Group activity:

Edit Account Expires

This activity sets the value of property 'accountExpires' for an Active Directory account.

Activity Parameters

The Edit Account Expires activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Date (text box editor type) (type: string): the date when you want the account to expire.
Date Format (text box editor type) (type: string): the Date format. For example 'dd.MM.yyyy' ,if no value is entered, the system defaults are used.
Entry (text box editor type) (type: string): the entry path or bind this parameter with the output parameter of a Get Entry activity.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the Edit Account Expires activity:

User Exists

This activity checks in the Active Directory if specified user has an entry in 'User' Class..

Activity Parameters

The User Exists activity parameters can be provided by manual inserted values or via IN arguments or variables:

Parameters:

Check Entry By (text box editor type) (type: string): specify Active Directory attribute; default value is set to 'sAMAccountName'.
Value (text box editor type) (type: string): the value for selected attribute in Check Entry By parameter.

The Read Only Output variable are the possible output values that the activity will provide:

Output (type: boolean): outputs a boolean value to reflect if user exists or not in the specified AD path.

As mentioned above, the values for all the required parameters can be provided by IN arguments or variables. Below is an example of predefined arguments, ready to be used by the User Exists activity: