| Connection |
Type of connection to use.
- Define Connection Inline: Define connection information within the
action step.
- Use Connection Alias: Define connection information using the
Connection Alias table. Using an alias eliminates the need to configure multiple
credentials and connection information profiles when using an action in multiple
environments. Likewise, if the connection information changes, you don't need to
update your custom action.
To learn more about connections and credentials, see credentials, connections, and aliases. |
| Connection Alias |
Connection & Credential alias record that the
system uses to run the action step. Users with the flow_designer or admin role
can create or select an associated Connection record. Using an alias eliminates
the need to configure multiple credentials and connection information profiles
when using an action in multiple environments. Likewise, if the connection
information changes, you don't need to update your custom action. To learn more
about connections and credentials, see credentials, connections, and aliases.
The credential value is displayed as a Password (2 Way
Encrypted) data pill on the data pane. Note: This field is available when Use
Connection Alias is selected from the Connection list.
|
| Credential Alias |
Credential alias that the system uses to run
the action step. Users with the flow_designer or admin role can create or select
an associated Connection record. Using an alias eliminates the need to configure
multiple credentials when using an action in multiple environments. Likewise, if
the credential information changes, you don't need to update your custom action.
To learn more about connections and credentials, see credentials, connections, and aliases.
The credential value is displayed as a Password (2 Way
Encrypted) data pill on the data pane. Note: This field is available when Define
Connection Inline is selected from the Connection
list. |
| Host |
Specify the fully-qualified domain name of the target
host where the system runs the action step. For example,
host.domain.com. Note: This field is only visible when the Connection is
Define Connection Inline. |
| Port |
Specify the communications port on which the target
host listens for connections. For example, 5985. Leave blank to use the default port. Note: This field is only visible when the Connection is
Define Connection Inline. |
| MID Application |
Specify the application the MID Server must
support to be eligible for selection. The system runs the action step from a MID
Server that supports the selected application. If you use a data pill for this field, the pill must reference the MID
Application's name, not the MID Application record. Note: This field is only visible when the
Connection is Define Connection
Inline. |
| Capabilities |
Capabilities the MID Server must support to be
eligible for selection. The system runs the action step from a MID Server that supports the
selected capabilities. Note: This field is only visible when the
Connection is Define Connection
Inline. |
| Remoting Type |
The location where the PowerShell script runs such as the MID or a remote
server.
- Explicit Remoting (Most Common): Establish a
connection with and run the script on a remote server.
- Implicit Remoting (Advanced): Run a script on a MID Server while importing
necessary modules from a remote server. If selected, define the
Remote name prefix and Modules to
import fields. For optimal performance, only import modules
necessary to the step. If blank, all available modules are imported from the
server.
- Run on a MID Server or have your script establish a remote
session: Run a script directly on a MID Server, or define
remoting specifications within the script. This value is the default.
Note: To invoke a function in a PowerShell script command
or PowerShell script file, the command must define the function param block if
the function has input parameters. This requirement applies to explicit and
implicit remoting. For additional information on param block, see Microsoft's
documentation on Windows Powershell parameters at https://technet.microsoft.com/. |
| Remote name prefix |
The file path, excluding file names, to the modules to load from the remote
server. Note: This field is only visible when the Remoting
Type is Implicit Remoting
(Advanced).
|
| Modules to import |
The comma-separated list of modules to import from the remote server at the
defined file path. Note: This field is only visible when the Remoting
Type is Explicit Remoting (Most Common) or
Implicit Remoting (Advanced). |
| Script type |
The type of script to run on the PowerShell host.
- Inline script: Enter the script to run in the
Command field of the step.
- MID Server Script File: Select the PowerShell script
to run from the MID Server Script Files [ecc_agent_script_file] table. This is the default value and
separates scripting logic from the action, enabling you to update the script
without having to modify and redeploy the action.
|
| MID Server
Script |
Pre-defined PowerShell script from the MID Server Script Files table
[ecc_agent_script_file]. Note: This field is only available if the
Script type is MID Server Script
File. |
| Script path |
Read-only path to the selected MID Server script. Note: This
field is only visible when the Script type is
MID Server Script File. |
| Input variables |
The optional name-value pairs that represent the values of PowerShell script
variables. You can use action inputs and data from other steps within the
PowerShell script. Define the following fields for each variable:
- Name: The name of the script variable to pass a value
to. The name cannot match a reserved or prohibited PowerShell variable. Some
variable names are reserved for internal processing and should not be used as
input variables. See Reserved variables in
PowerShell scripting variables.
- Type: The type of PowerShell variable. Select plain
text, encrypted, or boolean. If encrypted is selected, the value appears in
plain text in this field and is only encrypted when it passes to the ECC
Queue.
- Value: The value to map to the variable. Manually
enter a value, or drag a data pill into the field.
|
| Command |
The inline PowerShell script to run on the target host. Note: This field is
only visible when the Script type is Inline
script. |
