Creating Custom Actions and Capabilities

Custom actions allow GUMU™ Co-Pilot to retrieve specific information from Sage CRM.

For example, an action can be created to retrieve customer sales history from a Sage CRM custom entity such as:

vcustomersaleshistory

Step 1: Navigate to Actions

Log in to Bportaly and navigate to:

Configuration → Actions → New

Step 2: Create a New Action

Click New to create a new action.

Enter the required action details, including:

• Action Name

• Object/Entity Name

• Required input fields

• Required output fields

• Action script

Example Entity

For example:

vcustomersaleshistory

Important: The object/entity name must be entered in lowercase.

Step 3: Add the Action Script

Use the following script format for the action(user can replace it by custom entity name):

async def vcustomersaleshistory(

    self,

    filters: list[dict],

    orderBy: dict = {},

    page_size: int = 10,

    child_entity: str = ""

):

    """

    Auto-generated tool for SAGE CRM entity: vcustomersaleshistory

    filters: list of {

        "field": str,

        "op": str,

        "value": Any

    }

    orderBy: e.g.,

    {"field": "chis_compid", "direction": "asc"}

    """

    try:

        response = await self.call_sagecrm_api_async(

            filters,

            orderBy,

            page_size,

            child_entity

        )

        return response

    except Exception as e:

        print(f"Error in customersaleshistory: {e}")

        return f"Error fetching customersaleshistory: {str(e)}"

Important

The action name and script/function name must match.

For example:

Action Name:

vcustomersaleshistory

Script/Function Name:

Vcustomersaleshistory