Predefined Helper Placeholders

When sending the Workflow Integrator request, SecureChange runs a script that parses the JSON template and replaces placeholders with data from the SecureChange ticket.

The Info menu () lists all non-field related placeholders and placeholders associated with complex field data.

The following tables contain placeholders that you can use in the JSON template. In addition to the placeholders listed in these tables, you can also use field names as placeholders.

Ticket Placeholders

Placeholder	Description
`ticket_id`	Returns the SecureChange ticket id.
`ticket_subject`	Returns the ticket subject.
`ticket_comments`	Returns the ticket comments as a JSON.
`latest_comment_content`	Returns the last ticket comment value.
`workflow_name`	Returns the ticket workflow name.
`ticket_requester`	Returns the ticket requester name.
`ticket_requester_full_name`	Returns the ticket requester full name.
`ticket_start_time`	Returns the start time of the ticket. Format: `Y/m/d H:M:S`
`ticket_end_time`	Returns the end time of the ticket. Format: `Y/m/d H:M:S`
`domain_name`	Returns the ticket domain name (Segregated mode only).
`ticket_task_url`	Returns the URL for the ticket task.
`assignee`	Returns the step assignee name of the current last step.
`step_name`	Returns the current step name.
`redo_reason`	Returns the redo comment. This placeholder can only be used with `REDO` trigger.
`reject_reason`	Returns the reject comment. This placeholder can only be used with `REJECT` trigger.
`automatic_step_failure_reason`	Returns the failure description. This placeholder can only be used with `AUTOMATION FAILED` trigger.
`current_time`	Returns the date and time. Should be used to get the time to enter the step. Format: `YYYY-mmdd HH:MM:00`
`date_only`	Returns only the date. Format: `YYY-mm-dd`
`current_step_id`	Returns the current step id if ticket is in progress.
`current_task_id`	Returns the current task id if ticket is in progress.

Field Placeholders

Placeholder	Description
`approve_reject_reason`	Return the reason of the approve reject field. If the rejection was made from the ticket, the reason will be taken from the rejected comment. For the `reject` option, the reject trigger must be set in the workflow.
`approve_reject_status`	Return “Approved” if the Approve/Reject field has been approved or "Rejected" if the field has been rejected. If the rejection was made from the ticket, the status will be "Rejected". For the `reject` option, the reject trigger must be set in the workflow.
`selected_plus_options`	Selected options from a drop-down field.
`firewall_list`	A list of firewalls from the Access-Request field. `{ 'AR1': [ 'CP SMC/SMCPM', 'ASA FireWall 5515 9.5/ASA FireWall 5515 9.5' ] }`
`ar_as_string`	Returns ARs as string in the following format: Access Request AR1: Targets: Management Name: Panorama Version(7.0.1)/ST_DG1.1.1 Object Name: PA-3020-cluster_node1 (Cluster)-ST_vsys2 Object Details: 10.100.249.211 Sources: IP Address: 172.16.1.0 Subnet Mask: 255.255.255.0 Destinations: IP Address: 6.6.6.0 Subnet Mask: 255.255.255.0 Services: Protocol: TCP Port: 80 Users: User: Any
`gm_as_string`	Returns Modify Group as string in the following format: Group Change field 'GM': Modify Group Request 'Group_SA-1.1.1': Group Change Action: UPDATE Management Name: Panorama HA (version 9.0.0)/SA-1.1.1 Members: Management Name: Panorama HA (version 9.0.0)/SA-1.1.1 Object Name: ESX 110 Object Type: Address Range Object Details: [ 10.100.110.0 - 10.100.110.255 ] Object Status: NOT_CHANGED Object Update Status: EXISTING_NOT_EDITED

Designer Placeholders

Placeholder	Description
`designer_commands`	Returns the designer commands for FW based commands.
`designer_status`	Return empty string if succeed or “Error: Problem with Designer” if failed.
`designer_results_json`	Returns the JSON response of the designer results.

Risk Analysis Placeholders

Placeholder	Description
`risk_status`	Returns `“YES”` string if risk has been found or `“NO”` if no risk.
`risk_results`	Returns the following JSON representation of the risk analysis results. `{ "severity": None, "violations": { "sources": None, "destinations": None, "violating_services": None }, "security_requirements": { "policy": None, "from_zone": None, "to_zone": None, "allowed_services": None } }`

Placeholder

Description

risk_status Returns “YES” string if risk has been found or “NO” if no risk.

risk_results

Returns the following JSON representation of the risk analysis results.

{
    "severity": None,
    "violations": {
        "sources": None,
        "destinations": None,
        "violating_services": None
    },
    "security_requirements": {
    "policy": None,
    "from_zone": None,
    "to_zone": None,
    "allowed_services": None
    }
}

Verifier Placeholders

Placeholder	Description
`verifier_status`	Returns `“Fully implemented”` string if all the ARs on the ticket have been verified or `“Not implemented”` if at least one of the ARs has not been fully implemented.