'; Event Procedures | Incognito Help
Array
(
    [0] => Array
        (
            [version] => 4.3
            [language] => en
        )

    [1] => Array
        (
            [version] => 4.2
            [language] => en
        )

    [2] => Array
        (
            [version] => 4.1
            [language] => en
        )

    [3] => Array
        (
            [version] => 4.0
            [language] => en
        )

    [4] => Array
        (
            [version] => 3.5
            [language] => en
        )

    [5] => Array
        (
            [version] => 3.4
            [language] => en
        )

    [6] => Array
        (
            [version] => 3.3
            [language] => en
        )

    [7] => Array
        (
            [version] => 3.2
            [language] => en
        )

    [8] => Array
        (
            [version] => 3.1
            [language] => en
        )

    [9] => Array
        (
            [version] => 4.2
            [language] => fr
        )

    [10] => Array
        (
            [version] => 4.2
            [language] => es
        )

)
Rel: acs/topics/acs/dita/event_procedures
URI: acs/topics/event_procedures
=== Tags ===
Array
(
    [808] => event_procedures
)

=== Related ===
Array
(
)

Event Procedures

Event procedures are custom actions, triggered through scripts, which the service executes against devices when internal system events or device events occur. They define the interactions between events and scripts.

For example, you can use an event procedure to trigger a firmware upgrade when a new device is discovered or to place devices into device groups based on received parameter values.

Before you create an event procedure, you must create and publish a script that you can execute against the desired event. To create scripts, navigate to the Incognito Ecosystem Scripting node in the main hub. For information about scripting for events, refer to the Incognito Ecosystem Scripting user’s guide. For information about how to use the ACS JavaScript API, and the scripting environment, to create the custom business logic, refer to the ACS Scripting Guide.

To do this: Follow these steps:
View alerts generated by scripts In the action bar, click Alerts.
Create an event procedure In the action bar, click Create.
View the details for an event procedure Double-click a record.
Search for an event procedure Click the search symbol (), type search terms, and press Enter.
Select an event procedure Double-click a record. To select multiple records, press and hold CTRL and click the records you want to select.
Select all event procedures In the action bar, click Select All. Exit select mode by clicking on any whitespace on the page.
Search fields In table view, type search terms in any of the available column heading fields and press Enter.
Switch to table view/grid view Click the table symbol ()/grid symbol ().
Go back one screen Click the back symbol ().
Return to the main screen of the service Click the hub symbol ().
Note: The service searches for an exact match. If you need to search for a partial match, type a wildcard (*) for the character(s) you do not know.

Creating Event Procedures

Use these settings to create an event procedure.

To do this: Follow these steps:
Activate the event procedure Toggle the Active control.
Save changes In the action bar, click Save.
Name* Name for the event to be created.
Description Description for the event to be created.
Active Select to enable/disable the event procedure.
Action Script-based action that is invoked when the specified system event occurs. Click Select Action to select from a list of scripts or to create a new one.
Event The event that will trigger the event procedure. Select from ‘Device event’ or ‘Timer event’. Choose ‘Device event’ to trigger the event procedure based on something happening on the device. Choose ‘Timer event’ to trigger the event procedure based time parameters, such as a weekly interval.
Table 1. Device Event Settings
Event name From the dropdown list, select a device event name. A description for the event name you select is automatically displayed.
Filters Filter the event procedure by product class, OUI, device model, or serial number. For example, Cisco (OUI) APC2000 (PRODUCT CLASS).

Use these filters, instead of “if” statements in your scripts, when you want to run the event procedure to apply to a specific device manufacturer or class of product.

Table 2. Timer Event Settings
Starts Use these settings to specify when to begin the schedule. Select from ‘As soon as possible. Subsequent events will occur relative to time of initial event’ or ‘Date/Time’.
Repeats Every Use these settings to specify how often to repeat the schedule. Select from ‘Seconds/Minutes/Hours/Days’, ‘Start of the month’, ‘End of the month’ or ‘Specific day(s) of the week’.

You can customize when your first repeat occurs by specifying a past start time. For example, if you want to start on the first day of the next month, but you are in the middle of the current month, you can set the start date to the first day of the previous month. Then, select ‘Start of the month’ for your repeat setting.

Ends Use these settings to specify when to end the schedule. Select from ‘After # occurrences’, ‘Date/Time’ or ‘No end date’.

Choose ‘After # occurrences’ to specify the number of times to run the event before ending the schedule. Value must be an integer. For example, if you select a weekly schedule and want to limit it to five weeks, enter 5.

Choose ‘Date/Time’ to provide a specific date and time to end the schedule.

Choose ‘No end date’ to repeat the schedule without end.

Timer Event Summary The service constructs a summary based on the schedule settings you specify. For example, Daily until 02 Mar 2018.

Event Procedure Details

Use these settings to view and manage the event procedure.

To do this: Follow these steps:
Delete the event procedure In the action bar, click Delete.
Disable the event procedure Toggle the Active control.
Save changes In the action bar, click Save.

Event Procedure Alerts

List of alerts for failed event procedures.

To do this: Follow these steps:
View details for an event procedure alert Double-click a record.
Delete an event procedure alert Double-click a record and, in the action bar, click Delete.

BOOTSTRAP Flow in ACS

To ensure that synchronization operations related to a BOOTSTRAP Inform can occur during the same session as the BOOTSTRAP Inform, use the PROLONGED_OPEN_SESSION_INTERVAL parameter to specify the amount of time to keep the following sessions open:
  • Device Discovery sessions
  • Inform sessions with a BOOTSTRAP event
The default prolonged session time is 10 seconds. The benefit of the prolonged session is to allow:
  • ACS to generate operations needed for discovery or bootstrap in the same session
  • IES to run a script to create additional operations against the device in the same session

An Inform session with a BOOTSTRAP event (triggered either after a FactoryReset operation or externally) automatically creates a Reload operation in ACS and publishes a FACTORY_RESET_COMPLETED event, followed by a RELOAD_AFTER_BOOTSTRAP event when the Reload is complete.

Administrators can create an event procedure for DEVICE_DISCOVERED or RELOAD_AFTER_BOOTSTRAP to trigger a script execution in IES. To ensure the parameters are reloaded from device after bootstrap/factory reset, the RELOAD_AFTER_BOOTSTRAP event should be used (rather than a FACTORY_RESET_COMPLETED event).

IES automatically notifies CWMPs when any of these scripts are completed, allowing CWMP to execute pending operations against the device and close the session. This improve overall performance by guaranteeing that CWMP executes and closes the session as soon as operations are generated by the script, and does not wait for the PROLONGED_OPEN_SESSION_INTERVAL to expire. If the notification is not received, the session closes when PROLONGED_OPEN_SESSION_INTERVAL expires.

To prevent the device from closing a session prematurely, CWMP sends a Get parameter value request for "ProvisioningCode" every 5 seconds.

Top