The following fields are available for use within a workflow. The Alarm details list are passed into the workflow as input parameters while the Business Partner, Customer, Equipment and Location fields are all retrieved using the appropriate activity from within the workflow.
Alarm Details
These alarm details are passed into a workflow as input parameters. These are indicated in the 'Start' activity Global Variables list with an input icon 
| Name | Type | Description |
|---|---|---|
| AdministeredId | String | The administered name or id or the equipment raising the alarm. This could be as administered in VSM such as a server name or as administered in other equipment such as an Avaya Communication manager station number or board ID. |
| AlarmDescription | String | A long description of the alarm usually taken from product documentation. |
| AlarmEventName | String | The VSM name given to this alarm. Usually taken from product documentation or SNMP trap. |
| AlarmId | GUID | A unique identifier for this specific instance of an alarm. |
| AlarmLevel | String | The alarm level as defined in the product raising the alarm. For example as seen in Avaya Communication Manager display alarms commands. |
| AlarmResponseId | GUID | A VSM internal alarm ID specific to this type of alarm. |
| AlarmState | String | The current alarm state. |
| ContractId | GUID | A VSM unique identifier for the contract associated with this alarm. |
| ContractName | String | The name of the contract associated with this alarm. Taken from the VSM contract administration. |
| ContractType | String | The type of contract associated with this alarm. Taken from the VSM contract administration. |
| CoveredEntityId | GUID | A VSM unique identifier for the equipment under the contract associated with this alarm. |
| IsOutOfContractHours | Boolean | Is the alarm being raised outside of the contracted hours as administered in VSM. |
| NextUnderContractUtcDateTime | Date | What date and time is the equipment raising the alarm next under contract. |
| AlarmResponseAppliesToType | String | The VSM entity level that this alarm response is being applied. Normally default however the alarm response may be modified and that modification can be applied at a customer level or at a business partner level. |
| AlarmResponseAppliesToId | GUID | The VSM unique identifier of the entity referred to in AlarmResponseAppliesToType above. |
| SourceIpAddress | String | The IP address of the equipment raising the alarm where an IP address can be determined. |
| BusinessPartnerId | GUID | The VSM unique identifier of the business partner associated with the alarm being raised. |
| CreatedDateTime | Date | The date and time the alarm was created within VSM. |
| CustomerId | GUID | The VSM unique identifier of the customer associated with this alarm being raised. |
| DisplayName | String | The name to be displayed with this alarm. This may or may not be the same as the alarm event name. |
| EquipmentId | GUID | The VSM unique identifier of the equipment associated with this alarm being raised. |
| LocationId | GUID | The VSM unique identifier of the Location associated with this alarm being raised. |
| OriginatingProbeName | String | The VSM identifier of the component used to raise this alarm. For future use. |
| OriginationProbeId | GUID | The VSM unique identifier of the probe associated with this alarm being raised. |
| RecommendedAction | String | A block of text that may recommend actions for a person to take to diagnose or resolve this alarm. Usually taken from product documentation if this is populated. |
| Severity | Integer | The VSM severity assigned to this alarm. The severity may be modified from default values and applied at a customer or business partner level. |
| SiteId | Integer | A numeric value generally associated with the IP Network Region of the equipment raising the alarm. |
| SiteName | String | The name of the site associated with the alarm. Generally associated with the name of the IP Network Region this value may also come from site names administered in VSM for locations where an IPNR is not populated. |
| Vendor | String | The name of the vendor of the equipment raising the alarm. For example Avaya, Cisco, Audiocodes or Virsae. |
| CalloutListId | GUID | The VSM unique identifier of the callout list assigned in the alarm rules to be used by this workflow. |
| ServerInstanceId | GUID | A VSM unique identifier of the server used in processing of this alarm. VSM internal use. |
| ShortAlarmDescription | String | A truncated alarm description generally used when passing alarm details via SMS so that the complete message is shorter than 170 characters. |
| ExternalTicketId | String | A unique identifier received from a third party API when raising an alarm into an external ticketing system such as Service Now. |
| RawAlarmData | String | The al.rm information received such as the SNMP trap received that was used to create this alarm. |
| ActivatedLocationLocalTime | Date | The date and time the alarm was raised in the time zone administered for the location within VSM. |
| LocationTimeZoneId | String | The actual timezone as administered in VSM for the location. This can be used when translating the date and time to a different timezone. |
| AlarmActivatedTime | Date | The date and time the alarm was activated |
| IsAlarmActivatedTimeUtc | Boolean | Is the alarm activated time in UTC or not. |
| ProductName | String | The VSM product name such as ACM for Avaya Communication Manager |
| ProductVendorId | GUID | The VSM unique identifier of the product vendor. |
Business Partner Details
The following fields appear in the 'Output Mapping of the GetBPDetails activity. The field names are fixed and in the context of the Business Partner. The variables are default variables that may exist in when a template is used to create the workflow. These variable names may be modified or added where they do not exist. The majority of these are configuration items administered with the VSM web portal manage business partner page and also the availability options page.
| Field Name | Variable Name | Type | Description |
|---|---|---|---|
| Active | Boolean | Is the business partner active or have they been deleted? | |
| Alert Via Email | BPAlertViaEmail | Boolean | From VSM administration determines if the business partner should be notified via email or not. Administered in the business partner availability options. |
| Alert Via SMS | BPAlertViaSMS | Boolean | From VSM administration determines if the business partner should be notified via SMSor not. Administered in the business partner availability options. |
| Business Partner Billing Reference | BusinessPartnerBillingReference | String | VSM Internal reference for billing purposes |
| Business Partner ID | BusinessPartnerID | GUID | A VSM unique identifier for the business partner associated with this alarm. |
| Business Partner Mobile Phone | BusinessPartnerMobilePhone | String | The mobile phone number administered for this business partner |
| Business Partner Name | BusinessPartnerName | String | The business partner name administered for this business partner |
| Business Partner Service Desk Email Address | BPServiceDeskEmailAddress | String | TBC |
| Max Days For Unresolved Alarms | BPMaxDaysUnresolved | Integer | The maximum days an alarm should remain as unresolved in VSM before it is automatically resolved. |
| Primary Contact Mobile Number | BPPrimaryContactMobile | String | The mobile phone number of the person administered as the primary contact for this business partner. |
| Primary Contact Name | BPPrimaryContactName | String | The name of the person administered as the primary contact for this business partner. |
| Send Alarms To Service Desk Email | BPSendAlarmToServiceDesk | Boolean | This determines at a business partner level if all alarms should be sent to the service desk email address or not. Administered in the business partner availability options. |
| Service Desk Email Address | ServiceDeskEmailAddressBP | String | The service desk email address administered for this business partner at a business partner level. |
| Use Callout List | UseCalloutList | Boolean | Determines if a callout list should be used with this workflow. Administered in the business partner availability options. |
| User To Receive Alarms Email Address | BPUserToReceiveAlarmEmailAddress | String | The users email address to receive alarms. |
| User To Receive Alarms Name | BPUserToReceiveAlarmName | String | The users name that is administered to receive alarms. |
| User To Receive Alarms SMS | BPUserToReceiveAlarmSMS | String | The users mobile number to receive alarms. |
| Virsae Account Number | BPVirsaeAccountNumber | String | Internal Virsae account number for this business partner. |
| Virsae Contract Number | BPVirsaeContractNumber | String | Internal Virsae contract number for this business partner. |
| Virsae Entity ID | BPVirsaeEntityNumber | GUID | Internal Virsae unique identifier for this business partner. |
Customer Details
The following fields appear in the 'Output Mapping of the GetCustomerDetails activity. The field names are fixed and in the context of the Business Partner. The variables are default variables that may exist in when a template is used to create the workflow. These variable names may be modified or added where they do not exist. The majority of these are configuration items administered with the VSM web portal manage customer page and also the customer availability options page.
| Field Name | Variable Name | Type | Description |
|---|---|---|---|
| Active | Boolean | Identifies if the customer is active or has been deleted. | |
| Alert Via Email | CustAlarmViaEmail | Boolean | Should the customer be notified via email or not. |
| Alert Via SMS | CustAlarmViaSMS | Boolean | Should the customer be notified via SMS or not. |
| Business Partner ID | CustBPId | GUID | The unique identifier of the business partner this customer belongs to. |
| Business Partner Service Desk Email Address | CustBPServiceDeskEmailAddress | String | The business partners email address administered at the customer level. For example the BP may have a unique service address for this specific customer as opposed to the email address administered at a BP level. |
| Business Partner Telephone | CustBusinessTelephone | String | The business partners phone number administered at the customer level. For example the BP may have a unique phone number for this specific customer as opposed to the phone number administered at a BP level. |
| Customer Name | CustCustomerName | String | The name of the customer associated with this alarm. |
| Customer Number | CustCustomerNumber | String | The number of the customer associated with this alarm. |
| Max Days For Unresolved Alarms | CustMaxDaysUnresolved | Integer | The maximum number of days the alarm will remain unresolved in the customers view before being resolved automatically. |
| Mobile Number | CustMobileNumber | String | The mobile number of the customer associated with this alarm. |
| Primary Contact Email address | CustPrimaryContactEmailAddress | String | The email address of the customers primary contact. |
| Primary Contact Mobile Number | CustPrimaryContactMobile | String | The mobile number of the customers primary contact. |
| Primary Contact Name | CustPrimaryContactName | String | The name of the customers primary contact. |
| Primary Contact Phone Number | CustPrimaryContactPhoneNumber | String | The phone number of the customers primary contact. |
| Send Alarm To Service Desk Email | CustSendAlarmsToServiceDesk | Boolean | Identifies if an alarm should be sent to the customers internal service desk email address. |
| Use Callout List | CustUseCalloutList | Boolean | Identifies if this workflow should use the callout list administered at a customer level. |
| Service Desk Email Address | CustServiceDeskEmailAddress | String | The customers service desk email address to sned emails to if enabled. |
| User To Receive Alarms Email address | CustUserToReceiveAlarmEmail | String | The email address of a specific user administered at the customer level. |
| User To Receive Alarms Name | CustUserToReceiveAlarmName | String | The name of a specific user administered at the customer level. |
| User To Receive Alarms SMS | CustUserToReceiveAlarmSMS | String | The mobile number of a specific user administered at the customer level. |
Equipment Details
The following fields appear in the 'Output Mapping of the GetEquipmentDetails activity. The field names are fixed and in the context of the Business Partner. The variables are default variables that may exist in when a template is used to create the workflow. These variable names may be modified or added where they do not exist. These values are administered in Manage Equipment under the customers location(s).
| Field Name | Variable Name | Type | Description |
|---|---|---|---|
| Equipment Address | String | The IP address of the Equipment as administered in VSM. | |
| Equipment Name | EquipDetailsEquipmentName | String | The name of the equipment as administered in VSM |
Location Details
The following fields appear in the 'Output Mapping of the GetLocationDetails activity. The field names are fixed and in the context of the Business Partner. The variables are default variables that may exist in when a template is used to create the workflow. These variable names may be modified or added where they do not exist. These values are administered under the customers location(s).
| Field Name | Variable Name | Type | Description |
|---|---|---|---|
| Active | LDActive | Boolean | Identifies if the customer location is active or has been deleted for example. |
| Appliance Friendly Name | LDApplianceFriendlyName | String | The name of the appliance installed at the location as administered in VSM. |
| Description | LDDescription | String | The description of the location as administered in VSM. |
| Location Name | LDLocationName | String | The name of the location as administered in VSM. |