Server Module

There are some steps a robotic process must take to successfully start, execute, and complete on a resource. These default steps often require communication with the Appian RPA server. The Server low-code module contains methods that enable a robotic process's communication with the server, whether to retrieve information or send it to help a developer understand what's happening and when.

This page discusses the methods contained in the Server low-code module, which provides an easier and more robust development experience.

Developers who feel more comfortable working in the robotic process's code can use Java methods to configure server communication actions. These methods are contained in the Client module and can be found in the com.novayre.jidoka.client.api.IJidokaServer and com.novayre.jidoka.client.api.JUnitJidokaServer interfaces.

Using the Server low-code Module

The methods contained in the Server module group are helpful throughout a robotic process execution. As an execution completes, a robotic process may have to send resulting files to the server. These methods are often used in the robotic process's clean up workflow to help reset the resource. Use the communication methods to send messages to the execution log throughout the robotic process, which may be helpful for debugging.

The Server low-code module contains these methods:

  • Add file parameter to robot result: Specify the name of the file parameter to pass to the server during cleanup. This method accepts variables of type text. You can also enter the parameter name using plain text, a robotic process variable, or an expression. The files can be downloaded in the Output column on the List of executions page.
  • Add file to robot result: Specify the absolute path of the file to pass to the server during cleanup. This field accepts variables of type text. Enter a path using plain text, a robotic process variable, or an expression. The files can be downloaded in the Output column on the List of executions page.
  • Debug: Send a DEBUG message to the execution log.
  • Error: Send an ERROR message to the execution log.
  • Fatal: Send a FATAL message to the execution log.
  • Info: Send an INFO message to the execution log.
  • Protect desktop: Click the Protect? checkbox to prevent additional action on the desktop.
  • Register event: Register an event in the console to trigger an action outside of the robotic process.
  • Send screen: Send a screenshot to the console.
  • Trace: Send a TRACE message to the execution log.
  • Warn: Send a WARN message to the execution log.

For each of these methods, you can also configure the following AFTER COMPLETION parameters:

  • Wait before executing next action: Enter the number of seconds the robotic process waits before it continues to the next action in the workflow.
  • Take a screenshot: If you select this option, the robotic process takes a screenshot of the resource immediately after the action completes successfully.

Sending messages

As mentioned above, a robotic process may need to send a message to the server as part of its clean up workflow. However, you can use these methods at any time in the robotic process. The type of message you send depends on the type of event. For example, you may want to build logic into your robotic process to send an ERROR message when a particular action isn't completed successfully, but not send a message when it proceeds as expected.

To send a message to the execution log:

  1. Go to the Appian RPA Console and open the Robotic Processes tab.
  2. Open a robotic process configuration and navigate to an action in the workflow.
  3. Click the action and click the list icon 951644.png.
  4. From the Module tree, open the Server module and click Info or another method for your desired message type.
  5. Type the message you want to send the execution log. You can also use the expression editor to configure how the message is populated. To build a conditional message, use an if() statement in the expression. Note that the expression changes the message content, not the message type. To use a different message type, see below.
  6. Click OK.
  7. Click SAVE CHANGES in the page toolbar.

To send a different type of message (Info vs. Error, for example) based on a condition in your robotic process, integrate a conditional action into the workflow:

  1. Add a conditional action to the workflow.
  2. Click the action and click the list icon 951644.png.
  3. To write an expression for the condition, open the Appian Services module and click Evaluate expression. In this example, the expression simply evaluates if a robotic process variable exists. If it is null, we want to send an error message to the console:

    1
    2
    3
    
     if(isnull(pv!stockPrice),
     "error",
     "success")
    
  4. Choose where to save the output by selecting a variable in the Save Into field.
  5. Click OK.
  6. In the workflow, connect the conditional action to additional actions based on the possible outcomes. In this example, it would be two actions: one that uses the Error method and one that uses Info and continues the workflow as normal. You may not find it necessary to send a message when an action completes successfully, but we've included it here for demonstration.
  7. Name the connections so they match the possible outcomes exactly: error and success. rpa-server-msg-example.png

  8. Click SAVE CHANGES in the page toolbar.

This version of the Appian RPA documentation was written for Appian 21.1, and does not represent the interfaces or functionality of other Appian versions.
Open in Github

On This Page

FEEDBACK