Freshservice URL

FDFS_URL

Yes

Freshservice URL (https://<your_helpdesk_domain_name>.http://freshservice.com )

Freshservice API Key

FDFS_API_KEY

Yes

API key for Freshservice

Note that encrypted properties are stored in Credential Store (Local or External) and can be configured using Edit button next to credential name drop down. Alternatively, you can reuse single credential for multiple properties also, in which case you should name that credential appropriately.

Approved Check Script

FDFS_APPROVED_SCRIPT

No

A Groovy expressions which determines whether a task for the change ticket is approved or not.  The expression must return a boolean, and has access to the following variables:

• TICKET - an object with fields (JSON) contained in the change ticket, as returned by the Freshservice REST API.  Fields are referenced as TICKET.<field name>.<sub-field name>

• FD_ENVIRONMENT_CODE - The environment for a particular deployment request or associated pipeline stage.

Rejected Check Script

FDFS_REJECTED_SCRIPT

No

A Groovy expressions which determines whether a task for a change ticket is rejected or not.  The expression must return a boolean, and as has access to the following variables:

• TICKET - an object with fields (JSON) contained in the change ticket, as returned by the Freshservice REST API.  Fields are referenced as TICKET.<field name>.<sub-field name>

• FD_ENVIRONMENT_CODE - The environment for a particular deployment request or associated pipeline stage.

Additional Info Script

FDFS_ADDITIONAL_INFO_SCRIPT

No

A Groovy expression which determines additional information to add to an external approval when it is approved or rejected.  The expression must return a Map<String, String> and have an entry with the key of "notes" for the value to get added to external approval as a task note. Script has access to the following variables:

• TICKET - an object with fields (JSON) contained in the change ticket, as returned by the ServiceNow REST API.  Fields are referenced as TICKET.<field name>.<sub-field name>

• FD_ENVIRONMENT_CODE - The environment for a particular deployment request or associated pipeline stage.

Don't poll

FDFS_DONT_POLL

No

Disable automatic polling (every minute) of Freshservice tickets for status changes. Check if using REST API to communicate status changes to FlexDeploy.

Freshservice Requester Id

FDFS_REQUESTER_ID

No

Freshservice agent id for API access(should be a number)

subject

Subject

A subject for the change ticket

String

No

description

Description

A description for the change ticket

String

No

change_type

Change  Type

e.g. 2

Long

Yes

status

Status

e.g. 2

Long

Yes

priority

Priority

e.g. 2

Long

Yes

impact

Impact

e.g. 2

Long

Yes

requester_id

Requester Id

e.g. 21000602644

Long

Yes

risk

Risk

e.g. 2

Long

Yes

planned_start_date

Start Date

e.g. "2022-09-22T19:24:50Z"

String

Yes

planned_end_date

End Date

e.g. "2022-09-22T19:24:50Z"

String

Yes