Input and Output Parameters of a Self Help Project


You can define input and output parameters for every Self Help project component, i.e. resources and procedures.

  • Input parameters are used to modify the behavior of the object based on entry conditions.

    example  Redirection to the different branches of a procedure; pre-loading of information; authorized access to certain information

  • Output parameters are used to retrieve the values calculated by the object and send them to the execution context.

    example  Error returned when calling a connector; incident number sent to a procedure

Notes

  • Differences between input/output parameters and project variables:
    • The impact of input and output parameters is restricted to the objects using them and those calling them.
    • Project variables are common and visible to all objects.

Best Practice

  • Give a different name to each parameter so you can identify it easily.
  • Define the naming convention for all parameters in your Self Help project.
    • Naming rules: The parameter name usually starts with the letter p for parameter, followed by the type of parameter, e.g. in for an input parameter and out for an output parameter, and the value to which it applies.

      example  

      • pinDepartment: Input parameter related to the Department value
      • poutName: Output parameter related to the Name value
    • Writing rules: Case type used, e.g. lower or upper case, CamelCase or snake_case.

      example  pin_name; pOutMail

  • Create your input parameters in sub-procedures.

Screens description

Access: Edit mode in the Studio > select the component in the tree structure of the Self Help project > Properties view > Info tab. Click the link called Edit parameters. Open url.png See the procedure.

Specify only input parameters

Input icon.png will appear in the window for editing parameters if only input parameters can be specified. This is the case for Document, HTML content and Link resources.

        Input parameters.png

Specify input and output parameters

Input output icon.png will appear in the window for editing parameters if both input and output parameters can be specified. This is the case for Form and Sub-procedure resources as well as for all procedures.

The left pane is for specifying input parameters while the right is for specifying output parameters.

        Input output parameters.png

Specify parameters for a connector

Each connector has specific input parameters. Its two output parameters, however, are always the same, result and error.

        Connector parameters.png

Output parameters

  • error: Returns an error code when the call to the connector does not work correctly.
  • result: Result returned by the connector.

    example  Excel file data, JSON file

Procedures

How to specify the parameters of a component

Step 1: Select the component.

1. Select the Self Help project in the tree structure of the Explorer pane.

2. Click Tree expand icon.png to display the tree structure.

3. Click the component.

Step 2: Specify the parameters of the component.

1. Display the Properties view by selecting View > Properties in the menu.
The component's properties will appear.

2. Click Edit parameters.
The window for editing parameters specific to the component will appear.

3. Specify the input and output parameters depending on the type of component.

  • Click Add.
    A row will be added to the table of parameters.
  • Click each field in this row and specify the required values.
  • Repeat these actions for the other parameters.
  • Click Finish.
     

Delete a parameter

  • Select the row of the parameter you want to delete.
  • Click Remove.
     

Arrange the order of parameters

  • Select the row of the parameter you want to move.
  • Click Up arrow icon.png or Down arrow icon.png to move the parameter to the top or bottom of the list respectively.
     

Cancel changes

  • Click Reset.
Tags:
Last modified by Unknown User on 2020/03/24 12:33
Created by Administrator XWiki on 2020/03/24 12:30

Shortcuts

Recent changes
•  Service Manager
•  Service Apps
•  Self Help

Glossary

Powered by XWiki ©, EasyVista 2020