Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Button/IconDescription

Allows creating a new handler

Identifies a disabled status of a handler

Identifies an enabled status of a handler

Identifies an archived status of a handler

Allows viewing  details of a target handlers' performance Execution Logs tab for a respective handler

Allows deleting a handler from the system
Panel
borderColor#ccffcc
bgColor#ccffcc
borderWidth2px
borderStylesolid
Image Removed Tip

For a quick switch between enabled and disabled statuses, click on a respective status icon in the section. However, to change archived status, you need to do it from a handler edit form


Advanced Search

Advanced Search drop-down menu, located in the top right corner of the section, is called to facilitate easy access to required informationBy clicking on a red downward arrow  iconthe following drop-down menu is displayed:Screenshot: Advanced Search drop-down menu

FieldDescription
Event
Select from a list of all possible handler events

Filter by the event type

Handler Type
Indicate a

Filter by the type of the handler

:
  • script
  • HTTP

    Status

    Choose a target status:

    • Enabled
    • Disabled
    • Archived
    or leave this field blank. In this case, both enabled and disabled handlers will be displayed. This field is empty by default

    Filter by status of the handler


    Creating a New Handler

    To start with provisioning, you need to create a handler manually. Click the New Handler button and specify respective parameters in the appeared pop-up window:

    ...

    Field Description

    Name

    Specify a particular title for a handler
    Event

    Specify a handler event from the following list:

    Clients

    • create
    • update
    • delete
    • archive
    • custom fields update
    • balance became >=0
    • balance became <=0
    Accounts
    • create
    • update
    • delete
    Subscriptions
    • assign
    • activate
    • deactivate
    • renew
    • close 
    Import
    • import process failed
    • import process success

    Status

    Choose the state of the handler:

    • enabled - select it to make a handler active;
    • disabled - select it to unable a handler;
    • archived - select it to archive a handler.

    Priority

    Establish an order of handler performing.
    Note: The handler with 1 priority will precede all other handlers in order.

    ...

    borderColor#ffffb3
    bgColor#ffffb3
    borderWidth2px

    (warning)   Attention

    ...

    .


    Panel
    borderColor#ccffcc
    bgColor#ccffcc
    borderWidth2px
    borderStylesolid

    Best practice example

    There is an example based on httphttps://hostname/handler-endpoint usage.

    2.

    Open the Provisioning section and start creating a handler.

    1. Specify the name, type, and status.
    2. In the Event field, select Clients Create event from the drop-down list.
    3. In the Task field, indicate
    4. http://
    5. HTTPS type and
    6. determine the port and method
    7. define the URL for the handler, for example,
    8.  120.0.0.1:5000
    9. my-domain.org/api.
    10. Click Apply.

    Find an example of the http://handler below:

    Code Block
    languagepy
    from flask import Flask, request
    import json
    app = Flask(__name__)
    @app.route("/api", methods=['GET', 'POST'])
    def api():
        data = json.loads(request.data)
        return json.dumps(data)
    if __name__ == "__main__":
        app.run()


    ...

    Panel
    borderColor#ffffb3
    bgColor#ffffb3
    borderWidth2px

    (warning)   Attention

    To put a handler into action, you need to restart the wait for about 5 minutes till next execution of the Cache Manager. To do so, click on the corresponding icon in the System Services section service.

    Execution Logs tab

    You can access the details about handler execution in this tab. For more details, check out a related article: Execution Logs

    ...