Out-of-the-box Service Configurations and Workflow Services (Legacy workflows)
The article list the out-of-the-box Service Configurations and Workflow Services (Legacy workflows) available in Luma Automation.
Service Configurations
Luma Automation provides various out-of-the-box Automation Services and workflows that can be used in skills to execute tasks. These are legacy workflows that are created and managed in Mulesoft. To establish a connection and perform a task, the services require Service Configurations such as server IP address, admin credentials, Secret keys, etc.
For example, To Enable a user in AD, the service requires AD Server connection details, username, and password to connect to AD Server. These inputs are not provided by the end-user while executing the service and are set by the Administrator for the tenant.
Following are the Services available in Luma Virtual Agent:
No. | Service | Description | Details | Service Configurations | |
---|---|---|---|---|---|
Key | Details | ||||
1 | Azure-Infra | Azure-Infra Configuration | The service is used to execute task in Azure infrastructure such as Create VM, Start VM, Stop VM. | config.azure-infra.accountname | Refers to your Azure account name |
config.azure-infra.accountpassword | Add Azure account password | ||||
2 | ISM | ISM Configuration | The service is used to connect to your Intelligent Management System (ISM) environment. | config.ism.slice-token | Refers to the ISM slice-token you want to connect to. |
config.ism.url | This is the URL to the ISM environment you want to connect to. | ||||
config.ism.user-auth-token | Refers to the user authentication token required to connect to your ISM environment. | ||||
config.ism.webservice-user-password | ISM web service password | ||||
config.ism.webservice-username | ISM web service username | ||||
3 | LDAP | LDAP Configuration | The service is used to execute task in your LDAP. You can manage users and execute tasks in the Active directory using the configuration. For example, Create User, Reset password, Delete user, etc. | config.ldap.url | Refers to your LDAP URL |
config.ldap.password | Refers to the LDAP password | ||||
config.ldap.principal.dn | Refers to the LDAP Distinguished Name required to connect to your LDAP. | ||||
4 | LUMA1x | LUMA1x Configuration | The service is used to connect to your Luma 1.x environment. | config.luma1x.url | This is the URL to the Luma 1.x environment you want to connect to. |
config.luma1x.luma.api.access.key | Refers to the API access key created in Luma to allow a third party system to connect to your tenant. | ||||
5 | LUMA2x | LUMA2x Configuration | The service is used to connect to your Luma Virtual Agent environment | config.luma2x.url | This is the URL to the Luma VSA environment you want to connect to. |
config.luma2x.luma.tenant.externalid | Refers to your Luma VSA Tenant External ID | ||||
config.luma2x.luma.api.access.key | Refers to the API access key created in Luma VSA to allow a third party system to connect to your tenant. | ||||
6 | Powershell | Powershell Configuration | The service configuration allows you to connect and execute Powershell Script. | config.powershell.password | Refers to the machine or environment password where you can execute PowerShell or winrm service is running. |
config.powershell.domain | Refers to the machine or environment windows domain name where you can execute PowerShell or winrm service is running. | ||||
config.powershell.username | Refers to the machine or environment username where you can execute PowerShell or winrm service is running. | ||||
config.powershell.address | Refers to the machine or environment address where you can execute PowerShell or winrm service is running. | ||||
7 | Twilio | Twilio Configuration | Twilio Configuration allows you to send messages through Twilio API. | config.twilio.sms.from | Refers to the Twilio phone number to be used to send the message. This must be a Twilio phone number that you own, formatted with a '+' and country code, e.g.+16175551212 (E.164format). |
config.twilio.sms.account.sid | Represents the Messaging Service SID to be used to send the SMS. When you use a Messaging Service SID, Twilio will automatically send your message using one of the phone numbers in your service pool. | ||||
config.twilio.sms.auth.token | This is the authentication token required to connect to the Twilio API to send SMS. |
Out-of-the-box Workflow Services and Input Parameters
For the above Service Configurations, Luma Virtual Agent supports the following are the out-of-the-box Service workflows available in Luma Virtual Agent. You can add the Workflow Services and input parameters to your Skill as Conversation Item and execute the automation task.
Input Parameters are the inputs required by the workflow and provided by the user who is executing the service (generally changes with every execution) for example, username in Enable AD user workflow.
No. | Workflow Service | Service Configurations Required | Description | Input Parameters | Example |
---|---|---|---|---|---|
1 | Azure createVM | Azure-Infra, Powershell | Creates a new VM with the given details. | Username | Azure Username for the VM (Administrator account for the VM) |
Password | Azure Password for the VM | ||||
Name | VM Name | ||||
Resource Group Name | Resource Group Name | ||||
Location | Azure Region | ||||
Virtual Network Name | Virtual Network where VM should be created | ||||
Subnet Name | The Subnet where VM should be created | ||||
Security Group Name | Network Security Group Name | ||||
Public IP Address Name | The Public IP address that allows the VM to be accessible over the internet. | ||||
Context Name | Temporary context name used during the creation of VM. | ||||
Update Message On Success | Message to be displayed on successful VM creation. | ||||
Update Message On Failure | Message to be displayed if an error occurred. | ||||
2 | Azure stopVM | Azure-Infra, Powershell | Stops VMware instance in Data center | Name | VM Name |
Resource Group Name | Resource Group Name | ||||
Update Message On Success | Message to be displayed on stopping the VM. | ||||
Update Message On Failure | Message to be displayed if an error occurred. | ||||
3 | Azure removeVM | Azure-Infra, Powershell | Deletes VM instance from Data center | Name | VM Name |
Resource Group Name | Resource Group Name | ||||
Update Message On Success | Message to be displayed on removing the VM. | ||||
Update Message On Failure | Message to be displayed if an error occurred. | ||||
4 | Azure startVM | Azure-Infra, Powershell | Starts VMware instance in Data center | Name | VM Name |
Resource Group Name | Resource Group Name | ||||
Update Message On Success | Message to be displayed on starting the VM. | ||||
Update Message On Failure | Message to be displayed if an error occurred. | ||||
5 | Azure execute Powershell Script | Azure-Infra, Powershell | Executes the Powershell script in the file | Update Message On Success | Message to be displayed on the successful execution of Powershell script. |
Update Message On Failure | Message to be displayed if an error occurred. | ||||
File Path | PowerShell script file absolute path. Note: To use the operation, the PowerShell script must be available on the PowerShell machine. | ||||
File Params | Parameters required to execute the shell script. | ||||
6 | Ldap Delete User | Powershell | Deletes the AD user from LDAP | Update Message On success | Message to be displayed on deleting the user |
Update Message On Failure | Message to be displayed if an error occurred. | ||||
SAM Account Name | User SAM Account Name(logon name) | ||||
7 | Ldap Delete Group | Powershell | Deletes the Group from LDAP | Update Message On success | Message to be displayed on deleting the group |
Update Message On Failure | Message to be displayed if an error occurred. | ||||
Group SAM Account Name | Group SAM Account Name | ||||
8 | Ldap Rename User | LDAP | Rename the AD user in LDAP | Update Message On success | Message to be displayed on renaming the user |
Update Message On Failure | Message to be displayed if an error occurred. | ||||
New Distinguished Name | New user name | ||||
Current Distinguished Name | Old user name | ||||
Ldap Search User | Powershell | Search for the user in LDAP | Update Message On success | Message to be displayed on success | |
Update Message On Failure | Message to be displayed if an error occurred. | ||||
Filter | Filter criteria for the search | ||||
10 | Ldap Exists User | Powershell | Find if the user already exists in LDAP | Update Message On success | Message to be displayed on success |
Update Message On Failure | Message to be displayed if an error occurred. | ||||
SAM Account Name | User SAM Account Name(logon name) | ||||
11 | Ldap Single Value Modify | LDAP | Modify the Attribute in LDAP | Update Message On success | Message to be displayed on success |
Update Message On Failure | Message to be displayed if an error occurred. | ||||
Distinguished Name | LDAP Distinguished Name (DN) | ||||
Attribute Name | Attribute Name to be updated | ||||
Attribute Value | Attribute Value | ||||
12 | Ldap Change Password | Powershell | Resets AD user password for a given login name | Password | New Password |
Update Message On success | Message to be displayed on successful password change | ||||
Update Message On Failure | Message to be displayed if an error occurred. | ||||
SAM Account Name | User SAM Account Name(logon name) | ||||
SMS TO | Phone number to which the Self Service Password Reset service sends SMS. | ||||
SMS Body | Specify the SMS message to be sent when changing the password | ||||
13 | Ldap enable User | Powershell | Enables the AD user | Update Message On success | Message to be displayed on enabling the user |
Update Message On Failure | Message to be displayed if an error occurred. | ||||
SAM Account Name | LDAP SAM Account Name | ||||
14 | Ldap disable User | Powershell | Disables the AD user | Update Message On success | Message to be displayed on disabling the user |
Update Message On Failure | Message to be displayed if an error occurred. | ||||
SAM Account Name | User SAM Account Name(logon name) | ||||
15 | Ldap change password at logon | Powershell | Resets AD user password for a given login name at logon | Password | New Password |
Update Message On success | Message to be displayed on successful password change | ||||
Update Message On Failure | Message to be displayed if an error occurred. | ||||
SAM Account Name | User SAM Account Name(logon name) | ||||
SMS TO | Phone number to which the Self Service Password Reset service sends SMS. | ||||
SMS Body | Specify the SMS message to be sent when changing the password | ||||
16 | Ldap create User | Powershell | Creates new user in Active Directory | Password | Password for the new user account |
Update Message On success | Message to be displayed on successful creation of user in LDAP | ||||
Update Message On Failure | Message to be displayed if an error occurred. | ||||
First Name | User's firstname | ||||
Last Name | User's last name | ||||
Login Name | User's login name | ||||
User Principal Name | a logon name that takes the form of an e-mail address | ||||
Employee id | User's Employee id | ||||
Path | Qualified path of LDAP | ||||
17 | Ldap Unlock User | Powershell | Unlocks Active Directory (AD) user | Update Message On success | Message to be displayed on success |
Update Message On Failure | Message to be displayed if an error occurred. | ||||
SAM Account Name | User SAM Account Name(logon name) | ||||
18 | Ldap create Group | Powershell | Creates New Group in Active directory for that AD domain | Update Message On success | Message to be displayed on success |
Update Message On Failure | Message to be displayed if an error occurred. | ||||
SAM Account Name | LDAP SAM Account Name for Group | ||||
Path | Qualified path of LDAP | ||||
Group Name | New Group name | ||||
Group Category | Group Category | ||||
Group Scope | Group scope | ||||
Description | Group Description | ||||
19 | Ldap add User To Group | Powershell | Adds a user to a group | Update Message On success | Message to be displayed on success |
Update Message On Failure | Message to be displayed if an error occurred. | ||||
Group SAM Account Name | LDAP Group SAM Account Name | ||||
User SAM Account Name | LDAP User SAM Account Name (logon name) |
In addition to the required Service configurations, Luma 2.x Service configuration must be configured to use the Workflow Services in a skill.