This node allows you to create, retrieve, and update customer's information.
To use it, in the Studio platform, find the "ASE Client" node in the "Engageware" category and configure its parameters.
In the video, we'll show you how to access it and the parameters for configuring it:
Download an example of flows related to nodes in the Engageware category in Studio at this link.
Below, you also have the description of the properties mentioned in the video and Outputs
.
Properties:
- Name (optional): node name, which will override the default.
- Credentials (Required): these are the credentials of the Engageware Appointment Schedulinge Enterprise service, many credentials can be saved, but only one can be active. In the configuration, the url of the environment will be requested under the name "Instance URL" along with the username and password for API consumption (API user credentials) under the names "Username" and "Password".
- Action (Required): type of operation to be carried out, which can be:
- Search (get all fields for a specific customer): this operation allows you to perform a search using a criterion defined by the following properties:
- Client External Id (string): identification value determined for the client when it was created, this search parameter is used to obtain clients whose external ID matches the provisioned data.
- First Name (string): customer's primary name.
- Last Name (string): customer's last name.
- User Name (string): client Username
- Email Address (string): customer contact email.
- Phone Number (string): customer contact telephone number.
- Exact Match Only (boolean): strict search on provisioned data.
- Modified Since (dateTime): filter parameter with "modified from" criteria.
- Search (get all fields for a specific customer): this operation allows you to perform a search using a criterion defined by the following properties:
c. Create| Update: these operations allow you to create a client or update the properties of a previously created client.
- ClientExternalId (required for update): client ID in the Appointment Schedulinge Enterprise system, this ID can be any string if it is provisioned as property when the client is created, if it is not provided as property at the time of creation, an ID will be auto-generated.
- Client properties(required to create and update): properties that will be stored or updated for a specific customer.
Outputs:
1. Create:
msg.payload.metadata.EW_ASE_CreateClientResponse
Returns 0 in the "status" property if the creation has been successful. In the event of an error, the msg.payload.metadata.EW_ASE_CreateClientResponse.error will be returned.
2. Get
msg.payload.metadata.EW_ASE_GetClientResponse
Customer information will be returned in case of success. In case of error, the property msg.payload.metadata.EW_ASE_GetClientResponse.error will be returned.
3. Update
msg.payload.metadata.EW_ASE_UpdateClientResponse
Returns 0 in the "status" property if the update was successful. In the event of an error, the msg.payload.metadata.EW_ASE_UpdateClientResponse.error will be returned.