Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 4 Next »

 

Activities

 

Connect to Orchestrator

This activity connects to the Microsoft Orchestrator Server.

Activity Parameters

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

Parameters:

  • Orchestrator URL (text box editor type) (type: string): the Orchestrator URL in the following format: "http://10.201.0.1:81/Orchestrator2012/Orchestrator.svc".
  • 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).
  • Username (text box editor type) (type: string): the username to connect to the Orchestrator Server . The accepted format is domain\username or username.

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

  • Connection (type: object): outputs an Orchestrator Connection. This parameter should be used as input for all Connection parameters used for activities placed under Microsoft System Center category.
 

Execution:

 

 

Disconnect from Orchestrator

This activity disconnects from Orchestrator Server.

Activity Parameters

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

Parameters:

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

 

Get Runbook

This activity retrieves details about a specified Runbook.

Activity Parameters

The Get Runbook 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). Flowster Studio provides the following options:
    • sAMAccountName
    • Name
    • Display Name
    • OU
    • CN
    • Distinguished Name
  • Filter Value (text box editor type) (type: string): the value (for the 'Filter by' parameter) by which you want to filter the results. If there is desired to be returned all the results, the leave the field empty (as seen in the screenshot above)
  • Location (text box editor type) (type: string): the Active Directory path from where you want to retrieve the entries. The accepted format should be written as in the given example: "LDAP://VSRPDC201.FMRP.intern/OU=Groups,OU=__DEV-Testing,DC=FMRP,DC=intern":

  • Object Class (combo box control) (type: string): choose the class of the entries you want to retrieve. Flowster Studio provides the following options:
    • User
    • Group
    • Computer
    • OU

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.
 

 

Execution: the activity will check the provided location path and if found, will return the objects stored within (groups, user, computers or OUs, depends on the used filter). The example below is an execution where all the groups from the Groups OU were returned:

 

 

In order to extract the values from the output collection (in our case the output is a Collection(Of Collection(Of Collection(Of String))) ), several For Each and Get Element From Collection activities should be used:

 

 

The first For Each is used to extract a first collection from the output collection, the variable being of type Collection<Of Collection<Of Collection<Of String>>>. The extracted Collection<Of Collection<Of String>> will be assigned to the Iterator variable.

The second For Each is used to extract a second collection from the Iterator collection, the Iterator being of type Collection<Of Collection<Of String>>. The extracted Collection<<Of String> will be assigned to the Iterator1 variable.

The Get Element From Collection activity will take the Iterator1 as the Collection Input, extracting the String's value from it.

 

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. Flowster Studio provides the following options:
    • sAMAccountName
    • Name
    • Display Name
    • Distinguished Name
    • OU
    • CN
  • Value (text box editor type) (type: string): the value for selected attribute.

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

  • Output (type: object): outputs entry object from Active Directory, in the System.DirectoryServices.DirectoryEntry format

  • 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:
 

 

Execution: the activity will search the Active Directory for the given input and if found, it will return its values:

 

 

 

 

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 for the account, in this case the entry for an user account. The entry can be linked to a variable outputed by the GetEntry activity (for GetEntry binding usage, see the Add Computer To Group activity) or written by hand. The accepted format should be written as in the given example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingUser,OU=Users,OU=__DEV-Testing,DC=FMRP,DC=intern":

  • Selected Attribute (text box editor type) (type: string): specify an attribute for which you want a separate output. This parameter is used when it is desired for the activity to return only the value(s) for a single attribute (e.g. sAMAccountName)

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

  • Output (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: 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.
 

 

Execution: the activity will check the provided entry path and if found, will return the values for all attributes (if the Selected Attribute field is empty) or just for a single attribute (if the Selected Attribute parameter contains a value):

 

 

In order to extract the values from the output collection (in our case the output is a Collection(Of Collection(Of String)) ), For Each and Get Element From Collection activities should be used:

 

 

The For Each is used to extract a single collection from the output collection, the output collection being of type Collection<Of Collection<Of String>>. The extracted Collection<<Of String> will be assigned to the Iterator variable.

The Get Element From Collection activity will take the Iterator as the Collection Input, extracting the String's value from it.

 

 

 

 

Get Password Expiration Date

This activity returns the password expiration date.

Activity Parameters

The Get Password Expiration Date 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 for the account, in this case the entry for an user account. The entry can be linked to a variable outputed by the GetEntry (for GetEntry binding usage, see the Add Computer To Group activity) activity or written by hand. The accepted format should be written as in the given example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingUser,OU=Users,OU=__DEV-Testing,DC=FMRP,DC=intern":

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

  • Output Date (type: Nullable<DateTime>): outputs the expiration date for the specified period. If NULL is returned then the user password never expires. 
  • Output Days (type: int32): outputs the number of days until/since the expiration date. If it is negative it means that the password is already expired.

 

 

Get Entry SID

This activity returns the SID object and a 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 for the account, in this case the entry for an user account. The entry can be linked to a variable outputed by the GetEntry activity (for GetEntry binding usage, see the Add Computer To Group activity) or written by hand. The accepted format should be written as in the given example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingUser,OU=Users,OU=__DEV-Testing,DC=FMRP,DC=intern":

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.

 

Execution: the activity will check the provided entry path and if found, will return the SID object in object and string formats:

 

 

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 for the account, in this case the entry for an user account. The entry can be linked to a variable outputed by the GetEntry activity (for GetEntry binding usage, see the Add Computer To Group activity) or written by hand. The accepted format should be written as in the given example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingUser,OU=Users,OU=__DEV-Testing,DC=FMRP,DC=intern":

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.

 

Execution: the activity will retrieve all statuses for the given entry:

 

 

 

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 entry for the account, in this case the entry for an user account. The entry can be linked to a variable outputed by the GetEntry activity (for GetEntry binding usage, see the Add Computer To Group activity) or written by hand. The accepted format should be written as in the given example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingUser,OU=Users,OU=__DEV-Testing,DC=FMRP,DC=intern":

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.
 

 

Execution: the activity will retrieve all the groups where the given entry is a member of:

 

 

 

 

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. This value can be used when no path is given for the group
  • Group Path (text box editor type) (type: string): the entry for the group. The entry can be linked to a variable outputed by the GetEntry activity (for GetEntry binding usage, see the Add Computer To Group activity) or written by hand. The accepted format should be written as in the given example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingGroup,OU=Groups,OU=__DEV-Testing,DC=FMRP,DC=intern":

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.
 

 

Execution: the activity will retrieve all the users which are members of the given group:

 

 

 

 

 

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'. There can also be used other attributes, like for example Name or displayName
  • Value (text box editor type) (type: string): the value for selected attribute in Check Entry By parameter. Here can be provided the name of the group, for example, as seen in the screenshot

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.
 

Execution: the activity will search after the given value (a sAMAccountName, a Name, a Display Name or othet values that the provided attribute can take) and if it finds the object, will return True, otherwise it will return False:

 

 

 

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 for the user. The entry can be linked to a variable outputed by the GetEntry activity (for GetEntry binding usage, see the Add Computer To Group activity) or written by hand. The accepted format should be written as in the given example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingUser,OU=Users,OU=__DEV-Testing,DC=FMRP,DC=intern":

  • Group Path (text box editor type) (type: string): the entry for the group. The entry can be linked to a variable outputed by the GetEntry activity (for GetEntry binding usage, see the Add Computer To Group activity) or written by hand. The accepted format should be written as in the given example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingGroup,OU=Groups,OU=__DEV-Testing,DC=FMRP,DC=intern":

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.
 

Execution: the activity will search if the given user (Entry Path parameter) is a member of the given group (Group Path parameter). If yes, it will return True, otherwise False:

 

 

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 for the user. The entry can be linked to a variable outputed by the GetEntry activity (for GetEntry binding usage, see the Add Computer To Group activity) or written by hand. The accepted format should be written as in the given example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingUser,OU=Users,OU=__DEV-Testing,DC=FMRP,DC=intern":

  • Entry New Location (text box editor type) (type: string): the entry for the new location (in this example a group is given). The entry can be linked to a variable outputed by the GetEntry activity (for GetEntry binding usage, see the Add Computer To Group activity) or written by hand. The accepted format should be written as in the given example: "LDAP://VSRPDC201.FMRP.intern/OU=Users,OU=__DEV-Demo,DC=FMRP,DC=intern":

 

Execution: the activity will move the user into the new location. In the screenshot below, there can be seen the user in the new location, in Active Directory:

 

 

 

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 for the computer. The entry can be linked to a variable outputed by the GetEntry activity (for GetEntry binding usage, see the Add Computer To Group activity) or written by hand. The accepted format should be written as in the given example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingMachine,OU=Computers,OU=__DEV-Testing,DC=FMRP,DC=intern":

  • Group (text box editor type) (type: string): the entry for the group where the computer is a member of. The entry can be linked to a variable outputed by the GetEntry activity (for GetEntry binding usage, see the Add Computer To Group activity) or written by hand. The accepted format should be written as in the given example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingGroup,OU=Groups,OU=__DEV-Testing,DC=FMRP,DC=intern":

 

Execution: the activity will remove the given computer from the given group. The output will display both the computer and the group AD paths and their DN (distinguished names):

 

 

 

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 entry path of the group where the other group is a member of, or bind this parameter with the output parameter of a Get Entry activity (for GetEntry binding usage, see the Add Computer To Group activity). If the Group Entry Path will be manually inserted, the accepted format should be written like in the following example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingGroup,OU=Groups,OU=__DEV-Testing,DC=FMRP,DC=intern"

  • Group To Be Removed (text box editor type) (type: string): the entry path of the group that will be removed from the group, or bind this parameter with the output parameter of a Get Entry activity (for GetEntry binding usage, see the Add Computer To Group activity). If the Group Entry Path will be manually inserted, the accepted format should be written like in the following example: "LDAP://VSRPDC201.FMRP.intern/CN=DemoGroup,OU=Groups,OU=__DEV-Testing,DC=FMRP,DC=intern"

Execution: the activity will search if the provided entry paths are valid and if yes, it will remove the indicated group from the other group. The output will display both the groups AD paths and their DN (distinguished names):

 

 

 

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 entry path of the group where the user is a member of, or bind this parameter with the output parameter of a Get Entry activity (for GetEntry binding usage, see the Add Computer To Group activity). If the Group Entry Path will be manually inserted, the accepted format should be written like in the following example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingGroup,OU=Groups,OU=__DEV-Testing,DC=FMRP,DC=intern"

  • User (text box editor type) (type: string): the entry path of the user that will be removed from the group, or bind this parameter with the output parameter of a Get Entry activity (for GetEntry binding usage, see the Add Computer To Group activity). If the Group Entry Path will be manually inserted, the accepted format should be written like in the following example: "LDAP://VSRPDC201.FMRP.intern/CN=TestingUser,OU=Users,OU=__DEV-Testing,DC=FMRP,DC=intern"

Execution: the activity will search if the provided entry paths are valid and if yes, it will remove the indicated user from the other group. The output will display both the user and the group AD paths and their DN (distinguished names):

 

 

 

 

Rename Entry

This activity gives new value(s) to an AD attribute that needs to be renamed (for example, the name attribute needs a different method for assigning a new value that edit).

Activity Parameters

The Rename 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. Flowster Studio provides the following options:
    • sAMAccountName
    • Name
    • Display Name
    • Distinguished Name
    • OU
    • CN
  • New Name (text box editor type) (type: string): the new value for selected attribute.
  • Value (text box editor type) (type: string): the value for selected attribute. In this case, here can be inserted the old value for the selected attribute

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

  • Output (type: object): outputs entry object from Active Directory, in the System.DirectoryServices.DirectoryEntry format

  • Output Entry Path : outputs the resulted entry path. This output can be used by the most of the Active Directory activities as an entry value:
 

 

Execution: the activity will search the Active Directory for the given input and if found, it will rename it:

 

 

 

 

 

 

Rename Entry

This activity gives new value(s) to an AD attribute that needs to be renamed (for example, the name attribute needs a different method for assigning a new value that edit).

Activity Parameters

The Rename 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. Flowster Studio provides the following options:
    • sAMAccountName
    • Name
    • Display Name
    • Distinguished Name
    • OU
    • CN
  • New Name (text box editor type) (type: string): the new value for selected attribute.
  • Value (text box editor type) (type: string): the value for selected attribute. In this case, here can be inserted the old value for the selected attribute

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

  • Output (type: object): outputs entry object from Active Directory, in the System.DirectoryServices.DirectoryEntry format

  • Output Entry Path : outputs the resulted entry path. This output can be used by the most of the Active Directory activities as an entry value:
 

 

Execution: the activity will search the Active Directory for the given input and if found, it will rename it:

 

 

 

 

 

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. In this case, the sAMAccountName of the user can be given. If displayName is selected in the Check Entry By field, then here the display name value will be inserted

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.
 

Execution: the activity will search the Active Directory for the given input and if found, it will return True, otherwise False:

 

  • No labels