Custom actions: Settings

Custom actions are activable through the rights profiles of the application end-users: Administration > Users > Collection of rights > (1-collection selection) > Planning > My Action (further referred to as <myactions_rightsbase(planning)>).

Additionally, those actions are parameterizable through the application customization: Administration > Customization > Application settings > MY_ACTIONS (further referred to as <myactions_settingsbase>).

Usage locations

Custom actions are activable in:

["Planning" module] The appointment tooltip in planner (<myactions_settingsbase> > Appointment > appointment.planningTooltip.myAction[1-5])
["Planning" module] The appointment tooltup in map (<myactions_settingsbase> > Appointment > appointment.map.myAction[1-5])
["Planning" module] The appointment sheet (<myactions_settingsbase> > Appointment > appointment.sheet.myAction[1-5])
["Planning" module] The appointment search-results list (<myactions_settingsbase> > Appointment > appointment.list.myAction[1-5] and <myactions_settingsbase> > Appointment > appointment.listColumn.myAction[1-5])
["Planning" module - CRM] The customer sheet (<myactions_settingsbase> > Customer > customer.sheet.myAction[1-5])
["Planning" module - CRM] The customer search-results list (<myactions_settingsbase> > Customer > customer.list.myAction[1-5] and <myactions_settingsbase> > Customer > customer.listColumn.myAction[1-5])

Note 1: For the 2nd custom action for the appointment sheet of the "Planning" module, for example, appointment.sheet.myAction2 is that action identifier.

Note 2: A custom action is not available in UI until its right is granted to the end-user, and until its third-party contents URL is given. For example, in order to activate the 3rd custom action for the appointment sheet of the "Planning" module, one will grant the <myactions_rightsbase(planning)> > CALLCENTER_MYACTION_APPOINTMENT_SHEET_3 right, and will activate/fill the <myactions_settingsbase> > Appointment > appointment.sheet.myAction3 > URL URL.

Properties

For each custom action setting, the following properties are available:

URL [string] [default=""]: The location of the third-party contents to load upon a end-user intent on the custom-action button

Trigger properties

useInternationalization [boolean] [default=true]: Internationalizes the UI labels (e.g. true) or uses static labels (e.g. false). This source-property applies to all further target-properties being [label string] types. When internationalization is disabled, the target-property value sets the label. On the opposite, when internationalization is enabled, the target-property value is ignored, and the <myaction_id>.<property_name> language-key of the portions language-bundle is used instead. For example, the internationalized label of the tooltip property, for the appointment.list.myAction1 custom action, is given by the appointment.list.myAction1.tooltip language-key in the portions[_<lang>].properties files
label [label string] [default=""]: The trigger-button label for the custom action
icon [optional] [string] [default=""]: The trigger-button icon. This is a CSS class name. That CSS class provides the background-image CSS property. The following CSS class names are defaultly available: "myaction", "myaction-blue", "myaction-arrow1", "myaction-arrow1-blue", "myaction-arrow2", "myaction-arrow2-blue", "myaction-arrow3", "myaction-arrow3-blue", "myaction-arrow4", "myaction-arrow4-blue", "myaction-direction", "myaction-direction-blue", "myaction-info", "myaction-info-blue", "myaction-share", "myaction-share-blue", "myaction-speechbubble", "myaction-speechbubble-blue", "myaction-view", "myaction-view-blue", "myaction-warning", "myaction-warning-blue", "myaction-window1", "myaction-window1-blue", "myaction-window2", "myaction-window2-blue", "myaction-window3", "myaction-window3-blue"
tooltip [label string] [default=""]: The displayed text on hover of the trigger-button for the custom-action
style [optional] [string] [default=""]: Additional visual styles decorating the trigger-button. This is a list of CSS class names (space-separated items). For example: my-button-class my_Other-BUttonclass
trigger [string] [possibilities="click","hover"] [default="click"]: Sets the end-user intent that will trigger the custom action. Action can be triggered on click or on hover

Communication properties between application and the third-party contents

Note: 3 information categories are sent to the third-party contents. "context" (the application current-user ID, the current-area ID), "model" (the company-data pieces managed by the application-screen that triggers the custom-action), and "contract" (information required and only known by the third-party contents). "context" is always sent. On the contrary, "model" and "contract" are optional.

HTTPMethod [string] [possibilities="get","post"] [default="get"]: The HTTP method of the request loading the third-party contents. Reminder: the POST method enforces the third-party contents to be pre-processed by a server (PHP, Java, ..) but enables the transfer of a large-sized HTTP-parameters pool. On the opposite, the GET method allows the third-party contents (JavaScript) to process the HTTP parameters directly, at the expense of a small-sized HTTP-parameters pool limitation
HTTPListFields [string] [default=""]: The "model" information. Those are the exchange model fields to be sent for each source company-data piece (see Exchange model). For example, regarding an appointment custom-action: "APPOINTMENTID,TASKTYPES(0).DURATION"
HTTPAdditionalParameters [string] [default=""]: The "contract" information. Those are information bound to the third-party contents. Each key-value pair is sent as 1 HTTP parameter. For example: "origin=otgs,origin=geoconcept,allowedRoles=support\,test,env=testing"

HTTPParametersFormat [optional] [string] [possibilities="","json"] [default=""]: Alternate serialization formats for the "context" and "model" information. For example, regarding a custom-action for a search-result returning 2 appointments, those HTTP parameters are sent:

HTTPAdditionalParameters="" (not URL-encoded):

otgs-ctx-currentUserId=UJeanDUPONT
otgs-ctx-currentAreaId=WLowerNormandy
otgs-d0-APPOINTMENTID=F20167770709-1_ F20167770709-1
otgs-d0-TASKTYPES(0).DURATION=60
otgs-d1-APPOINTMENTID=..
otgs-d1-TASKTYPES(0).DURATION=..
anyDestINAtIonSpeciFicParam=anyValue
anyDestINAtIonSpeciFicParam=any2ndValue
anyOtherDestINAtIonSpeciFicParam=anyOtherValue

HTTPAdditionalParameters="json" (not URL-encoded):

otgs-payload={
    "context": {
        "currentUser": {
            "id": "UJeanDUPONT"
        },
        "currentArea": {
            "id": "WLowerNormandy"
        }
    },
    "data": [
        {
            "APPOINTMENTID": "F20167770709-1_ F20167770709-1",
            "TASKTYPES(0).DURATION": "60"
        },
        {
            "APPOINTMENTID": "..",
            "TASKTYPES(0).DURATION": ".."
        }
    ]
}
anyDestINAtIonSpeciFicParam=anyValue
anyDestINAtIonSpeciFicParam=any2ndValue
anyOtherDestINAtIonSpeciFicParam=anyOtherValue

Third-party contents properties

destination [string] [possibilities="popup","currentFrame","newWindow","callcenterMap","callcenterLeftMenu","callcenterBottom"] [default=popup]: The UI component that will embed the third-party contents. "popup" is a modal HTML-frame. "currentFrame" switches the screen that triggered action with a screen wrapping the third-party contents (the envelope decorates contents with a title and a back-navigation button). "newWindow" is a native non-modal browser window. "callcenterLeftMenu", "callcenterMap" and "callcenterBottom" have a behavior similar to "currentFrame", except that the third-party contents screen respectively replaces the contents-frame, map-frame or planner-frame of the "Planning" module
destinationWidth [optional] [positive integer] [default=0]: Sets width of the UI component embedding the third-party contents, for the destination="popup" and destination="newWindow" modes. The default value auto-sizes that container
destinationHeight [optional] [positive integer] [default=0]: Sets height of the UI component embedding the third-party contents, for the destination="popup" and destination="newWindow" modes. The default value auto-sizes that container
destinationCaption [optional] [label string] [default=""]: The third-party contents title. Only displayed in the following modes: destination="popup", destination="currentFrame", destination="callcenterLeftMenu", destination="callcenterMap" and destination="callcenterBottom"
onCloseEvent [optional] [string] [possibilities="nothing","refreshCaller"] [default="nothing"]: Defines the application behavior when control returns from the third-party contents UI (e.g. closed popup/window). By default, the initial/source screen is re-rendered, with no additional behavior. On the opposite, the "refreshCaller" mode fully reloads the initial/source screen, in order to reflect any change that may have occured on the company-data (e.g. through the application REST API, the third-party contents may have modified those data). The "refreshCaller" mode is not compatible with the following modes: destination="currentFrame", destination="newWindow" and destination="callcenterLeftMenu"