TOTVS Fluig English

Árvore de páginas

Index

Speaking of operations...

Operations consist of a pre-registration to simplify the use of an operation/method of a registered service. This feature allows to manage service operations, in order for other users to use external integrations. Operations are used to configure a Forms Beta, for example, including the operation as an external integration.

Operation registrations are currently allowed for SOAP or REST services with swagger.




Operations

01. In the main menu, select Control Panel, check the  Development group and click Operations.

02. View existing operations.



Add operation

01. In the Operations screen, select New Operation.

02. Enter the required information.

Fields highlighted with an asterisk (*) are mandatory.

  • Code: enter the code of the operation.
  • Name: enter a name for the operation.

  • Service: select the service (SOAP or REST with swagger) to be used in the operation.

      Fill out the following fields after selecting the SOAP service type:

      Operation
      Click the magnifying glass icon to select an operation. Operations are listed by Name and PortType.

      Configure
      Configure the Properties, SOAP Headers and Return treatment in the selected operation’s settings.

      Properties

        • Basic Authentication - select if authentication is required, in which case a user name and password will be requested.
        • SSL - enable when the SOAP service requires SSL (extra security layer).
        • Disable Chunking - disable sending the entire SOAP envelope.
        • List SOAP messages - enable to show sending and receiving messages in the log.
        • Response time - enable to show the response time of the request.

      SOAP Headers
       Allows adding a header.

      Return Treatment

        • Extract result - allows selecting this option to extract a report in XML format and add a tag.

      Click Save to finish.

      Fill out the following fields after selecting the REST service type:

      Operation
      Click the magnifying glass icon to select an operation. Operations are listed by Name, Method (GET) and API.

      Configure
      Configure the Properties, Headers and Return treatment in the selected operation’s settings.

      Properties

        • SSL - enable when the service requires SSL (extra security layer).
        • List messages - enable to show sending and receiving messages in the log.
        • Response time - enable to show the response time of the request.

      Headers

      Allows adding a header.

      Return Treatment

        • Extract result: Allows selecting this option to extract a report in JSON format and add a path.

      Click Save to finish.

      After selecting the operation, the input and output parameters are loaded in the screen. The label of these fields can be changed, if necessary.

    03. Click Save to complete the process.


    Edit operation

    01. In the Operations window, find the operation to be edited.

    02. Click Edit, located on the right corner of the screen, represented by the pencil icon.

    03. Edit the desired information.

     This screen shows the same configuration fields as those shown in the Add operation action.

    04. Click Save.


    Delete operation

    01. In the Operations window, find the operation to be deleted.

    02. Click Delete, located on the right corner of the screen, represented by the bin icon.

    03. Click Yes, delete operation to confirm.



    Please note!

    This documentation is valid from the 1.7.0 - Lake. If you use a previous update, it may contain information different from what you see on your platform.