Chat now with support
Chat with Support

Password Manager 5.7.1 - Administrator Guide (AD LDS edition)

About Password Manager Getting Started Password Manager Architecture Management Policies
Checklist: Configuring Password Manager Understanding Management Policies Configuring Access to the Administration Site Configuring Access to the Self-Service Site Configuring Access to the Helpdesk Site Configuring Questions and Answers Policy Workflow Overview Custom Workflows Custom Activities Self-Service Workflows Helpdesk Workflows User Enforcement Rules
General Settings Password Policies Reporting Appendix A: Accounts Used in Password Manager for AD LDS Appendix B: Open Communication Ports for Password Manager for AD LDS Appendix C: Customization Options Overview Glossary About us

Custom Activity Settings

When you use custom activities in your workflows, you need to understand how shared settings of custom activities work.

All settings (display name, short name, description, PowerShell script, and user interface elements) that you specify for custom activities created from scratch are shared i.e. if you modify any of these settings for a custom activity included in or excluded from a workflow, the changes will be automatically propagated to all instances of this activity in all workflows and Management Policies.

If you create a custom activity by converting a built-in activity, the custom activity has two types of settings: built-in and shared. Built-in settings are the settings inherited from the built-in activity. Such settings are not shared: if you modify them, the changes will be applied only to the current activity instance. But if you modify the shared settings (display name, short name, description, PowerShell script), such changes will be propagated throughout all instances of this activity.

For example, if you modify the PowerShell script for your custom activity “My Custom CAPTCHA”, when you save the activity, the updated settings will be applied to all instances of the “My Custom CAPTCHA” activity used in other workflows and Management Policies. But if you modify the built-in setting (noise level) of the “My Custom CAPTCHA” activity, when you save the activity, the changes will be applied only to this instance of the activity. The noise level setting of other instances of the “My Custom CAPTCHA” activity will not be changed.

Creating Custom Activities

When you create a custom activity from scratch or by converting a built-in activity, the created custom activity in the Custom group of the activities list in the workflow designer. If you want to copy the created activity, hover over the activity in the left pane of the workflow designer, and click Copy.

Note, that this functionality is available only after you turn on the extensibility features.

To turn extensibility features on

  1. Open the Administration site and click the General Settings tab.
  2. On the General Settings page, select the Extensibility tab.
  3. On the Extensibility settings page, click the upper Turn on button.

To create a custom activity from scratch

  1. On the Administration site, open the workflow designer, expand the Custom group in the left pane, and click Add new custom activity.
  2. On the User Interface Designer tab, enter the main instruction for the activity in the default language. You can translate the main instruction text into other languages by clicking the Add new language link. This text will be displayed on the page of the Self-Service or Helpdesk site page when the activity is executed. Any user interface elements that you add will be displayed below the main instruction.
  3. To add user interface elements, click Add new element in the User interface elements section.
  4. In the Add New Element dialog box, select the user interface element you want to add, enter the element’s ID and label. Select the following options if required, and click OK:
    • Disable the element on the user interface - select this check box if you want to make this element disabled on the Self-Service or Helpdesk site.
    • Hide the element on the user interface - select this check box if you want to hide this element from the Self-Service or Helpdesk site.
  5. On the Activity Name tab, specify the following options:
    • Activity short name - the activity name that should be used in PowerShell scripts to refer to the activity.
    • Activity display name - the activity name displayed in the activities list and workflow designer
    • Activity description - your description of the custom activity.
  6. On the PowerShell Script tab, enter the PowerShell script to set the activity behavior. For more information on how to create and use activity scripts, refer to the Password Manager SDK.
  7. Click OK.

Any built-in activity (self-service or helpdesk) can be converted to a custom one by clicking the Convert to custom activity link on a built-in activity in the activities list or the workflow designer. If you want to copy the created activity, hover over the activity in the left pane of the workflow designer, and click Copy.

To convert a built-in activity to a custom activity

  1. On the Administration site, open the workflow designer, select the built-in activity you want to convert and click the Convert to custom activity link on the activity.
  2. Hover over the created activity and click the Shared settings link.
  3. On the Activity Name tab, specify the following options:
    • Activity short name - the activity name that should be used in PowerShell scripts to refer to the activity.
    • Activity display name - the activity name displayed in the activities list and workflow designer
    • Activity description - your description of the custom activity.
  4. On the PowerShell Script tab, enter the PowerShell script to set the activity behavior. For more information on how to create and use activity scripts, refer to the Password Manager SDK.
  5. Click OK.

Importing and Exporting Custom Activities

Using the import/export custom activity functionality you can effortlessly share and copy custom activities that you created. If you want to reuse a custom activity in another workflow, export the activity to an archive file and then import it to the required workflow.

Note, that you can import and export custom activities only.

Note, that this functionality is available only after you turn on the extensibility features.

To turn extensibility features on

  1. Open the Administration site and click the General Settings tab.
  2. On the General Settings page, select the Extensibility tab.
  3. On the Extensibility settings page, click the upper Turn on button.

To export custom activity

  1. On the Administration site, open the workflow designer, expand the Custom group in the left pane of the workflow designer, hover over the custom activity you want to export and click Export.
  2. Depending on your browser settings, specify where you want to save the archive file and download the archive.

When you import custom activities, note that existing custom activities with the same name will be replaced. You can back up existing activities by exporting them when prompted.

IMPORTANT: When you import custom activities, it is strongly recommended to audit activities’ scripts before using activities in a production environment, because security-sensitive information can be accessed via PowerShell scripts included in a custom activity. Import custom activities from a trusted source only.

To import custom activity

  1. On the Administration site, open the workflow designer, expand the Custom group in the left pane of the workflow designer, click Import custom activity.
  2. In the Import Custom Activity dialog box, click Upload to select the activity archive file and then click OK.

Removing Custom Activities

To remove a custom activity, click the Remove link on the custom activity in the workflow designer or in the activities list. Note, you can permanently remove the custom activity only if it is removed from all workflows where it is used first.

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating