ITSM Integrations

White Paper
BMC Remedy IT Service Management 7.6.03 Integrations
September 2010
www.bmc.com
Contacting BMC Software

You can access the BMC Software website at http://www.bmc.com. From this website, you can obtain information about the company, its products, corporate offices, special events, and career opportunities.
United States and Canada

Address BMC SOFTWARE INC 2101 CITYWEST BLVD HOUSTON TX 77042-2827 USA Telephone 713 918 8800 or 800 841 2031 Fax 713 918 8000
Outside United States and Canada

Telephone (01) 713 918 8800 Fax (01) 713 918 8000
If you have comments or suggestions about this documentation, contact Information Design and Development by email at doc_feedback@bmc.com.
Copyright 19912006, 2010 BMC Software, Inc. BMC, BMC Software, and the BMC Software logo are the exclusive properties of BMC Software, Inc., are registered with the U.S. Patent and Trademark Office, and may be registered or pending registration in other countries. All other BMC trademarks, service marks, and logos may be registered or pending registration in the U.S. or in other countries. All other trademarks or registered trademarks are the property of their respective owners. Java is a trademark of Sun Microsystems, Inc., in the U.S. and other countries. The information included in this documentation is the proprietary and confidential information of BMC Software, Inc., its affiliates, or licensors. Your use of this information is subject to the terms and conditions of the applicable End User License agreement for the product and to the proprietary and restricted rights notices included in the product documentation.
Restricted rights legend

U.S. Government Restricted Rights to Computer Software. UNPUBLISHED -- RIGHTS RESERVED UNDER THE COPYRIGHT LAWS OF THE UNITED STATES. Use, duplication, or disclosure of any data and computer software by the U.S. Government is subject to restrictions, as applicable, set forth in FAR Section 52.227-14, DFARS 252.227-7013, DFARS 252.227-7014, DFARS 252.227-7015, and DFARS 252.227-7025, as amended from time to time. Contractor/Manufacturer is BMC Software, Inc., 2101 CityWest Blvd., Houston, TX 77042-2827, USA. Any contract notices should be sent to this address.
Customer Support
You can obtain technical support by using the Support page on the BMC Software website or by contacting Customer Support by telephone or email. To expedite your inquiry, please see Before Contacting BMC Software.
Support website
You can obtain technical support from BMC Software 24 hours a day, 7 days a week at http://www.bmc.com/support. From this website, you can:

Read overviews about support services and programs that BMC Software offers. Find the most current information about BMC Software products. Search a database for problems similar to yours and possible solutions. Order or download product documentation. Report a problem or ask a question. Subscribe to receive email notices when new product versions are released. Find worldwide BMC Software support center locations and contact information, including email addresses, fax numbers, and telephone numbers.
Support by telephone or email

In the United States and Canada, if you need technical support and do not have access to the Web, call 800 537 1813 or send an email message to customer_support@bmc.com. (In the Subject line, enter SupID:<yourSupportContractID>, such as SupID:12345.) Outside the United States and Canada, contact your local support center for assistance.
Before contacting BMC Software

Have the following information available so that Customer Support can begin working on your issue immediately:
Product information Product name Product version (release number) License number and password (trial or permanent)
Operating system and environment information Machine type Operating system type, version, and service pack System hardware configuration Serial numbers Related software (database, application, and communication) including type, version, and service pack or maintenance level
Sequence of events leading to the problem Commands and options that you used Messages received (and the time and date that you received them) Product error messages Messages from the operating system, such as file system full Messages from related software
License key and password information

If you have a question about your license key or password, contact Customer Support through one of the following methods:
E-mail customer_support@bmc.com. (In the Subject line, enter SupID:<yourSupportContractID>, such as SupID:12345.) In the United States and Canada, call 800 537 1813. Outside the United States and Canada, contact your local support center for assistance. Submit a new issue at http://www.bmc.com/support.
Contents
Preface 7
Integration methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Using web services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Using BMC Remedy APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Associating entries with configuration items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Work information creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Creating a service request entry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Mapping assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Web service function mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Submit functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Modify functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Query functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Sample Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 Chapter 1 Incident Management 15
HelpDesk_Submit_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 HelpDesk_Modify_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 HelpDesk_Query_Service and HelpDesk_QueryList_Service Functions . . . . . . . . . . 25 Chapter 2 Problem Management 27 28 28 32 34 36 36 39 41 43 43 45 47 47
Problem Investigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Problem_Submit_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Problem_Modify_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Problem_Query_Service and Problem_QueryList_Service Functions . . . . . . . . . Known Error records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KnownError_Submit_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KnownError_Modify_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KnownError_Query_Service and KnownError_QueryList_Service Functions . Solution Database records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Solution_Submit_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Solution_Modify_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Solution_AddKeyword_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Solution_Query_Service and Solution_QueryList_Service Functions. . . . . . . . . .
Contents
Chapter 3
Change Management
49
Change_Submit_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Change_Modify_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Change_Query_Service and Change_QueryList_Service Functions . . . . . . . . . . . . . . 57 Release_Submit_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Modify and query release operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Create Manifest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 UpdateManifest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 RemoveManifest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Create (release relationships) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Chapter 4 Asset Management 65
AST_PurchaseRequisitionInterface_Create_WS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Create_PurchaseRequisition. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 AST_PurchaseRequisition_QueryModify_WS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Query_PurchaseRequisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 AST:PurchaseRequisitionInterface (Query) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Update_PurchaseRequisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 AST_PurchaseOrder_QueryModify_WS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Query_PurchaseOrder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Update_PurchaseOrder. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 AST_PurchaseLineItem_QueryModify_WS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Query_PurchaseLineItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Update_PurchaseLineItem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 AST_WorkInfoInterface_Create_WS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Create_WorkInfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 AST_PurchaseOrder_WS and AST_PurchaseOrder_WS_noDate . . . . . . . . . . . . . . . 102 Update_PO_Confirmation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Get_Specific_PO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Get_List_Of_New_POs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 AST_PurchaseOrderInterface_WS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 PO_Modify_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 PO_Query_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 PO_GetListofNewPO_Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Chapter 5 Task Management 111
Web service function overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Query operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 Modify operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Integrating applications with tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Preface
This paper is for people who administer any of the BMC Remedy IT Service Management 7.6.03 (BMC Remedy ITSM 7.6.03) applications or modules and who want to use the associated application interface forms to enable external applications, such as web services, to create, modify, and search for tickets within the BMC Remedy ITSM 7.6.03 applications. This paper focuses particularly on web services. For information about other integration types, see the BMC Remedy Action Request System 7.5.00 Integration Guide. To take full advantage of the information presented in this paper, you should have a working knowledge of the BMC Remedy Action Request System (BMC Remedy AR System) and the BMC Remedy ITSM 7.6.03 applications common foundation. The applications covered by this paper include:

BMC Remedy Service Desk: Incident Management 7.6.03 BMC Remedy Service Desk: Problem Management 7.6.03 BMC Remedy Change Management 7.6.03
NOTE
The Release Management module is also described in the chapter on BMC Remedy Change Management.
BMC Remedy Asset Management 7.6.03
A section that discusses integration with the BMCs Task Management System module is also included.
Preface
The information contained in this paper includes:

Descriptions of inputs and outputs for the interface form. Descriptions of the web services inputs and outputs, which provide a real, working example of how to use the interface forms.
Integration methods
You can integrate applications with BMC Remedy ITSM 7.6.03 using any of the following methods:
Web services clientMoves information in and retrieves information from ITSM applications. BMC Remedy APIsFor information about this method, see BMC Remedy Action Request System 7.5.00 - C API Reference. LDAP IntegrationImports existing user names so you can grant permission to access applications. Vendor and View FormsRetrieves and displays data from external data sources in ITSM applications. XML Import and ExportUsing XML, data and view definition files can be imported and exported into and out of BMC Remedy AR System. This allows administrators to localize data easily and to share data across databases and applications not related to BMC Remedy applications and their databases. ODBC type integrationsFor example: Excel integration based on BMC Remedy AR System that imports user names into the ITSM foundations People form.
Use the integration forms to create, modify, and query information about BMC Remedy ITSM 7.6.03 through web service clients or through third-party applications that use the standard Remedy API. For more information about how integrations work, see the BMC Remedy Action Request System 7.5.00 Integration Guide.
Using web services

Web services are the most efficient way of integrating with BMC Remedy ITSM 7.6.03, because they eliminate the need to create API applications. With web services, you use a web services client to access the web services functions available in ITSM 7.6.03 (customers, however, can choose to develop their own web service client application). For example, an event occurs in an event-based system that causes the web services client to connect to BMC Remedy ITSM 7.6.03 and create an Incident, Problem, Change, or Purchase Order ticket.
Associating entries with configuration items
Using BMC Remedy APIs

Using various BMC Remedy APIs (JavaTM API, C API, and Plug-ins), you can integrate a third-party application with BMC Remedy ITSM 7.6.03. Using the field reference tables listed later in this paper, you can determine what fields are needed to create, modify, and query Incident, Problem, Change, and Purchase Order tickets. For example, if you use a third-party application to identify incidents in a system, but have no way of tracking them, you can access BMC Remedy Incident Manager from the third-party application and create an incident ticket by way of the BMC Remedy APIs.
Associating entries with configuration items

Any time you create an incident or infrastructure change entry, the architecture allows you to associate a configuration item (CI) with the entry. When an association is created, the association information is sent to the following forms:

AST:CMDB Associations HPD:Associations CHG:Association
Several methods can be used to associate CIs to incident or infrastructure change entries. One method requires that you provide the following input values in order to create an association in the relationship table:
CI NameThe name of a CI (as it appears in the Name field of an Asset record). For example, CI Name: Desktop Computer Lookup KeywordThe ClassId of a CI (as it appears in the ClassID field of an Asset record). For example, Lookup Keyword: BMC_COMPUTERSYSTEM
Another method requires that you provide the following input values in order to create the association in the relationship table and populate the CI field found in the incident or infrastructure change forms:
CI NameThe name of a CI (as it appears in the Name field of an Asset record). Specify this value in the HPD_CIfield. For example, CI Name: Desktop
Computer
CI Reconciliation ID The Reconciliation ID for a CI that uniquely identifies the CI across multiple data sets. Specify this value in the HPD_CI_ReconID field. ClassId The ClassId of a CI (as it appears in the ClassID field of an Asset record. Specify this value in the HPD_CI_FormName field. For example,
HPD_CI_FormName:BMC_COMPUTERSYSTEM
CI Form Name The name of the form that stores a CI. For example,
z1D_CI_FormName:AST:ComputerSystem
Preface
When associating a service and populating the Service field with an incident or infrastructure change entry, you must provide the following input values:
ServiceCIThe name of a service (as it appears in the Name field of a Business Service record). For example, ServiceCI: Payroll Service ServiceCI Reconciliation ID The Reconciliation ID of a service that uniquely identifies the service across multiple data sets. Specify this value in the ServiceCI_ReconID field.
Work information creation

You can create work information entries any time you submit or modify a ticket. Do this by placing values in the work information fields. For a list of the work information fields required to do this using an external application integration, see Table 1-2 on page 16 and Table 1-4 on page 22.
NOTE
You cannot add work information entries for the BMC Remedy Asset Management application.
Creating a service request entry

Requests for the BMC Remedy Change Management and Incident Management applications are created by the Requester Console in BMC Remedy ITSM 7.6.03. For information about service requests, see the BMC Remedy Service Desk: Incident Management 7.6.03 Users Guide.
Mapping assignments
To make sure Submit operations complete successfully, you must define the assignment mappings for each module. These mappings are defined in the CFG:Assignment form, which you access through BMC Remedy User. You need administrator permissions to modify this form.
10
Web service function mapping
Web service function mapping

The following table lists the available web services and their corresponding functions.
Web service name HPD_IncidentInterface_Create_WS HPD_IncidentInterface_WS Functions within the web service HelpDesk_Submit_Service HelpDesk_Modify_Service HelpDesk_Query_Service HelpDesk_QueryList_Service CHG_ChangeInterface_Create_WS CHG_ChangeInterface_WS Change_Submit_Service Change_Modify_Service Change_Query_Service Change_QueryList_Service PBM_ProblemInterface_Create_WS Problem_Submit_Service KnownError_Submit_Service Solution_Submit_Service PBM_ProblemInterface_WS Problem_Modify_Service Problem_Query_Service Problem_QueryList_Service PBM_KnownErrorInterface_WS KnownError_Modify_Service KnownError_Query_Service KnownError_QueryList_Service PBM_SolutionInterfaceWS Solution_Modify_Service Solution_Query_Service Solution_QueryList_Service Solution_AddKeyword_Service AST_PurchaseOrder_WS Update_PO_Confirmation Get_Specific_PO Get_List_Of_New_Pos AST_PurchaseOrder_WS_noDate Update_PO_Configuration Get_Specific_Confirmation Get_List_Of_New_Pos AST_PurchaseOrderInterface_WS PO_Modify_Service PO_Query_Service PO_GetListofNewPO_Service
Preface
11
Web service name TMS_TaskInterface
Functions within the web service QueryTaskOnly QueryTaskPlusWorkInfo QueryTaskPlusRelationships QueryTaskPlusRelationships AndWorkInfo UpdateTaskOnly UpdateTaskAndWorkInfo
Functions
This section provides a brief overview of the functions described in this paper.
Submit functions
Submit functions are used to create a record; for example, opening a form in New mode, then saving it as a new record. Each subsection describing submit functions can contain the following tables:
Required input field values. These fields are required and a record is not created if they have null values. Optional input field values. These fields are not required to create an entry, but they might need to be populated, depending on the status the entry to be created. (See the Notes column in each table for more information about specific fields).
Fields set by workflow. The values in these fields are generated by workflow that is triggered by the input fields (required and optional) only. When using web services, they are not exposed to the user.
For example, the Priority field value is calculated when you populate the Impact and Urgency fields. When a record is created successfully, the newly created record ID is returned.
12
Sample Code
Modify functions
The creation of work log entries is the only workflow triggered by a modify function. When using web services, if there are populated fields in the main form that you want to modify, specify those values in the corresponding web service fields.
WARNING
If you specify a null value, the null value overwrites the value currently in the form.
NOTE
There is no returned value to signal that a record has been modified.
Query functions
The query functions are web service-specific operations. When using web service functions, you must specify the ticket number on which to query (<module>_Query_Service), or a valid AR System qualificationif you query from a list of entries (<module>_QueryList_service). The "LIKE" operator can be used in the qualification of an unlimited character field length, this type of field is stored as a CLOB in the database. An example of such a field is the 'Justification' field on the Purchase Requisition.
Sample Code
You can see examples of API code in the following BMC Remedy AR System reference guides:

BMC Remedy Action Request System 7.5.00 C API Reference BMC Remedy Action Request System 7.5.00 Integration Guide
Preface
13
14
Chapter
Incident Management
You use the interface forms in BMC Remedy Incident Management to:

Create or modify an incident. Query an incident or a list of incidents.
When creating an incident, if necessary, you can also associate the incident to an existing CI and create a work information entry.
NOTE
You can also create a work information entry during an incident modification. The following is a list of the web service functions available for BMC Remedy Incident Management. These functions are described in the rest of this section.
HelpDesk_Submit_Servicecreates and submits incident tickets with work
information and CI associations

HelpDesk_Modify_Servicemodifies incident tickets with work information HelpDesk_Query_Service/ HelpDesk_QueryList_Serviceallows
searches for specific incident tickets (using the query service) or a set of incident tickets (using the query list service)
Chapter 1 Incident Management
15
HelpDesk_Submit_Service
The following tables list the values needed to submit an incident through the HPD:IncidentInterface_Create form. You can create incident records either through web services, or through the interface form.
Table 1-1: Required input field values DB field on interface form z1D_Action Displayed on web services Action Field value CREATE Notes
Keyword triggers workflow that initiates the submit operation Used to populate the customer information section on the HPD:Help Desk form Used to populate the customer information section on the HPD:Help Desk form
Last_Name
Last_Name
First_Name
First_Name
Status Impact Urgency Description Reported Source
Status Impact Urgency Summary Reported_Source Maps to Summary on the HPD:Help Desk form
Service_Type Service_Type
The following table lists optional input field values.

Table 1-2: Optional input field values DB field on interface form Detailed_Description Status_Reason Assigned Support Company Displayed on web services Notes Status_Reason Support_Company Required when status is set to greater than or equal to Assigned Required when status is set to greater than or equal to Assigned Required when status is set to greater than or equal to Assigned Required when status is set to greater than or equal to Assigned Notes
Assigned Support Organization Assigned Group
Support_Organization
Assigned_Group
Assigned Group Shift Name
Assigned_Group_Shift_Name
16
Table 1-2: Optional input field values (Continued) DB field on interface form Assignee Displayed on web services Assignee Notes Required when status is set to greater than or equal to Assigned Displayed under the Product Categorization section on the interface and main forms
Product Categorization Tier 1 Product_Categorization_ Tier_1
Product Categorization Tier 2 Product_Categorization_ Tier_2 Product Categorization Tier 3 Product_Categorization_ Tier_3 Product Name Product Model/Version Manufacturer Categorization Tier 1 Product_Name Product_Model_Version Manufacturer Categorization_Tier_1 Displayed under the Operational Categorization section on the interface and main forms
Categorization Tier 2 Categorization Tier 3 Closure Product Category Tier1
Categorization_Tier_2 Categorization_Tier_3 Closure_Product_Category_ Tier_1 Displayed under the Resolution Product Categorization Section on the interface and main forms
Closure Product Category Tier 2 Closure Product Category Tier 3 Closure Product Name Closure Product Model/ Version Closure Manufacturer Resolution Category Tier 1
Closure_Product_Category_ Tier_2 Closure_Product_Category_ Tier_3 Closure_Product_Name Closure_Product_Model_ Version Closure_Manufacturer Resolution_Category_Tier_1 Displayed under the Resolution Categorization Section on the interface and main forms
Resolution Category Tier 2 Resolution Category Tier 3 Direct Contact Company Direct Contact First Name Direct Contact Last Name
Resolution_Category_Tier_2 Resolution_Category_Tier_3 N/A Direct_Contact_First_Name Direct_Contact_Last_Name Chapter 1 Incident Management 17
Table 1-2: Optional input field values (Continued) DB field on interface form Direct Contact Phone Number Direct Contact Internet E-mail Direct Contact Organization Direct Contact Department Direct Contact Site CI Name Displayed on web services N/A N/A N/A N/A N/A CI_Name For more information about this element, see Associating entries with configuration items on page 9. For more information about this element, see Associating entries with configuration items on page 9. Required for creating work information Optional for creating work information. Defaults to General Information if left null. Optional for creating work information. Defaults to No if left null. Optional for creating work information. Defaults to Internal if left null. Optional for creating work information Optional for creating work information Optional for creating work information A Yes or No selection. Used to automatically generate a request entry when set to Yes. For more information about this, see Creating a service request entry on page 10. Notes
Lookup Keyword
Lookup_Keyword
z1D_WorklogDetails z1D_ActivityType
Work_Info_Summary Work_Info_Type
z1D_Secure_Log
Work_Info_Locked
z1D_View_Access
Work_Info_View_Access
z1D_Details z1D_ActivityDate_tab z1D_CommunicationSource Flag_Create_Request
Work_Info_Notes Work_Info_Date Work_Info_Source Create_Request
18
Table 1-2: Optional input field values (Continued) DB field on interface form ServiceCI Displayed on web services ServiceCI Notes For more information about this element, see Associating entries with configuration items on page 9. For more information about this element, see Associating entries with configuration items on page 9. If specified, the Middle Initial can make the customer information more unique. Otherwise, it will get populated automatically, if applicable.
ServiceCI_ReconID
ServiceCI_ReconID
HPD_CI_ReconID Middle Initial
HPD_CI_ReconID Middle_Initial
Status_Reason
Status_Reason
Direct Contact Middle Initial Direct_Contact_Middle_Initial If specified, the Middle Initial can make the direct contact information more unique. Otherwise, it will get populated automatically, if applicable. TemplateID TemplateID Optional for creating an incident using Incident Templates. Specify the Template InstanceID (FieldID 179) which can be found on the HPD:Template form.
The following table lists the fields set through workflow.

Table 1-3: Fields set through workflow DB field on interface form Incident Number Contact_Company Company Client Type Client Sensitivity VIP Notes
19
Table 1-3: Fields set through workflow (Continued) DB field on interface form Middle Initial Priority Priority Weight Person ID Site Group Site Site ID Organization Region Desk Location Mail Station Internet E-mail Phone_Number Department Reported Date CC Business Area Business Local Business Extension Business Incident_Entry_ID Assignee Login ID Schema Name HPD_CI HPD_CI_FormName z1D_CI_FormName State Province Street Zip/Postal Code Corporate ID Time Zone Direct Contact Region Direct Contact Site Group Set from the Assignment workflow Set from the CI Association Set from HPD_CI_ReconID value Set from HPD_CI_ReconID value Set from HPD_CI_ReconID value Set by the specified customer information Set by the specified customer information Set by the specified customer information Set by the specified customer information Set by the specified customer information Set by the specified direct contact information Set by the specified direct contact information Label isCountry Code Label isArea Code Label isLocal Phone Set from impact and urgency values Set from impact and urgency values Notes
20
Table 1-3: Fields set through workflow (Continued) DB field on interface form Direct Contact Street Direct Contact State/Province Direct Contact City Direct Contact Zip/Postal Code Direct Contact Time Zone Direct Contact Desk Location Direct Contact Mail Station Direct Contact Site ID Direct Contact Country Code Direct Contact Area Code Direct Contact Local Number Direct Contact Extension Notes Set by the specified direct contact information Set by the specified direct contact information Set by the specified direct contact information Set by the specified direct contact information Set by the specified direct contact information Set by the specified direct contact information Set by the specified direct contact information Set by the specified direct contact information Set by the specified direct contact information Set by the specified direct contact information Set by the specified direct contact information Set by the specified direct contact information
21
HelpDesk_Modify_Service
The following table indicates the values required to modify an incident through the HPD:IncidentInterface form. You can modify incident records either through web services or the interface form. When modifying an incident record through web services, observe the following points:
All fields mapped with values on the Help Desk form must be populated by the interface form, otherwise a null value is sent, and the current values are overwritten. The Assignee must be set through the HPD:Help Desk form to move past the Assigned status.
Displayed on web services Field value Action Notes
Table 1-4: Input fields DB field on interface form z1D Action
MODIFY Keyword triggers workflow that initiates the modify operation ID of This Incident qualification to modify determines which incident to modify.
Incident Number
Incident_Number
Company Impact Urgency Description Impact Urgency Summary Appears in Summary on the Help Desk form Appears in Notes on the Help Desk form
Detailed Description
Notes
Status Service Type Reported Source Product Categorization Tier 1 Product Categorization Tier 2 Product Categorization Tier 3
Status Service_Type Reported_Source Product_ Categorization_Tier_1 Product_ Categorization_Tier_2 Product_ Categorization_Tier_3
22
HelpDesk_Modify_Service
Table 1-4: Input fields (Continued) DB field on interface form Product Name Product Model/Version Manufacturer Categorization Tier 1 Categorization Tier 2 Categorization Tier 3 Closure Product Category Tier1 Closure Product Category Tier2 Closure Product Category Tier3 Closure Product Name Closure Model/Version Closure Manufacturer Resolution Resolution Category Resolution Category Tier 2 Resolution Category Tier 3 Resolution Method z1D_ WorklogDetails z1D_Activity_Type Displayed on web services Field value Product_Name Product_Model_Version Manufacturer Categorization_Tier_1 Categorization_Tier_2 Categorization_Tier_3 Closure_Product_ Category_Tier1 Closure_Product_ Category_Tier2 Closure_Product_ Category_Tier3 Closure_Product_Name Closure_Product_Model_ Version Closure_Manufacturer Resolution Resolution_Category Resolution_Category_ Tier_2 Resolution_Category_ Tier_3 Resolution_Method Work_Info_Summary Required for creating work information Optional for creating work information. Defaults to General Information if left null. Optional for creating work information. Defaults to No if left null. Notes
Work_Info_Type
z1D_Secure_Log
Work_Info_Locked
23
Table 1-4: Input fields (Continued) DB field on interface form z1D_View_Access Displayed on web services Field value Work_Info_View_Access Notes Optional for creating work information. Defaults to Internal if left null. Optional for creating work information Optional for creating work information Optional for creating work information For more information about this element, see Associating entries with configuration items on page 9. For more information about this element, see Associating entries with configuration items on page 9.
z1D_Details
Work_Info_Notes
z1D_ActivityDate_tab
Work_Info_Date
z1D_CommunicationSource
Work_Info_Source
Status_Reason ServiceCI
Status_Reason ServiceCI
ServiceCI_ReconID
ServiceCI_ReconID
HPD_CI HPD_CI_ReconID HPD_CI_FormName z1D_CI_FormName
24
HelpDesk_Query_Service and HelpDesk_QueryList_Service Functions
HelpDesk_Query_Service and HelpDesk_QueryList_Service Functions

The following two functions are web service specific. To perform a search outside of web services, do it directly from the HPD:Help Desk form.
Table 1-5: Input values Web service field Incident_Number Field value Notes This is used only by the HelpDesk_Query_Service operation. AR System qualification This is used only by the HelpDesk_QueryList_ Service operation.
Qualification
This table lists the output values.

Table 1-6: Output values Web service field Incident_Number Status Status_Reason Summary Notes Service_Type Reported_Source Impact Urgency Priority Priority_Weight First_Name Contact_Company Last_Name Middle_Initial VIP Contact_Sensitivity Phone_Number Internet_Email Company Organization Department Chapter 1 Incident Management 25 Notes Returned only in the HelpDesk_QueryList_Service
Table 1-6: Output values (Continued) Web service field Site Country Region City Site Group Assigned_Support_Company Assigned_Support_Organization Assigned_Support_Shift_Name Assigned_Group Assignee Product_Categorization_Tier_1 Product_Categorization_Tier_2 Product_Categorization_Tier_3 Product_Name Product_Model_Version Manufacturer Categorization_Tier_1 Categorization_Tier_2 Categorization_Tier_3 Closure_Product_Category_Tier1 Closure_Product_Category_Tier2 Closure_Product_Category_Tier3 Closure_Product_Name Closure_Product_Model_Version Closure _Manufacturer Resolution Resolution_Category Resolution_Category_Tier_2 Resolution_Category_Tier_3 ServiceCI For more information about this element, see Associating entries with configuration items on page 9. For more information about this element, see Associating entries with configuration items on page 9. Notes
ServiceCI_ReconID
26
Chapter
Problem Management
This section describes the functions associated with the following BMC Remedy Problem Management sub-systems:

Problem Investigation Known Error Solution Database
The following table provides a list of the available web services for each BMC Remedy Problem Management sub-system.
Table 2-1: Available web services Sub-system Problem Investigation Available web services Problem_Submit_Service Problem_Modify_Service Problem_Query_Service and Problem_QueryList_Service Known Error KnownError_Submit_Service KnownError_Modify_Service KnownError_Query_Service and KnownError_QueryList_Service Solution Database Solution_Submit_Service Solution_Modify_Service Solution_AddKeyword_Service Solution_Query_Service and Solution_QueryList_Service
You can also add a work information entry at the time you create or modify any of these records. In the Solution module, you can also add keywords to a Solution record. When using web services, you can query one, or a set of records from each subsystem.
Chapter 2
Problem Management
27
NOTE
The mappings on the PBM:ProblemInterface_Create form are shared among the Problem Management sub-systems, and therefore you should be cautious about which keywords you send into the action field. The following is a list of the web service functions available for BMC Remedy Problem Management. These functions are described in the sections that follow.

Submit (submit with work information, add a keyword in solution database) Modify (modify with work information, add a keyword in solution database) Query/Query List Add Keyword Service (Solution database sub-system only)
Problem Investigation
This section describes how to:

Make and modify problem investigation records. Query a problem investigation. Query a list of problem investigations.
You submit Problem Investigation entries through the

PBM:ProblemInterface_Create form.
Problem_Submit_Service
This interface form uses shared fields between Problem Investigation, Known Error, and Solution Database. Successfully creating a Problem Investigation entry through web services returns the newly created Problem Investigation ID. The following tables describe the values needed to create a Problem Investigation entry.
Table 2-2: Required input field values DB field on Displayed on web services interface form z1D_Action Action Field value Notes PROBLEM Keyword triggers workflow that initiates the submit operation
First Name Last Name Description
First_Name Last_Name Summary
28
Table 2-2: Required input field values (Continued) DB field on Displayed on web services interface form Status Impact Urgency Investigation Driver Assigned Group Pblm Mgr Status Impact Urgency Investigation_Driver Problem_Coordinator_Assigned_Group If Assignment engine is configured, you may not need to specify the Problem Coordinator values Field value Notes
Support Company Pblm Mgr Support Organization Pblm Mgr
Problem_Coordinator_Support_Company
Problem_Coordinator_Support_Organization
The following table lists the optional input field values.

Table 2-3: Optional input field values DB field on interface form Detailed Description Investigation Justification Displayed on web services Notes Investigation_Justification Notes
Product Categorization Tier 1 Product_Categorization_ Tier_1 Product Categorization Tier 2 Product_Categorization_ Tier_2 Product Categorization Tier 3 Product_Categorization_ Tier_3 Product Name Product Model/Version Manufacturer Temporary Workaround Product_Name Product_Model_Version Manufacturer Workaround
Generic Categorization Tier 1 Generic_Categorization_ Tier_1 Categorization Tier 1 Categorization Tier 2 Categorization Tier 3 Categorization_Tier_1 Categorizaton_Tier_2 Categorization_Tier_3 Chapter 2 Problem Management 29
Table 2-3: Optional input field values (Continued) DB field on interface form Assigned Support Company Assigned Support Organization Assigned Group z1D_WorklogDetails Displayed on web services Problem_Manager_Support_ Company Problem_Manager_Support_ Organization Problem_Manager_Assigned _Group Work_Info_Summary Required for creating work information Optional for creating work information. Defaults to General Information if left null. Optional for creating work information. Defaults to No if left null. Optional for creating work information. Defaults to Internal if left null. Optional for creating work information Optional for creating work information Optional for creating work information Target Date is required when Status is not at Draft stage Notes
z1D_Problem_Activity_Type
Work_Info_Type
z1D_Secure_Log
Work_Info_Locked
z1D_View_Access
z1D_Details
Work_Info_Notes
z1D_Activity_Date_tab
Work_Info_Date
z1D_ CommunicationSource Target Resolution Date
Work_Info_Source
Target_Date
30
Table 2-3: Optional input field values (Continued) DB field on interface form ServiceCI Displayed on web services ServiceCI Notes For more information about this element, see Associating entries with configuration items on page 9. For more information about this element, see Associating entries with configuration items on page 9.
ServiceCI_ReconID
ServiceCI_ReconID
PBM_CI_ReconID
PBM_CI_ReconID
The following table lists the fields set by workflow.

Table 2-4: Fields set by workflow DB field on interface form Sys-Problem Investigation ID Company Contact Company Requestor Company Support Organization Requester Support Group Name Requester Priority Priority Weight Requestor ID Problem Manager Login Site ID Site Region Site Group Phone Number Business Person ID Corporate ID Notes
Chapter 2
Problem Management
31
Table 2-4: Fields set by workflow (Continued) DB field on interface form Support Group ID Requester PBM Location Address PBM_CI z1D_CI_FormName Set from PBM_CI_ReconID value Set from PBM_CI_ReconID value Notes
Problem_Modify_Service
You search for, then modify, a specific problem using the problem investigation ID as the search criteria. Problem modifications are made through the PBM:ProblemInterface form.
NOTE
When using web services, you must use the interface form to populate all fields mapped to the Problem Investigation form, otherwise a null value is sent, and the current values are overwritten.
Table 2-5: Input field values DB field on interface form z1D_Action Displayed on web services Action Field value Notes MODIFY Keyword triggers workflow that initiates the modify operation Used as the search criteria
Problem Investigation ID Description Detailed_Description
Problem_Investigation_ ID Summary Notes
Appears in Notes on the PBM: Problem Investigation form
Investigation Status Investigation Status Reason Investigation Justification Investigation Driver Impact Urgency Product Categorization Tier 1 Product Categorization Tier 2
Investigation_Status Investigation_Status_ Reason Investigation_ Justification Investigation_Driver Impact Urgency Product_ Categorization_Tier_1 Product_ Categorization_Tier_2
32
Table 2-5: Input field values (Continued) DB field on interface form Product Categorization Tier 3 Product Name Product Model/ Version Manufacturer Categorization Tier 1 Categorization Tier 2 Categorization Tier 3 Displayed on web services Product_ Categorization_Tier_3 Product_Name Product_Model_ Version Manufacturer Categorization_Tier_1 Categorization_Tier_2 Categorization_Tier_3 Field value Notes
Generic Categorization Generic_ Tier 1 Categorization_Tier_1 Temporary Workaround z1D_WorklogDetails z1D_Details z1D_Activity Type Temporary_ Workaround Work_Info_Summary Work_Info_Notes Work_Info_Type Required for creating work information Optional for creating work information Optional for creating work information. Defaults to General Information if left null. Optional for creating work information Optional for creating work information Optional for creating work information. Defaults to No if left null. Optional for creating work information. Defaults to Internal if left null. For more information about this element, see Associating entries with configuration items on page 9. For more information about this element, see Associating entries with configuration items on page 9.
z1D_ActivityDate_ tab
Work_Info_Date
z1D_ Work_Info_Source CommunicationSource z1D_Secure_Log Work_Info_Locked
Z1D_View_Access
Work_Info_View_ Access
ServiceCI
ServiceCI
ServiceCI_ReconID
ServiceCI_ReconID
PBM_CI
PBM_CI
Chapter 2
Problem Management
33
Table 2-5: Input field values (Continued) DB field on interface form PBM_CI_ReconID z1D_CI_FormName Displayed on web services PBM_CI_ReconID z1D_CI_FormName Field value Notes
Problem_Query_Service and Problem_QueryList_Service Functions

Both of these functions are web service specific. To perform a search, do it directly from the PBM:Problem Investigation form.
Table 2-6: Input values Web service field Problem_Investigation_ID Field value Notes This is used only by the Problem_ Query_Service operation. AR System qualification This is used only by the Problem_ QueryList_Service operation.
Qualification
The following table lists the output values.

Table 2-7: Output values Web service field Problem_Investigation_ID Notes Returned only in the Problem_QueryList_Service operation
Investigation_Status Investigation_Status_Reason Investigation_Justification Investigation_Driver Summary Notes Impact Urgency Priority Priority_Weight First_Name Last_Name Company Contact_Company Region
34
Table 2-7: Output values (Continued) Web service field Site_Group Site Organization PBM_Location_Address Assigned_Support_Company Assigned_Support_Organization Assigned_Group Assignee Support_Group_Name_Requester Support_Organization_Requester Product_Categorization_Tier_1 Product_Categorization_Tier_2 Product_Categorization_Tier_3 Product_Name Product_Model_Version Manufacturer Categorization_Tier_1 Categorization_Tier_2 Categorization_Tier_3 Ceneric_Categorization_Tier_1 Temporary_Workaround Target_Date ServiceCI For more information about this element, see Associating entries with configuration items on page 9. For more information about this element, see Associating entries with configuration items on page 9. Notes
ServiceCI_ReconID
PBM_CI PBM_CI_ReconID PBM_CI_FormName Problem_Coordinator_Support_Company Problem_Coordinator_Support_Organization Problem_Coordinator_Assigned_Group Problem_Coordinator
Chapter 2
Problem Management
35
Known Error records

This section describes how to make and modify known error records. It also describes how to create a work information entry when creating or modifying a Known Error record. Successfully creating a Known Error entry through web services returns the newly created Known Error ID.
KnownError_Submit_Service
Known Error entries are submitted through the PBM:ProblemInterface_Create form.
NOTE
This interface form uses shared fields between Problem Investigation, Known Error, and Solution Database. The following tables describe the values needed to create a Known Error entry.
Table 2-8: Required input field values DB field on interface form z1D_Action Displayed on web services Action Field value Notes
KNOWNERROR Keyword triggers workflow that initiates the submit operation
Known Error Status Impact Urgency Description Detailed Description View Access Assigned Group Pblm Mgr
Status Impact Urgency Summary Notes View_Access Problem_Coordinator_ Assigned_Group If Assignment engine is configured, you may not need to specify the Problem Coordinator values
Support Problem_Coordinator_Support_ Company Pblm Company Mgr
36
Known Error records
Table 2-8: Required input field values (Continued) DB field on interface form Support Organization Pblm Mgr Displayed on web services Problem_Coordinator_Support_ Organization Field value Notes
Target Target_Date Resolution Date
The following table lists optional input field values.

Table 2-9: Optional input field values DB field on interface form Company Searchable Category Product Categorization Tier 1 Category Product_ Categorization_ Tier_1 Product_ Categorization_ Tier_2 Product_ Categorization_ Tier_3 Product Name Product Model/Version Manufacturer Categorization Tier 1 Categorization Tier 2 Categorization Tier 3 Generic Categorization Tier 1 Product_Name Product_Model_ Version Manufacturer Categorization_ Tier_1 Categorization_ Tier_2 Categorization_ Tier_3 Generic_ Categorization_ Tier_1 Temporary_ Workaround Resolution Assigned_Support_ Company Assigned_Support_ Organization Chapter 2 Problem Management 37 Displayed on web services Company Notes
Product Categorization Tier 2
Product Categorization Tier 3
Temporary Workaround Resolution Assigned Support Company Assigned Support Organization
Table 2-9: Optional input field values (Continued) DB field on interface form Assigned Group Assignee z1D_WorklogDetails z1D_Activity Type Displayed on web services Assigned_Group Assignee Work_Info_Summary Work_Info_Type Required for creating work information Optional for creating work information. Defaults to General Information if left null. Optional for creating work information. Defaults to No if left null. Optional for creating work information. Defaults to Internal if left null. Optional for creating work information Optional for creating work information Optional for creating work information For more information about this element, see Associating entries with configuration items on page 9. For more information about this element, see Associating entries with configuration items on page 9. Notes
z1D_Secure_Log
Work_Info_Locked
z1D_View_Access
Work_Info_View_ Access Work_Info_Notes Work_Info_Date Work_Info_Source ServiceCI
z1D_Details Z1D_ActivityDate_ tab z1D_ CommunicationSource ServiceCI
ServiceCI_ReconID
ServiceCI_ReconID
PBM_CI_ReconID
PBM_CI_ReconID
The following table lists fields set through workflow.

Table 2-10: Fields set through workflow DB field on interface form Known Error ID Priority Priority Weight PBM_CI z1D_CI_FormName Set from PBM_CI_ReconID value Set from PBM_CI_ReconID value Notes
38
Known Error records
KnownError_Modify_Service
Known Error modifications are done through the PBM:KnownErrorInterface form. To search for and then modify a specific Known Error, use the Known Error ID as the search criteria. When using web services, all fields mapped with values on the Known Error form must be populated by the interface form, otherwise a null value is sent and the current values are overwritten.
Table 2-11: Input field values DB field on interface form z1D_Action Displayed on web services Action Field value Notes MODIFY Keyword triggers workflow that initiates the modify operation
Known Error ID Know Error Status Status_Reason Description Detailed Description Impact Urgency View Access Searchable Category Company Product Categorization Tier 1 Product Categorization Tier 2 Product Categorization Tier 3 Product Name Product Model/Version Manufacturer Categorization Tier 1 Categorization Tier 2
Known_Error_ID Known_Error_Status Status_Reason Summary Notes Impact Urgency View_Access Searchable Category Company Product_ Categorization_Tier_ 1 Product_ Categorization_Tier_ 2 Product_ Categorization_Tier_ 3 Product_Name Product_Model_ Version Manufacturer Categorization_Tier_ 1 Categorization_Tier_ 2
Chapter 2
Problem Management
39
Table 2-11: Input field values (Continued) DB field on interface form Categorization Tier 3 Displayed on web services Categorization_Tier_ 3 Field value Notes
Generic Categorization Tier 1 Generic_ Categorization_ Tier_1 Temporary Workaround Resolution Assigned Support Company Assigned Support Organization Assigned Group Assignee z1D_ WorklogDetails z1D_Details z1D_Activity Type Temporary_ Workaround Resolution Assigned_ Support_Company Assigned_ Support_ Organization Assigned_Group Assignee Work_Info_ Summary Work_Info_Notes Work_Info_Type Required for creating work information Optional for creating work information Optional for creating work information. Defaults to General Information if left null. Optional for creating work information Optional for creating work information Optional for creating work information. Defaults to No if left null. Optional for creating work information. Defaults to Internal if left null. For more information about this element, see Associating entries with configuration items on page 9.
z1D_ActivityDate_tab z1D_CommunicationSource z1D_Secure_Log
Work_Info_Date Work_Info_ Source Work_Info_ Locked
z1D_View_Access
Work_Info_ View_Access
ServiceCI
ServiceCI
40
Known Error records
Table 2-11: Input field values (Continued) DB field on interface form ServiceCI_ReconID Displayed on web services ServiceCI_ReconID Field value Notes For more information about this element, see Associating entries with configuration items on page 9.
PBM_CI PBM_CI_ReconID z1D_CI_FormName
PBM_CI PBM_CI_ReconID z1D_CI_FormName
KnownError_Query_Service and KnownError_QueryList_Service Functions

These two functions are web service specific. To perform a search outside of web services, use the PBM:Known Error form.
Table 2-12: Input values Web service field Field value Known_Error_ID Notes This is used only in the KnownError_Query_Service Operation. AR System qualification This is only used in the KnownError_QueryList_Service operation.
Qualification
The following table lists the output values.

Table 2-13: Output values Web service field Known_Error_ID Notes Returned only in the KnownError_QueryList_Service operation
Summary Notes Known_Error_Status Status_Reason Impact Urgency Priority Priority_Weight Searchable Category
Chapter 2
Problem Management
41
Table 2-13: Output values (Continued) Web service field View_Access Company Product_Categorization_Tier_1 Product_Categorization_Tier_2 Product_Categorization_Tier_3 Product_Name Product_Model_Version Manufacturer Categorization_Tier_1 Categorization_Tier_2 Categorization_Tier_3 Generic_Categorization_Tier_1 Temporary_Workaround Resolution Assigned_Support_Company Assigned_Support_Organization Assigned_Group Assignee Support_Company_Pblm_Mgr Support_Organization_Pblm_Mgr Target_Date ServiceCI For more information about this element, see Associating entries with configuration items on page 9. For more information about this element, see Associating entries with configuration items on page 9. Notes
ServiceCI_ReconID
PBM_CI PBM_CI_ReconID PBM_CI_FormName Problem_Coordinator_Support_Company Problem_Coordinator_Support_Organization Problem_Coordinator_Assigned_Group Problem_Coordinator
42
Solution Database records

This section describes how to make and modify Solution Database records. It also describes how to query and add key words to a solution database. Successfully creating a Solution Database entry through web services returns the newly created Solution Database ID.
Solution_Submit_Service
You submit Solution Database entries through the PBM:ProblemInterface_Create form.
NOTE
This interface form uses shared fields between Problem Investigation, Known Error, and Solution Database. The following tables describe the values needed to create a Solution Database entry.
Table 2-14: Required input field values DB field on interface form z1D_Action Displayed on web services Action Field value Notes
SOLUTION Keyword triggers workflow that initiates the submit operation
Solution Status Solution Description Description Solution View Access Company Contact Company
Solution_Status Summary Abstract Solution View_Access Company Contact_Company This appears as Abstract on the Solution form.
This table lists the optional input field values.

Table 2-15: Optional input field values DB field on interface form Status_Reason Searchable Solution_Type Contact Company Organization Department Displayed on web services Notes Status_Reason Searchable Solution_Type Contact_Company Organization Department
Chapter 2
Problem Management
43
Table 2-15: Optional input field values (Continued) DB field on interface form Site Group Site Region Product Categorization Tier 1 Product Categorization Tier 2 Product Categorization Tier 3 Product Name Product Model/Version Manufacturer Categorization Tier 1 Categorization Tier 2 Categorization Tier 3 Displayed on web services Notes Site_Group Site Region Product_ Categorization_Tier_1 Product_ Categorization_Tier_2 Product_ Categorization_Tier_3 Product_Name Product_Model_Version Manufacturer Categorization_Tier_1 Categorization_Tier_2 Categorization_Tier_3
Assigned Support Company Assigned_Support_ Company Assigned Support Organization Assigned Group z1D Solution Keyword Assigned_Support_ Organization Assigned_Group Solution_Keyword Starts workflow to create a keyword for the new solution record Required for creating work information Optional for creating work information Optional for creating work information. Defaults to General Information if left null. Optional for creating work information Optional for creating work information Optional for creating work information. Defaults to No if left null.
z1D_ WorklogDetails z1D_Details z1D_Solution_ Activity_Type z1D_ActivityDate_tab z1D_ Communication_ Source z1D_Secure_Log
Work_Info_Summary Work_Info_Notes Work_Info_Type
Work_Info_Date Work_Info_Source
Work_Info_Locked
z1D_View_Access
Work_Info_View_Access Optional for creating work information. Defaults to Internal if left null.
44
This table lists the fields set by workflow. Table 2-16: Fields set by workflow DB field on interface form Solution Database ID Support Group ID Only set if Assigned, Support Company, Organization, and Group are not null Notes
Solution_Modify_Service
You make modifications through the PBM:SolutionInterface form. To find, then modify a specific solution, use the Solution Database ID as the search criteria.
NOTE
When using web services, you must use the interface form to populate all fields mapped to the Solution Database form, otherwise a null value is sent, and the current values are overwritten.
Table 2-17: Input field values DB field on interface form z1D_Action Displayed on web services Action Field value Notes
MODIFY Keyword triggers workflow that initiates the modify operation This is a search qualification.
Solution_Database_ID Solution Status Status_Reason Solution Description Abstract Solution View Access Searchable Solution_Type Company Contact Company Department Organization Region Site Group Site Solution_Status Status_Reason Solution_Summary Abstract Solution View_Access Searchable Solution_Type Company Contact_Company Department Organization Region Site_Group Site
Chapter 2
Problem Management
45
Table 2-17: Input field values (Continued) DB field on interface form Displayed on web services Field value Notes
Product Categorization Tier 1 Product_Categorization_ Tier_1 Product Categorization Tier 2 Product_Categorization_ Tier_2 Product Categorization Tier 3 Product_Categorization_ Tier_3 Product Name Product Model/Version Manufacturer Categorization Tier 1 Categorization Tier 2 Categorization Tier 3 Assigned Support Company Assigned Support Organization Assigned Group Assignee z1D Solution Keyword Product_Name Product_Model_Version Manufacturer Categorization_Tier_1 Categorization_Tier_2 Categorization_Tier_3 Assigned_Support_ Company Assigned_Support_ Organization Assigned_Group Assignee Solution_Keyword Used to create a keyword for the newly created solution record Required for creating work information Optional for creating work information Optional for creating work information. Defaults to General Information if left null. Optional for creating work information Optional for creating work information
z1D_Worklog_Details
Work_Info_Summary
z1D_Details
Work_Info_Notes
z1D_Activity_Type
Work_Info_Type
z1D_ActicityDate_tab
Work_Info_Date
z1D_CommunicationSource
Work_Info_Source
46
Table 2-17: Input field values (Continued) DB field on interface form z1D_Secure_Log Displayed on web services Work_Info_Locked Field value Notes Optional for creating work information. Defaults to No if left null. Optional for creating work information. Defaults to Internal if left null.
z1D_View_Access
Solution_AddKeyword_Service
This function adds a keyword to the specified solution entry. Use a keyword when you want to search the database for a solution entry with a particular subject.
Table 2-18: Input field values DB field on interface Displayed on web form services z1D_Action Action Field value ADDKEYWORD Notes Keyword triggers workflow that initiates the add keyword operation
Solution Database ID Solution_Database_ID z1D Solution Keyword Solution_Keyword
Solution_Query_Service and Solution_QueryList_Service Functions

These two functions are web service specific. To perform a search outside of web services, use the PBM:Solution Database form.
Table 2-19: Input values Web service field Solution_Database_ID Field value Notes This field is used only in the Solution_Query_Service operation. AR System qualification This field is used only in the Solution_QueryList_Service operation.
Qualification
Chapter 2
Problem Management
47

Table 2-20: Output values Web service field Solution_Database_ID Solution_Summary Solution_Status Solution_Type Searchable View_Access Abstract Solution Company Contact_Company Organization Department Region Site_Group Site Product_Categorization_ Tier_1 Product_Categorization_ Tier_2 Product_Categorization_ Tier_3 Product_Name Product_Model_Version Manufacturer Categorization_Tier_1 Categorization_Tier_2 Categorization_Tier_3 Assigned_Support_ Company Assigned_Support_ Organization Assigned_Group Assignee Notes Returned only in the Solution_QueryList_Service operation
48
Chapter
Change Management
You create and modify infrastructure change records using the BMC Remedy Change Management interface forms. When you create an infrastructure change, you can:

Relate the change with an existing CI entry. Create a work information entry.
When you modify an infrastructure change, you can also create a work information record. The following is a list of the web service functions available for BMC Remedy Change Management. These functions are described in the sections that follow.
Change_Submit_Servicesubmits change requests with work information and associates the change with an existing CI Change_Modify_Servicemodifies change requests with work information Change_Query_Service/Change_QueryList_Servicesearches for a specific change ticket (the Change_Query_Service) or set of change tickets (the Change_QueryList_Service)
You create, modify, and query release records using the Release Management interface forms. When you create a release, you can:

Relate the release with an existing CI entry. Create a work information entry. Use an existing release template.
You can also manage Manifest Relationships using the

ReleaseManifestInterface form, which enables you to create, update, and
remove these associations.
Chapter 3
Change Management
49
The following is a list of the web service functions available for Release Management. These functions are described in the sections that follow.

Release_Submit_Servicesubmits release requests Modify and query release operations Create Manifestcreates Manifest Associations UpdateManifestupdates Manifest Associations RemoveManifestremoves Manifest Associations Createcreates Release Relationship
Change_Submit_Service
To create an Infrastructure Change record, use either web services or use the interface form. The following tables describe the values required to create an Infrastructure Change record using the CHG:ChangeInterface_Create form. These tables list the interface field value and its corresponding web service value.
Table 3-1: Required input field values DB field on interface form z1D_Action Description Status Impact Urgency Change Type Timing Risk Level Company Location Company First Name Last Name Displayed on web services Action Summary Status Impact Urgency Change_Type Class Risk_Level Company Location_Company First_Name Last_Name Field value Notes
CREATE Keyword triggers workflow that initiates the submit operation
50
This table lists the optional field values.

Table 3-2: Optional input field values DB field on interface form Detailed Description Environment Reason For Change Lead Time Performance Rating Business Justification Product Cat Tier 1 (2) Product Cat Tier 2 (2) Product Cat Tier 3 (2) Product Name (2) Reason_For_Change Lead_Time Performance_Rating Business_Justification Product_Categ_Tier_1 Product_Categ_Tier_2 Product_Categ_Tier_3 Product_Name Displayed on web services Notes Notes Displayed on the main form as Notes
Product Model/Version Product_Model_ (2) Version Manufacturer (2) Categorization Tier 1 Categorization Tier 2 Categorization Tier 3 Requested Start Date Request End Date Scheduled Start Date Scheduled End Date Actual Start Date Actual End Date In Production Company3 Manufacturer Categorization_Tier_1 Categorization_Tier_2 Categorization_Tier_3 Requested_Start_Date Requested_End_Date Scheduled_Start_Date Scheduled_End_Date Actual_Start_Date Actual_End_Date In_Production_Date Chg_Manager_Support_ Used for assignment on Company the CHG:Infrastructure Change form Chg_Manager_Support_ Used for assignment on Organization the CHG:Infrastructure Change form Chg_Manager_Support_ Used for assignment on Group the CHG:Infrastructure Change form Change_Manager Used for assignment on the CHG:Infrastructure Change form Used for assignment on the CHG:Infrastructure Change form
Support Organization
Support Group Name
CAB Manager (Change Co-ord) ChgImpCpy
Chg_Implementer_ Support_Company
Chapter 3
Change Management
51
Table 3-2: Optional input field values (Continued) DB field on interface form ChgImpOrg Displayed on web services Chg_Implementer_ Support_Organization Chg_Implementer_ Support_Group Change_Implementer Notes Used for assignment on the CHG:Infrastructure Change form Used for assignment on the CHG:Infrastructure Change form Used for assignment on the CHG:Infrastructure Change form Used for assignment on the CHG:Infrastructure Change form Used for assignment on the CHG:Infrastructure Change form Used for assignment on the CHG:Infrastructure Change form Used for assignment on the CHG:Infrastructure Change form Used for tracking the approximate target date for completion of a change request For more information see Associating entries with configuration items on page 9. For more information see Associating entries with configuration items on page 9. Required for creating work information Optional for creating work information. Defaults to General Information if left null. Optional for creating work information. Defaults to No if left null.
ChgImpGrp
ChgImp
ASCPY
Chg_Assignee_Support _Company Chg_Assignee_Support _Organization Chg_Assignee_Support _Group Change_Coordinator
ASORG
ASGRP
ASCHG
Change Target Date
Change_Target_Date
CI Name
CI_Name
Lookup Keyword
Lookup_Keyword
z1D_WorklogDetails z1D_Activity Type
Work_Info_Summary Work_Info_Type
Secure Work Log
Work_Info_Locked
52
Table 3-2: Optional input field values (Continued) DB field on interface form View Access Displayed on web services Work_Info_View_ Access Notes Optional for creating work information. Defaults to Internal if left null. Optional for creating work information Optional for creating work information Optional for creating work information
z1D_Details z1D_ActivityDate_tab z1D_ CommunicationSource Phone Number Organization Department Support Group Name2
Work_Info_Notes Work_Info_Date Work_Info_Source Req_by_Phone_Number Req_By_Organization Req_By_Department Req_By_Group
This table lists the fields set through workflow.

Table 3-3: Fields set through workflow DB field on interface form Infrastructure Change ID Priority RequesterLoginID Submitter This is set to $USER$ by default (currently not a web service input). Set to $USER$ Notes
Chapter 3
Change Management
53
Change_Modify_Service
Use the Infrastructure Change ID as the search criteria to find, then modify, a specific change. You perform modifications through the CHG:ChangeInterface form.
NOTE
When using web services, you must use the interface form to populate all fields mapped to the CHG:ChangeInterface form, otherwise a null value is sent, and the current values are overwritten.
Table 3-4: Input field values DB field on interface form z1D_Action Displayed on web services Action Field value Notes MODIFY Keyword triggers workflow that initiates the modify operation Used as the qualification to search against the main form
Infrastructure Change ID
Infrastructure_Change_ID
Change Type Description Detailed Description Change Request Status Status Reason Impact Urgency Priority Risk Level Class Timing_Reason Lead Time Reason For Change Business Justification Environment Performance Rating Company First_Name Last_Name Phone_Number Organization
Change_Type Summary Notes Change_Request_Status Status_Reason Impact Urgency Priority Risk_Level Class Timing_Reason Lead_Time Reason_For_Change Business_Justification Environment Performance_Rating Company First_Name Last_Name Phone_Number Organization
54
Change_Modify_Service
Table 3-4: Input field values (Continued) DB field on interface form Department Displayed on web services Department Field value Notes
Support Organization2 Req_By_Support_ Organization Support Group Name2 Req_By_Support_Group Location Company Region Site Group Site Chg Location Address Product Cat Tier 1(2) Product Cat Tier 2(2) Product Cat Tier 3(2) Product Model/ Version(2) Product Name(2) Manufacturer(2) Categorization Tier 1 Categorization Tier 2 Categorization Tier 3 Company3 Support Organization Support Group Name Location_Company Region Site_Group Site Chg_Location_Address Product_Cat_Tier_1 Product_Cat_Tier_2 Product_Cat_Tier_3 Product_Model_Version Product_Name Manufacturer Categorization_Tier_1 Categorization_Tier_2 Categorization_Tier_3 Chg_Manager_Support_ Company Chg_Manager_Support_ Organization Chg_Manager_Support_ Group
CAB Manager (Change Change_Manager Co-ord) ASCPY ASORG ASGRP ASCHG ChgImpCpy ChgImpOrg ChgImpGrp Chg_Assignee_Support_ Company Chg_Assignee_Support_ Organization Chg_Assignee_Support_ Organization Change_Coordinator Chg_Implementer_ Support_Company Chg_Implementer_ Support_Organization Chg_Implementer_ Support_Group
Chapter 3
Change Management
55
Table 3-4: Input field values (Continued) DB field on interface form ChgImp Approval Phase Name Earliest Start Date Requested Start Date Requested End Date Scheduled Start Date Scheduled End Date Actual Start Date Actual End Date In Production z1D_WorklogDetails Displayed on web services Change_Implementer Approval_Phase_Name Earliest_Start_Date Requested_Start_Date Requested_End_Date Scheduled_Start_Date Scheduled_End_Date Actual_Start_Date Actual_End_Date In_Production Work_Info_Summary Required for creating work information Optional for creating work information Optional for creating work information. Defaults to General Information if left null. Optional for creating work information Optional for creating work information Optional for creating work information. Defaults to No if left null. Optional for creating work information. Defaults to Internal if left null. Used for tracking the approximate target date for completion of a change request Field value Notes
z1D_Details
Work_Info_Details
z1D_Activity Type
Work_Info_Type
z1D_ActivityDate_tab
Work_Info_Date
z1D_Communication Source z1D_Secure_Log
Work_Info_Source
Work_Info_Locked
z1D_View_Access
Change Target Date
Change_Target_Date
56
Change_Query_Service and Change_QueryList_Service Functions
Change_Query_Service and Change_QueryList_Service Functions

The Change_Query_Service and Change_QueryList_Service functions are specific to web services. To perform a search outside of web services, use the CHG:Infrastructure Change form.
Table 3-5: Input values Web service field Infrastructure_Change_ID Field value Notes This is used only by the Change_Query_ Service Operation. Valid AR System qualification Change_Target_Date This is used only by the Change_QueryList_Service operation. This is used for tracking the approximate target date for completion of a change request.
Qualification
Change Target Date

Table 3-6: Output values Web service field Infrastructure_Change_ID Summary Notes Change_Type Change_Request_Status Status_Reason Risk_Level Impact Urgency Priority Company First_Name Last_Name Phone_Number Organization Department Req_By_Support_Organization Req_By_Support_Group_Name Notes Returned only by the Change_QueryList_Service operation
Chapter 3
Change Management
57
Table 3-6: Output values (Continued) Web service field Customer_First_Name Customer_Middle_Name Customer_Last_Name Customer_Phone_Number Customer_Organization Customer_Department Location_Company Region Site_Group Site Chg_Location_Address Class Timing_Reason Lead_Time Reason_For_Change Business_Justification Environment Performance_Rating Product_Cat_Tier_1 Product_Cat_Tier_2 Product_Cat_Tier_3 Product_Name Product_Model_Version Manufacturer Categorization_Tier_1 Categorization_Tier_2 Categorization_Tier_3 Chg_Manager_Support_Company Chg_Manager_Support_Organization Chg_Manager_Support_Group Change_Manager Chg_Assignee_Support_Company Chg_Assignee_Support_Organization Chg_Assignee_Support_Group Change_Coordinator Chg_Implementer_Support_ Company Chg_Implementer_Support_ Organization 58 BMC Remedy IT Service Management 7.6.03 Integrations Notes
Release_Submit_Service
Table 3-6: Output values (Continued) Web service field Chg_Implementer_Support_Group Change_Implementer Approval_Phase_Name Earliest_Start_Date Requested_Start_Date Requested_End_Date Scheduled_Start_Date Scheduled_End_Date Actual_Start_Date Actual_End_Date In_Production Notes
Release_Submit_Service
To create a Release Request, use either web services or use the RMS:ReleaseInterface_Create form. The following table describes the values required to submit a Release Request using the RMS:ReleaseInterface_Create form.
Table 3-7: Required input field values DB field on interface form z1D Action Description First Name Impact Last Name Location Company Release Status Risk Level Urgency Company Business Justification Target Date Displayed on web services Action Description First_Name Impact Last_Name Location_Company Release_Status Risk_Level Urgency Company Business_Justification Target_Date The Requesters Support Company Field value Notes
CREATE Keyword triggers workflow that initiates the create operation
Chapter 3
Change Management
59
While you are using this web service, and if you are not using auto assignment, you should type the Release Manager Login ID instead of the Release Managers full name into the Release_Manager_LoginID field.
Modify and query release operations

To modify and query releases along with multiple relationships and work information entries, use either web services or use the RMS:ReleaseInterface, RMS:Associations, and RMS:WorkLog forms. These forms and web services support the following operations:

UpdateReleaseOnly updates release only QueryReleaseOnly queries release only UpdateReleaseAndRelationships updates release and relationships QueryReleasePlusRelationships queries release and relationships UpdateReleaseAndWorkInfo updates release and work information entries QueryReleaseAndWorkInfo queries release and work information entries UpdateReleaseAndRelationshipsAndWorkInfo updates release,
relationships, and work information entries
QueryReleasePlusRelationshipsAndWorkInfo queries release,
relationships, and work information entries
NOTE
You cannot create multiple relationships or work information entries using the interface forms. Use web services to create multiple relationships or work information entries. The following table describes the values required to update releases using the RMS:ReleaseInterface form.
Table 3-8: Required input field values for updating Release DB field on interface Displayed on web services form ReleaseID First Name Last Name Location Company Impact Urgency Description Release Status Company ReleaseID FirstName LastName LocationCompany Impact Urgency Description ReleaseStatus RequesterSupportCompany Field value Notes
60
Modify and query release operations
The following table describes the values required to update relationships using the RMS:Associations form.
Table 3-9: Required input field values for updating Relationships DB field on interface form Status Request ID01 Displayed on web services RelationshipsStatus RelatedItemID Field value Enabled Reconcilation ID for the CI that relates to the Release Request CI form name that relates to the Release Request Configuration Item CI name that relates to the Release Request Related to RMS:Release Release ID for relationships Notes
Form Name01 Request Type01 Request Description01 Association Type01 Form Name02 Request ID02
RelatedItemSource RelatedItemType Description RelationshipType FormName02 ReleaseID
The following table describes the values required to add work information entries using the RMS:WorkLog form.
Table 3-10: Required input field values for adding work information entries DB field on interface form Work Log Type Description Secure Work Log Communication Source Displayed on web services WorkInfoType WorkInfoSummary WorkInfoSecureLog WorkInfoCommSource Field value Notes
Chapter 3
Change Management
61
Create Manifest
To create Manifest Associations, use either web services or use the RMS:ReleaseManifestInterface form.
NOTE
The Release Record must exist before manifest associations can be added and Change Records should also already exist. The following table describes the values that are required to create Release Manifest Associations using the RMS:ReleaseManifestInterface form.
Table 3-11: Required input field values for creating Release Manifest Associations DB field on interface form z1D Action Displayed on web services z1D_Action Field value CREATE Notes Keyword triggers workflow that initiates the create operation
Submitter Status Form Name01 Form Name02 Request ID01 Request ID02 Association Type01 Request Type01
Submitter Status Form_Name01 Form_Name02 Request_ID01 Request_ID02 Association_Type01 Request_Type01 Enabled CHG:Infrastructure Change RMS:Release Change Request ID Release Request ID Consists of Infrastructure Change
Short Description Short_Description
62
UpdateManifest
UpdateManifest
To update Manifest Associations with milestone and phase information, use either web services or use the RMS:ReleaseManifestInterface form. The following table describes the values that are required to update Release Manifest Associations using the RMS:ReleaseManifestInterface form.
Table 3-12: Required input field values for updating Release Manifest Association DB field on interface form z1D Action Displayed on web services z1D_Action Field value MODIFY Notes Keyword triggers workflow that initiates the modify operation
Milestone Form Name01 Form Name02 Request ID01 Request ID02 Request Description01 Request Type01
Milestone Form_Name01 Form_Name02 Request_ID01 Request_ID02 Request_Description01 Request_Type01 Infrastructure Change CHG:Infrastructure Change RMS:Release Change Request ID Release Request ID
RemoveManifest
To remove Manifest Associations, use either web services or use the RMS:ReleaseManifestInterface form. The following table describes the values that are required to remove a Release Manifest Associations using the RMS:ReleaseManifestInterface form.(Continued)
Table 3-13: Required input field values for removing Release Manifest Association DB field on interface Displayed on web form services z1D Action z1D_Action Field value DELETE Notes Keyword triggers workflow that initiates the delete operation
Milestone Form Name01 Form Name02
Milestone Form_Name01 Form_Name02 CHG:Infrastructure Change RMS:Release Chapter 3 Change Management 63
Table 3-13: Required input field values for removing Release Manifest Association DB field on interface Displayed on web form services Request ID01 Request ID02 Request Description01 Request Type01 Request_ID01 Request_ID02 Request_Description0 1 Request_Type01 Infrastructure Change Field value Change Request ID Release Request ID Notes
Create (release relationships)

To create a Release Relationship, use either web services or use the RMS:RelationshipsInterface_Create form. The following table describes the values required to create a Release Relationship using the RMS:RelationshipsInterface_Create form.
Table 3-14: Required input field values DB field on interface form Status ReleaseID Form Name01 Displayed on web services Status ReleaseID Form_Name01 Field value Notes Active Release ID used to relate the relationships CI form name that relates with a Release Request RMS:Release Reconciliation ID for the CI that relates with the Release Request Release ID used to relate relationships CI name that relates with a Release Request Related to Configuration Item
Form Name02 ID01
Form_Name02 ID01
ID02 Request Description01 Association Type Request Type01
ID02 Request_Description01 Assocation_Type Request_Type01
64
Chapter
Asset Management
In BMC Remedy Asset Management, you can use web services to query and update purchase requisitions, purchase line items, purchase work information records, purchase orders, and purchase returns. For information about the Purchasing system, see the BMC Remedy Asset Management 7.6.03 User Guide. The following is a list of the interface forms available for BMC Remedy Asset Management. These interface forms are described as used by web services in the sections that follow.
AST:PurchaseRequisitionInterface_Create - creates a purchase requisition
and related work information record
AST:PurchaseLineItemInterface_Create - creates a purchase line item and
related work information record A purchase order can be created depending on the input status.
AST:WorkInfoInterface_Create - creates a work information record for
either purchase requisition or purchase line item
AST:PurchaseRequisitionInterface - queries and modifies a purchase
requisition

AST:PurchaseOrderInterface - queries and modifies a purchase order AST:PurchaseLineItemInterface - queries and modifies a purchase line item
The interface create forms can have the following sectional headers under which fields are grouped. Some fields shown on the interface forms are not mapped in the web services because they are either set by workflow or system-generated. Fields where values are input are described in the web service mapping tables.

Required Input Field Values - fields where a value must be input Conditional Required Input Field Values - fields that may require a value depending on other fields which are input Optional Input Field Values - fields where a value can optionally be input Fields Set through Workflow - fields that are set by workflow, and therefore do not require any input value Fields Set through Workflow or Input Values - fields that can be set by workflow but also support the option of inputting a value
Chapter 4 Asset Management 65
Change Management Integration fields - field that can be used if Change Management is installed PO Creation Field Values - fields that can be input if creating a Purchase Order Reference Numbers Generated - fields that are generated as a result of the create operation
More operations are available via web services. The following is a list of the web services available for BMC Remedy Asset Management. These web services are described in the sections that follow.
AST_PurchaseRequisitionInterface_Create_WS - supports the creation of
parent purchase requisitions and child purchase line items It also supports the creation of a work information record for parent and child items. A purchase order can be created depending on the status of the purchase requisition and purchase line items.
AST_PurchaseRequisition_QueryModify_WS - queries and modifies purchase
requisitions and its work information records and purchase line items
AST_PurchaseOrder_QueryModify_WS - queries and modifies purchase orders
and its purchase line items
AST_PurchaseLineItem_QueryModify_WS - queries and modifies purchase line items and its work information records and return records AST_WorkInfoInterface_Create - supports the creation of work information
records for either a purchase requisition or purchase line item
NOTE
Note: The following existing web services will be phased out as the functionality becomes available in the above new web services.
AST_PurchaseOrder_WS - updates and queries both purchase orders with the
date included and purchase order line items
AST_PurchaseOrder_WS_noDate - updates and queries both purchase orders without the date and purchase order line items AST_PurchaseOrderInterface_WS - updates and queries purchase orders with the date, but without purchase order line items
66
AST_PurchaseRequisitionInterface_Create_WS
The purchase requisition create web service is a complex web service based on the PurchaseRequisitionCreate.xsd file, which is also provided. This web service contains one operation as described below.
Create_PurchaseRequisition
This operation lets you create parent purchase requisitions and child purchase line items. It also creates a work information record for parent and child items if input values are supplied.
NOTE
It is recommended that you provide all the purchase line items while using the Create_PurchaseRequisition operation, if you are creating a purchase requisition with a status higher than In Preparation. The following lists input values for the parent level of the Create_PurchaseRequisition operation and maps to the AST:PurchaseRequisitionInterface_Create form.
Table 4-1: Input field values DB field on interface form Displayed on web services zID_Action Action Notes Required field "CREATE" is the only keyword supported and must be in upper case. Required field Accepted status values: In Preparation, On Order, Partially Received, Received, Closed, and Cancelled. Required field Required field Required field Required field Required if RequestedForFullName is not provided. Required if RequestedForPersonID is not provided.
Status
Status
Date Required Description Justification For_Company
DateRequired Description Justification RequestedForCompany
Requested_For_PersonID RequestedForPersonID
For_Full Name
RequestedForFullName
Login Name For_Phone For_Department
RequestedForLoginName RequestedForPhoneNumber RequestedForDepartment
Chapter 4
Asset Management
67
Table 4-1: Input field values (Continued) DB field on interface form Displayed on web services Manager Name ManagerFullName Notes By default this is the manager of the Requested For person, and is used as the first approver by the provided process. If the status is In Preparation. then a value is recommended. A Full Name other than the actual manager can be supplied. Login identifier of the value supplied for Manager Name. Required field Required if RequestedByFullName is not provided. Required if RequestedByPersonID is not provided.
Manager Login Name
ManagerLoginName
By_Company Requested_By_PersonID
RequestedByCompany RequestedByPersonID
By_Full Name
RequestedByFullName
Requester Login Name By_Phone By_Department Shipping Instructions PRNumber
RequestedByLoginName RequestedByPhoneNumber RequestedByDepartment ShippingInstructions PRNumber Available for storing external procurement system reference number. Hidden field that can store a tag identifier. Supported values are "Yes" or "No".
DataTags Install Needed Cost Center Accounting Code Project Number Budget Code z1D_Activity_Type z1D_ActivityDate_tab z1D_Communication Source z1D_Summary
DataTags InstallNeeded CostCenter AccountingCode ProjectNumber BudgetCode WorkInfoType WorkInfoDate WorkInfoSource WorkInfoSummary
Required if creating a work information record. Required if creating a work information record. Required if creating a work information record. Required if creating a work information record.
68
Table 4-1: Input field values (Continued) DB field on interface form Displayed on web services z1D_Details z1D_Secure_Log z1D_View Access WorkInfoNotes WorkInfoLocked WorkInfoViewAccess Notes Required if creating a work information record. Required if creating a work information record. Required if creating a work information record. Supported values are "Internal" or "External." Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Bill To fields are required and will be set based on Requested For.
z2AF_Act_Attachment_1 /attachmentName z2AF_Act_Attachment_1 /attachmentData z2AF_Act_Attachment_1 /attachmentOrigSize z2AF_Act_Attachment_2 /attachmentName z2AF_Act_Attachment_2 /attachmentData z2AF_Act_Attachment_2 /attachmentOrigSize z2AF_Act_Attachment_3 /attachmentName z2AF_Act_Attachment_3 /attachmentData z2AF_Act_Attachment_3 /attachmentOrigSize BillToAddr_Street
WorkInfoAttachment1Name WorkInfoAttachment1Data WorkInfoAttachment1OrigSize WorkInfoAttachment2Name WorkInfoAttachment2Data WorkInfoAttachment2OrigSize WorkInfoAttachment3Name WorkInfoAttachment3Data WorkInfoAttachment3OrigSize BillToStreet
BillToAddr_City Name+ BillToAddr_State Prov+ BillToAddr_Country+ ShipToAddr_Street
BillToCity BillToStateProv BillToCountry ShipToStreet Ship To fields are required and will be set based on Requested For.
BillToAddr_Postal Code+ BillToPostalCode
ShipToAddr_City Name+ ShipToCity ShipToAddr_State Prov+ ShipToStateProv ShipToAddr_Postal Code+ ShipToAddr_Country+ ShipToPostalCode ShipToCountry
Chapter 4
Asset Management
69
Table 4-1: Input field values (Continued) DB field on interface form Displayed on web services Assigned Support Company SupportCompany Notes Assigned field values can be automatically set by workflow if a Group Assignment General event is defined.
Assigned Support Organization Assigned Group Assignee TemplateInstanceID
SupportOrganization AssignedGroup Assignee ChangeTemplateInstanceID Integration available if Change Management is installed. Specify the CHG Template ID (FieldID 179) which can be found in the CHG:Template form. If value is supplied then Installed Needed should be set to Yes.
The following lists input values for the child level of the Create_PurchaseRequisition operation and maps to the AST:PurchaseLineItemInterface_Create form.
Table 4-2: Input field values DB field on interface form zID_Action Displayed on web services Action Notes Required field "CREATE" is the only keyword supported and must be in upper case. Required field Required field Required field Accepted status values: In Preparation, On Order, Partially Received, Received, and Cancelled. Required field in the format of CI Keyword, for example BMC_COMPUTERSYSTEM. Required field Required if auto receive is set to yes and CI Type is Software Class or if Status is Received.
Part Number Short Description Status
PartNumber Description Status
Asset Class ID
AssetClassID
Unit of Measure Required Qty* Total Received Qty
UnitOfMeasure RequiredQty TotalReceivedQty
70
Table 4-2: Input field values (Continued) DB field on interface form Unit Price/currencyValue Displayed on web services UnitPriceAmount Notes If a value is provided, must provide the currency code. If Unit Price is 0 and if the order status is "In Preparation", then the Status of PLI will switch to Pending Pricing. Must provide a currency value if currency code is provided. If a value is provided, must provide the currency code. Must provide a currency value if currency code is provided. If a value is provided, must provide the currency code. Must provide a currency value if currency code is provided. Set to "Yes" if Tax Amount is supplied. If a value is provided, must provide the currency code. Must provide a currency value if currency code is provided. If Taxable = "Yes", must provide rate. If a value is provided, must provide the currency code. Must provide a currency value if currency code is provided. Required if CI Type is Software Class. Required if CI Type is Software Class. Required if CI Type is Software Class. Required if CI Type is Software Class. Required if CI Type is Software Class. Chapter 4 Asset Management 71
Unit Price/currencyCode
UnitPriceCurrency Code EstimatedPriceAmount EstimatedPriceCurrency Code ActualPriceAmount ActualPriceCurrency Code Taxable TaxAmount TaxCurrencyCode
Estimated Price/ currencyValue Estimated Price/ currencyCode Actual Price/currencyValue Actual Price/currencyCode
Taxable Tax Amount/currencyValue Tax Amount/currencyCode
Tax Rate Shipping & Handling/ currencyValue Shipping & Handling/ currencyCode
TaxRate ShippingAndHandling Amount ShippingAndHandling CurrencyCode
Product Categorization Tier 1 ProductTier1 Product Categorization Tier 2 ProductTier2 Product Categorization Tier 3 ProductTier3 Model Version Number MarketVersion ProductName ModelVersion MarketVersion
Table 4-2: Input field values (Continued) DB field on interface form Manufacture Name+ Supplier Name+ Displayed on web services Manufacturer SupplierName Notes Required if CI Type is Software Class. Required for most Status values. If Supplier is not filled in while In Preparation then the Status will switch to Pending Pricing. Required field Required if Status is On Order or greater. Required if Software Contract ID is used Either SoftwareContractID or Certificate ID is required if CI Type is Software Class. Required if Software Contract ID is used. Need to provide the license type GUID. In order to get this, user must go to the interface form and use the drop down box to select the type. The GUID will be displayed when type is selected. Either SoftwareContractID or Certificate ID is required if CI Type is Software Class. If the CertificateID is specified, it must be a valid Certificate ID and should not be related to another purchase line item. Available for storing external procurement system reference number. Available for storing external purchase order reference number.
Date Required Date Ordered Estimated Receiving Date LicenseCertificateType Software Contract ID
DateRequired DateOrdered DateToReceive CertificatePurchaseType SoftwareContractID
LicenseTypeGUID
LicenseType
zID_CertificateID
CertificateID
PRNumber
PRNumber
PO Number
PONumber
Quote Number QuoteDesc Data Tags Cost Center Accounting Code 72
QuoteNumber QuoteInfo Data Tags CostCenter AccountingCode Hidden field that can store a tag identifier. Required if Software Contract ID is used.
Table 4-2: Input field values (Continued) DB field on interface form Project Number Budget Code Attachment1/ attachmentName Attachment1/ attachmentOrigSize Notes to Purchasing Notes to Supplier Notes zID_Activity_Type zID_ActivityDate_Tab zID_CommunicationSource zID_Summary zID_Detailes z2AF_Act_Attachment_1/ attachmentName z2AF_Act_Attachment_1/ attachmentData z2AF_Act_Attachment_1/ attachmentOrigSize z2AF_Act_Attachment_2/ attachmentName z2AF_Act_Attachment_2/ attachmentData z2AF_Act_Attachment_2/ attachmentOrigSize z2AF_Act_Attachment_3/ attachmentName z2AF_Act_Attachment_3/ attachmentData z2AF_Act_Attachment_3/ attachmentOrigSize zID_Secure_Log Displayed on web services ProjectNumber BudgetCode PLIAttachment1Name Notes
Attachment1/attachmentData PLIAttachment1Data PLIAttachment1OrigSize NotesToPurchasing NotesToSupplier EnterNotes WorkInfoType WorkInfoDate WorkInfoSource WorkInfoSummary WorkInfoNotes WorkInfoAttachment1N ame WorkInfoAttachment1 Data WorkInfoAttachment1 OrigSize WorkInfoAttachment2 Name WorkInfoAttachment2 Data WorkInfoAttachment2 OrigSize WorkInfoAttachment3 Name WorkInfoAttachment3 Data WorkInfoAttachment3 OrigSize WorkInfoLocked Required if creating a work information record. Required if creating a work information record. Required if creating a work information record. Required if creating a work information record. Required if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record.. Optional if creating a work information record. Required if creating a work information record.
Chapter 4
Asset Management
73
Table 4-2: Input field values (Continued) DB field on interface form zID_View_Access Displayed on web services WorkInfoViewAccess Notes Required if creating a work information record. Supported values are "Internal" or "External." Will be stored in the Purchase Order if one is generated. Will be stored in the Purchase Order if one is generated. Will be stored in the Purchase Order if one is generated. Will be stored in the Purchase Order if one is generated. Will be stored in the Purchase Order if one is generated. Will be stored in the Purchase Order if one is generated.
Buyer Name
BuyerName
OrderConfirmationTypeCode ConfirmationCode Payment Terms Freight Terms Ship Via Shipping Options PaymentTerms FreightTerms ShipVia ShippingOptions
The following lists output values for the parent level of the Create_PurchaseRequisition operation from the AST:PurchaseRequisitionInterface_Create form.
Table 4-3: Output field values DB field on interface form instanceId Displayed on web services InstanceID Notes Unique identifier generated for each purchase requisition. Unique visible Requisition ID system generated.
Requisition ID
RequisitionID
The following lists output values for the child level of the Create_PurchaseRequisition operation from the AST:PurchaseLineItemInterface_Create form.
Table 4-4: Output field values DB field on interface form instanceId Displayed on web services InstanceID Notes Unique identifier generated for each line item.
74
AST_PurchaseRequisition_QueryModify_WS
This is a complex web service based on the PurchaseRequisitionQueryModify.xsd file, which is provided with the application. This web service supports two operations, query and modify, as explained below.
Query_PurchaseRequisition
This operation supports a qualification to query for parent requisitions. It will also return related children purchase line items and work information records for each purchase requisition found, based on the qualification entered. Depending on how general the qualification is, startRecord and maxLimit can be used to determine how many records should be shown at a time. The following lists input values for the parent the Query_PurchaseRequisition operation against AST:PurchaseRequisitionInterface form.
Table 4-5: Input field values DB field on interface form Displayed on web services Qualification startRecord maxLimit Notes AR System qualification required.
AST:PurchaseRequisitionInterface (Query)
The following lists output values for the parent level of the Query_PurchaseRequisition operation and maps to the AST:PurchaseRequisitionInterface form.
Table 4-6: Output field values DB field on interface form instanceId Displayed on web services InstanceID Notes Returns unique instance ID of the purchase requisition. Returns unique visible Requisition ID.
Requisition ID Status Date Required Description Justification For_Company For_Full Name For_Phone For_Department Manager Name
RequisitionID Status DateRequired Description Justification RequestedForCompany RequestedForFullName RequestedForPhoneNumber RequestedForDepartment ManagerFullName Chapter 4
Asset Management
75
Table 4-6: Output field values (Continued) DB field on interface form Manager Login Name By_Company Requested_By_PersonID By_Full Name Requester Login Name By_Phone By_Department Shipping Instructions PRNumber DataTags Install Needed Cost Center Accounting Code Project Number Budget Code BillToAddr_Street BillToAddr_City Name+ BillToAddr_State Prov+ BillToAddr_Postal Code+ BillToAddr_Country+ ShipToAddr_Street ShipToAddr_City Name+ ShipToAddr_State Prov+ ShipToAddr_Postal Code+ ShipToAddr_Country+ Assigned Support Company Assigned Support Organization Assigned Group Assignee Change Template TemplateInstanceID Displayed on web services ManagerLoginName RequestedByCompany RequestedByPersonID RequestedByFullName RequestedByLoginName RequestedByPhoneNumber RequestedByDepartment ShippingInstructions PRNumber DataTags InstallNeeded CostCenter AccountingCode ProjectNumber BudgetCode BillToStreet BillToCity BillToStateProv BillToPostalCode BillToCountry ShipToStreet ShipToCity ShipToStateProv ShipToPostalCode ShipToCountry SupportCompany SupportOrganization AssignedGroup Assignee ChangeTemplateName ChangeTemplateInstanceID Notes
76
The following lists output values for the child level of the Query_PurchaseRequisition operation and maps to the AST:PurchaseRequisitionWorkLog form.
Table 4-7: Output field values DB field on interface form InstanceId Displayed on web services WorkInfoInstanceId Notes The unique Instance ID for the work information record. This is the foreign key, purchase requisition Instance ID, which the work information record is linked to.
PR Instance ID
SourceInstanceID
Work Log Type Work Log Date Communication Source Description Detailed Description Secure Work log View Access z2AF Work Log01/ attachmentName z2AF Work Log01/ attachmentData z2AF Work Log01/ attachmentOrigSize z2AF Work Log02/ attachmentName z2AF Work Log02/ attachmentData z2AF Work Log02/ attachmentOrigSize z2AF Work Log03/ attachmentName z2AF Work Log03/ attachmentData z2AF Work Log03/ attachmentOrigSize
WorkInfoType WorkInfoDate WorkInfoSource WorkInfoSummary WorkInfoNotes WorkInfoLocked WorkInfoViewAccess WorkInfoAttachment1Name WorkInfoAttachment1Data WorkInfoAttachment1OrigSize WorkInfoAttachment2Name WorkInfoAttachment2Data WorkInfoAttachment2OrigSize WorkInfoAttachment3Name WorkInfoAttachment3Data WorkInfoAttachment3OrigSize
Chapter 4
Asset Management
77
The following lists output values for the child level of the Update_Requisition operation and maps to the AST:PurchaseLineItem form.
Table 4-8: Output field values DB field on interface form instanceId Displayed on web services InstanceID Notes Returns unique identifier, purchase line item Instance ID.
Part Number Description Status Asset Class Unit of Measure Required Qty* Total Received Qty Unit Price/currencyValue Unit Price/currencyCode Estimated Price/ currencyValue Estimated Price/ currencyCode Actual Price/currencyValue Actual Price/currencyCode Taxable Tax Amount/currencyValue Tax Amount/currencyCode Shipping & Handling/ currencyValue Shipping & Handling/ currencyCode
PartNumber Description Status CIType UnitOfMeasure RequiredQty TotalReceivedQty UnitPriceAmount UnitPriceCurrencyCode EstimatedPriceAmount EstimatedPriceCurrencyCode ActualPriceAmount ActualPriceCurrencyCode Taxable TaxAmount TaxCurrencyCode ShippingAndHandlingAmount ShippingAndHandlingCurrency Code
Product Categorization Tier 1 ProductTier1 Product Categorization Tier 2 ProductTier2 Product Categorization Tier 3 ProductTier3 Model Version Number MarketVersion Manufacture Name+ Supplier Name+ Requisition ID Order ID Quote Number QuoteDesc PRNumber 78 ProductName ModelVersion MarketVersion Manufacturer SupplierName RequisitionID OrderID QuoteNumber QuoteInfo PRNumber
Table 4-8: Output field values (Continued) DB field on interface form PO Number Data Tags Date Required Date Ordered Estimated Receiving Date Notes to Purchasing Notes to Supplier LicenseCertificateType Software Contract ID zID_LicenseType zID_CertificateID Cost Center Accounting Code Project Number Budget Code Attachment1/ attachmentName Attachment1/ attachmentData Attachment1/ attachmentOrigSize Audit Trail Displayed on web services PONumber Data Tags DateRequired DateOrdered DateToReceive NotesToPurchasing NotesToSupplier CertificatePurchaseType SoftwareContractID LicenseType CertificateID CostCenter AccountingCode ProjectNumber BudgetCode PLIAttachment1Name PLIAttachment1Data PLIAttachment1OrigSize ReadNotes Notes
Update_PurchaseRequisition
This operation supports the update of an existing parent purchase requisition, and updates to related children purchase line items and work information records. The qualification entered determines which purchase requisitions are updated, only child records related to the parent can be updated. In addition children purchase line items and work information records can also be created. The following lists input values for the parent level of the Update_PurchaseRequisition operation and maps to the AST:PurchaseRequisitionInterface form.
Table 4-9: Input field values DB field on interface form Displayed on web services Qualification Notes AR System qualification required and is based on AST:PurchaseRequisitionInte rface fields.
instanceId Requisition ID
InstanceID RequisitionID Chapter 4 Asset Management 79
Table 4-9: Input field values (Continued) DB field on interface form Status Date Required Description Justification For_Company Requested_For_PersonID For_Full Name Login Name For_Phone For_Department Manager Name Manager Login Name By_Company Requested_By_PersonID By_Full Name Requester Login Name By_Phone By_Department Shipping Instructions PRNumber DataTags Install Needed Cost Center Accounting Code Project Number Budget Code BillToAddr_Street BillToAddr_City Name+ BillToAddr_State Prov+ BillToAddr_Country+ ShipToAddr_Street ShipToAddr_State Prov+ ShipToAddr_Postal Code+ ShipToAddr_Country+ Assigned Support Company 80 Displayed on web services Status DateRequired Description Justification RequestedForCompany RequestedForPersonID RequestedForFullName RequestedForLoginName RequestedForPhoneNumber RequestedForDepartment ManagerFullName ManagerLoginName RequestedByCompany RequestedByPersonID RequestedByFullName RequestedByLoginName RequestedByPhoneNumber RequestedByDepartment ShippingInstructions PRNumber DataTags InstallNeeded CostCenter AccountingCode ProjectNumber BudgetCode BillToStreet BillToCity BillToStateProv BillToCountry ShipToStreet ShipToStateProv ShipToPostalCode ShipToCountry SupportCompany Notes
BillToAddr_Postal Code+ BillToPostalCode
ShipToAddr_City Name+ ShipToCity
Table 4-9: Input field values (Continued) DB field on interface form Assigned Support Organization Assigned Group Assignee TemplateInstanceID Displayed on web services SupportOrganization AssignedGroup Assignee ChangeTemplateInstanceID Notes
The following lists input values for the child level of the Update _PurchaseRequisition operation and maps to the AST:PurchaseRequisitionWorkLog form.
Table 4-10: Input field values DB field on form InstanceId Displayed on web services WorkInfoInstanceId Notes Provides the work information Instance ID to be updated. If a new Instance ID is provided (one that is not in the database), a new work information record will be created. This is the foreign key, purchase requisition Instance ID, which the work information is linked to, and required if creating a new work information record. Required if creating a work information record. Supported values are: Detailed Clarification, Purchase Requisition Task, General Information, Email System,and Paging System. Required if creating a work information record. Required if creating a work information record. Supported values are: Email, Fax, Phone, Voice Mail, Walk In, Pager, System Assignment, Web, and Other. Required if creating a work information record. Optional if creating a work information record. Required if creating a work information record. Supported values are "Yes" or "No."
PR Instance ID
SourceInstanceID
Work Log Type
WorkInfoType
Work Log Date Communication Source
WorkInfoDate WorkInfoSource
Description Detailed Description Secure Work log
WorkInfoSummary WorkInfoNotes WorkInfoLocked
Chapter 4
Asset Management
81
Table 4-10: Input field values (Continued) DB field on form View Access Displayed on web services WorkInfoViewAccess Notes Required if creating a work information record. Supported values are "Internal" or "Public. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record. Optional if creating a work information record.
z2AF Work Log01/ attachmentName z2AF Work Log01/ attachmentData z2AF Work Log01/ attachmentOrigSize z2AF Work Log02/ attachmentName z2AF Work Log02/ attachmentData z2AF Work Log02/ attachmentOrigSize z2AF Work Log03/ attachmentName z2AF Work Log03/ attachmentData z2AF Work Log03/ attachmentOrigSize
WorkInfoAttachment1 Name WorkInfoAttachment1 Data WorkInfoAttachment1 OrigSize WorkInfoAttachment2 Name WorkInfoAttachment2 Data WorkInfoAttachment2 OrigSize WorkInfoAttachment3 Name WorkInfoAttachment3 Data WorkInfoAttachment3 OrigSize
The following lists input values for the child level of the Update_PurchaseRequisition operation and maps to the AST:PurchaseLineItem form.
Table 4-11: Input field values DB field on form instanceId Displayed on web services Notes InstanceID Provide the purchase line item Instance ID to be updated. If a new Instance ID is provided, a purchase line item will be created. Required if creating a new purchase line item. Required if creating a new purchase line item. Required if creating a new purchase line item. Required if creating a new purchase line item in the format of CI Keyword. For example, BMC_COMPUTERSYSTEM.
Part Number Description Status Asset Class ID
PartNumber Description Status AssetClassID
82
Table 4-11: Input field values (Continued) DB field on form Asset Class Displayed on web services Notes AssetClass Required if creating a new purchase line item in the format of Proper Name of CI. Required if creating a new purchase line item. Required if creating a new purchase line item. Required if creating a new purchase line item. If a value is provided, must provide the currency code. Must provide a currency value if currency code is provided. If a value is provided, must provide the currency code. Must provide a currency value if currency code is provided. If a value is provided, must provide the currency code. Must provide a currency value if currency code is provided. Supported values are "Yes" or "No". If a value is provided, must provide the currency code. Must provide a currency value if currency code is provided. If Taxable = "Yes", must provide rate. If a value is provided, must provide the currency code. Must provide a currency value if currency code is provided. Required if creating a new purchase line item, and CI Type is Software Class. Required if creating a new purchase line item, and CI Type is Software Class. Chapter 4 Asset Management 83
RequestedFor_Company Unit of Measure Required Qty* Received Qty Unit Price/currencyValue Unit Price/currencyCode
RequestedForCompany UnitOfMeasure RequiredQty ReceivedQty UnitPriceAmount UnitPriceCurrencyCode
Estimated Price/ currencyValue Estimated Price/ currencyCode Actual Price/currencyValue Actual Price/currencyCode
EstimatedPriceAmount EstimatedPriceCurrency Code ActualPriceAmount ActualPriceCurrency Code Taxable TaxAmount TaxCurrencyCode
Taxable Tax Amount/currencyValue Tax Amount/currencyCode
Tax Rate Shipping & Handling/ currencyValue Shipping & Handling/ currencyCode
TaxRate ShippingAndHandling Amount ShippingAndHandling CurrencyCode
Product Categorization Tier 1 ProductTier1
Table 4-11: Input field values (Continued) DB field on form Displayed on web services Notes Required if creating a new purchase line item, and CI Type is Software Class. Required if creating a new purchase line item, and CI Type is Software Class. Required if creating a new purchase line item, and CI Type is Software Class. Required if creating a new purchase line item, and CI Type is Software Class. Required if creating a new purchase line item. Required if creating a new purchase line item. Required if creating a new purchase line item, CI Type is Software Class, and Auto receive is set to "Yes" or if Status is On Order or higher. Required if creating a new purchase line item, and Software Contract ID is provided. Either SoftwareContractID or Certificate ID is required if creating a new line, and CI Type is Software Class. Required if Software Contract ID is provided. Need to provide the license type GUID. In order to get this, user must go to the interface form and use the drop down box to select the type. The GUID will be displayed when type is selected. This value is the value used.
Model
ProductName
Version Number MarketVersion
ModelVersion MarketVersion
Manufacture Name+
Manufacturer
Supplier Name+ Date Required Date Ordered
SupplierName DateRequired DateOrdered
Estimated Receiving Date LicenseCertificateType
DateToReceive CertificatePurchaseType
Software Contract ID
SoftwareContractID
zID_LicenseType
LicenseType
84
Table 4-11: Input field values (Continued) DB field on form zID_CertificateID Displayed on web services Notes CertificateID Either SoftwareContractID or Certificate ID is required if CI Type is Software Class. If the CertificateID is specified, it must be a valid Certificate ID and should not be related to another purchase line item.
PRNumber PO Number Quote Number QuoteDesc Data Tags Cost Center
PRNumber PO]Number QuoteNumber QuoteInfo Data Tags CostCenter Required if creating a new purchase line item, and Software Contract ID is provided.
Accounting Code Project Number Budget Code Attachment1/ attachmentName Attachment1/ attachmentData Attachment1/ attachmentOrigSize Notes to Purchasing Notes to Supplier
AccountingCode ProjectNumber BudgetCode PLIAttachment1Name PLIAttachment1Data PLIAttachment1OrigSize NotesToPurchasing NotesToSupplier
The following lists output values for the parent level of the Update_PurchaseRequisition operation from the AST:PurchaseRequisitionInterface form.
Table 4-12: Output field values DB field on interface form InstanceId Displayed on web services InstanceID Notes Unique identifier for each updated purchase requisition. Unique visible Requisition ID for each updated purchase requisition.
Requisition ID
RequisitionID
Chapter 4
Asset Management
85
The following lists output values for the child level of the Update_PurchaseRequisition operation from the AST:PurchaseRequisitionWorkLog form.
Table 4-13: Output field values DB field on interface form InstanceId Displayed on web services InstanceID Notes Unique identifier for each updated or added work information record.
The following lists output values for the child level of the Update_PurchaseRequisition operation from the AST:PurchaseLineItem form.
Table 4-14: Output field values DB field on interface form InstanceId Displayed on web services InstanceID Notes Unique identifier for each updated or added purchase line item.
AST_PurchaseOrder_QueryModify_WS
This is a complex web service based on the PurchaseOrderQueryModify.xsd file, which is provided with the application. This web service contains two operations that are described below.
Query_PurchaseOrder
This operation supports a qualification to query for purchase orders. It will also return related children purchase line items for each purchase order found, based on the qualification entered. Depending on how general the qualification is, startRecord and maxLimit can be used to determine how many records should be shown at a time. The following lists input values for the Query_PurchaseOrder operation against the parent AST:PurchaseOrderInterface form.
Table 4-15: Input field values DB field on interface form Displayed on web services Qualification Notes AR System qualification required and is based on AST:PurchaseOrderInterf ace fields.
startRecord maxLimit
86
The following lists output values for the parent level of the Query_PurchaseOrder operation and maps to the AST:PurchaseOrderInterface form.
Table 4-16: Output field values DB field on interface form Order ID Displayed on web services OrderID Notes Returns unique system-generated Order ID.
Status PO Number Date Ordered Payment Terms Buyer Requested By+ Supplier Name+ Notes to Supplier Tax Rate Tax Amount/currencyValue Tax Amount/currencyCode Shipping & Handling/ currencyValue Shipping & Handling/ currencyCode BillToAddr_Street BillToAddr_City Name+ BillToAddr_State/Prov BillToAddr_Postal Code BillToAddr_Country ShipToAddr_Street ShipToAddr_City Name+ ShipToAddr_State/Prov ShipToAddr_Postal Code ShipToAddr_Country Freight Terms Ship Via Shipping Options OrderConfirmation Type Code WebServiceOrder
Status PONumber DateOrdered PaymentTerms Buyer RequestedBy SupplierName NotesToSupplier TaxRate TaxAmount TaxCurrencyCode ShippingAndHandlingAmount ShippingAndHandlingCurrency Code BillToStreet BillToCity BillToStateProv BillToPostalCode BillToCountry ShipToStreet ShipToCity ShipToStateProv ShipToPostalCode ShipToCountry FreightTerms ShipVia ShippingOption OrderConfirmationTypeCode WebServiceOrder
Chapter 4
Asset Management
87
The following lists output values for the child level of the Query_PurchaseOrder operation and maps to the AST:PurchaseLineItem form .
Table 4-17: Output field values DB field on form instanceId Displayed on web services InstanceID Notes Returns unique identifier, purchase line item Instance Id.
Part Number Description Status Asset Class RequestedForCompany Unit of Measure Required Qty* Total Received Qty Unit Price/currencyValue Unit Price/currencyCode Estimated Price/ currencyValue Actual Price/currencyValue Actual Price/currencyCode Taxable Tax Amount/currencyValue Tax Amount/currencyCode Shipping & Handling/ currencyValue Shipping & Handling/ currencyCode Product Categorization Tier 1 Product Categorization Tier 2 Product Categorization Tier 3 Model Version Number MarketVersion Manufacture Name+ Supplier Name+ Requisition ID Order ID Quote Number QuoteDesc
PartNumber Description Status CIType RequesterCompany ProductUnitOfMeasureCode RequiredQty TotalReceivedQty UnitPriceAmount UnitPriceCurrencyCode EstimatedPriceAmount
Estimated Price/currencyCode EstimatedPriceCurrencyCode ActualPriceAmount ActualPriceCurrencyCode Taxable TaxAmount TaxCurrencyCode ShippingAndHandling Amount ShippingAndHandling CurrencyCode Tier1 Tier2 Tier3 ProductName ModelVersion MarketVersion Manufacturer SupplierName RequisitionID OrderID QuoteNumber QuoteInfo
88
Table 4-17: Output field values (Continued) DB field on form Date Required Date Ordered Estimated Receiving Date Notes to Purchasing Notes to Supplier Cost Center Accounting Code Project Number Budget Code Attachment1/ attachmentName Attachment1/ attachmentOrigSize Audit Trail LicenseCertificateType Software Contract ID zID_LicenseType zID_CertificateID Displayed on web services DateRequired DateOrdered DateToReceive NotesToPurchasing NotesToSupplier CostCenter AccountingCode ProjectNumber BudgetCode DetailsAttachment1Name Notes
Attachment1/attachmentData DetailsAttachment1Data DetailsAttachment1OrigSize ReadNotes PurchaseType SoftwareContractID LicenseType CertificateID
Update_PurchaseOrder
This operation supports the update of a purchase order plus updates to existing purchase line items. The qualification entered determines which purchase order is updated. Only child records related to the parent can be updated. The following lists the input values for the parent level of the Update_PurchaseOrder operation and maps to the AST:PurchaseOrderInterface form.
Table 4-18: Input field values DB field on interface form Displayed on web services Qualification Notes AR System qualification required, and is based on AST:PurchaseOrderInterf ace fields.
Order ID Supplier Name+ Status PO Number
OrderID SupplierName Status PONumber Available for storing external purchase order reference number.
Chapter 4
Asset Management
89
Table 4-18: Input field values (Continued) DB field on interface form Payment Terms Buyer Requested By+ Notes to Supplier Tax Rate Tax Amount/currencyValue Displayed on web services PaymentTerms Buyer RequestedBy NotesToSupplier TaxRate TaxAmount Must provide currency value if currency code provided. Must provide currency code if currency value provided. Must provide currency value if currency code provided. Must provide currency code if currency value provided. Notes
Tax Amount/currencyCode
TaxCurrencyCode
Shipping & Handling/ currencyValue Shipping & Handling/ currencyCode BillToAddr_Street BillToAddr_City Name+ BillToAddr_State/Prov BillToAddr_Postal Code BillToAddr_Country ShipToAddr_Street ShipToAddr_City Name+ ShipToAddr_State/Prov ShipToAddr_Postal Code ShipToAddr_Country Freight Terms Ship Via Shipping Options OrderConfirmation Type Code WebServiceOrder
ShippingAndHandling Amount ShippingAndHandling CurrencyCode BillToStreet BillToCity BillToStateProv BillToPostalCode BillToCountry ShipToStreet ShipToCity ShipToStateProv ShipToPostalCode ShipToCountry FreightTerms ShipVia ShippingOption OrderConfirmationType Code WebServiceOrder
90
The following lists input values for the child level of the Update_PurchaseOrder operation and maps to the AST:PurchaseLineItem form.
Table 4-19: Input field values DB field on interface form instanceId Displayed on web services InstanceID Notes Provide the purchase line item Instance ID to be updated. Must provide currency value if currency code provided. Must supply currency code if currency value provided.
Unit Price/currencyValue
UnitPriceAmount
Unit Price/currencyCode
UnitPriceCurrencyCode
Taxable Quote Number QuoteDesc EstimatedReceivingDate Notes to Purchasing Notes to Supplier Cost Center Accounting Code Project Number Budget Code Attachment1/ attachmentName Attachment1/ attachmentData Attachment1/ attachmentOrigSize Received Qty
Taxable QuoteNumber QuoteInfo DateToReceive NotesToPurchasing NotesToSupplier CostCenter AccountingCode ProjectNumber BudgetCode DetailsAttachment1Name DetailsAttachment1Data DetailsAttachment1OrigSize ReceivedQty
The following lists output values for the parent level of the Update_PurchaseOrder operation from the AST:PurchaseOrderInterface form.
Table 4-20: Output field values DB field on interface form instanceId Displayed on web services InstanceID Notes Unique identifier for each updated purchase order.
Chapter 4
Asset Management
91
The following lists output values for the child level of the Update_PurchaseOrder operation from the AST:PurchaseLineItem form.
Table 4-21: Output field values DB field on interface form instanceId Displayed on web services InstanceID Notes Unique identifier for each updated purchase line item.
AST_PurchaseLineItem_QueryModify_WS
This is a complex web service based on the PurchaseLineItemQueryModify.xsd file, which is provided with the application. This web service contains two operations that are described below.
Query_PurchaseLineItem
The query operation supports a qualification to query for purchase line items. It will also return related children work information and return records for each purchase line item found, based on the qualification entered. Depending on how general the qualification is, startRecord and maxLimit can be used to determine how many records should be shown at a time. The following lists input values for the Query_PurchaseLineItem operation against the parent AST:PurchaseLineItemInterface form.
Table 4-22: Input field values DB field on interface form Displayed on web services Qualification Notes AR System qualification required and is based on AST:PurchaseLineItemInterface fields.
startRecord maxLimit
The following lists output values for the parent level of the Query_PurchaseLineItem operation and maps to the AST:PurchaseLineItemInterface form.
Table 4-23: Output field values DB field on interface form InstanceID Displayed on web services InstanceID Notes Returns unique identifier, purchase line item Instance Id.
Part Number Description 92
PartNumber ItemDescription
Table 4-23: Output field values (Continued) DB field on interface form Status Asset Class RequestedFor_Company Unit of Measure Required Qty Received Qty Total Received Qty Unit Price/currencyValue Unit Price/currencyCode Estimated Price/ currencyValue Estimated Price/ currencyCode Actual Price/currencyValue Actual Price/currencyCode Taxable Tax Amount/currencyValue Tax Amount/currencyCode ShippingAndHandling/ currencyValue ShippingAndHandling/ currencyCode Displayed on web services ItemStatus CIType RequesterCompany UnitOfMeasure RequiredQty ReceivedQty TotalReceivedQty UnitPriceAmount UnitPriceCurrencyCode EstimatedPriceAmount EstimatedPriceCurrencyCode ActualPriceAmount ActualPriceCurrencyCode Taxable TaxAmount TaxCurrencyCode ShippingAndHandlingAmount ShippingAndHandling CurrencyCode Notes
Product Categorization Tier 1 ProductTier1 Product Categorization Tier 2 ProductTier2 Product Categorization Tier 3 ProductTier3 ProductName ModelVersion MarketVersion Manufacturer SupplierName RequisitionID OrderID QuoteNumber QuoteDesc PRNumber PO Number Data Tags Date Required Date Ordered Model VersionNumber MarketVersion ManufacturerName+ Supplier Name+ Requisition ID Order ID Quote Number QuoteInfo PRNumber PONumber DataTags DateRequired DateOrdered
Chapter 4
Asset Management
93
Table 4-23: Output field values (Continued) DB field on interface form EstimatedReceivingDate Notes to Purchasing Notes to Supplier Cost Center Accounting Code Project Number Budget Code Attachment1/ attachmentName Attachment1/ attachmentData Attachment1/ attachmentOrigSize Audit Trail License Certificate Type Software Contract ID zID_LicenseType zID_LicenseCertificateID Displayed on web services DateToReceive NotesToPurchasing NotesToSupplier CostCenter AccountingCode ProjectNumber BudgetCode PLIAttachmentName PLIAttachmentData PLIAttachmentOrigSize ReadNotes CertificatePurchaseType Software Contract ID LicenseType CertificateID Notes
The following lists output values for the child level of the Query_PurchaseLineItem operation and maps to the AST:PurchaseRequisitionWorkLog form.
Table 4-24: Output field values DB field on interface form InstanceId Displayed on web services WorkInfoInstanceID Notes The unique Instance ID for the work information record. This is the foreign key, purchase line item Instance ID, which the work information record is linked to.
Purchase Line Item Instance ID
SourceInstanceID
Work Log Type Work Log Date Communication Source Description Detailed Description Secure Work Log View Access z2AF Work Log01/ attachmentName 94
WorkInfoType WorkInfoDate WorkInfoSource WorkInfoSummary WorkInfoNotes WorkInfoLocked WorkInfoViewAccess WorkInfoAttachment1Name
Table 4-24: Output field values (Continued) DB field on interface form z2AF Work Log01/ attachmentData z2AF Work Log01/ attachmentOrigSize z2AF Work Log02/ attachmentName z2AF Work Log02/ attachmentData z2AF Work Log02/ attachmentOrigSize z2AF Work Log03/ attachmentName z2AF Work Log03/ attachmentData z2AF Work Log03/ attachmentOrigSize Displayed on web services WorkInfoAttachment1Data WorkInfoAttachment1OrigSize WorkInfoAttachment2Name WorkInfoAttachment2Data WorkInfoAttachment2OrigSize WorkInfoAttachment3Name WorkInfoAttachment3Data WorkInfoAttachment3OrigSize Notes
The following lists output values for the child level of the Query_PurchaseLineItem operation and maps to the AST:PurchaseReturn form.
Table 4-25: Output field values DB field on interface form Instanceid Line Item Instance ID Type RMA Number Quantity to Return Reason for Return Replacement Received Displayed on web services InstanceID LineItemInstanceID Type RMANumber QuantityToReturn ReasonForReturn ReplacementReceived Notes Returns unique identifier. Purchase line item Instance ID.
Update_PurchaseLineItem
This operation supports the update of an existing purchase line item, and updates to related children work information and return records. The qualification entered determines which purchase line items are updated. Only child records related to the parent can be updated. In addition, children work information and return records can also be created.
Chapter 4
Asset Management
95
The following lists the input values for the parent level of the Update_PurchaseLineItem operation and maps to the AST:PurchaseLineItemInterface form.
Table 4-26: Input field values DB field on interface form Displayed on web services Qualification Unit Price/currencyValue Unit Price/currencyCode Taxable Quote Number QuoteDesc EstimatedReceivingDate Notes to Purchasing Notes to Supplier Cost Center Accounting Code Project Number Budget Code Attachment1/ attachmentName Attachment1/ attachmentData Attachment1/ attachmentOrigSize Received Qty UnitPriceAmount UnitPriceCurrencyCode Taxable QuoteNumber QuoteInfo DateToReceive NotesToPurchasing NotesToSupplier CostCenter AccountingCode ProjectNumber BudgetCode DetailsAttachment1Name DetailsAttachment1Data DetailsAttachment1OrigSize ReceivedQty Notes AR System qualification required.
96
The following lists input values for the child level of the Update_PurchaseLineItem operation and maps to the AST:PurchaseRequisitionWorkLog form.
Table 4-27: Input field values DB field on form InstanceId Displayed on web services WorkInfoInstanceID Notes If a new Instance ID is provided (one that is not in the database), a new work information record will be created. If existing instance Id is provided the matching work information record will be updated. This is the foreign key, purchase line item Instance ID, which the work information record is linked to. Required if creating a new work information record. Required if creating a work information record. Supported values are: Detailed Clarification, Purchase Requisition Task, General Information, Email System and Paging System. Required if creating a work information record. Required if creating a work information record. Supported values are: Email, Fax, Phone, Voice Mail, Walk In, Pager, System Assignment, Web and Other. Required if creating a work information record. Required if creating a work information record. Required if creating a work information record. Supported values are: "Yes" or "No." Required if creating a work information record. Supported values are: "Internal" or "Public."
Purchase Line Item Instance ID
SourceInstanceID
Work Log Type
WorkInfoType
Work Log Submit Date Communication Source
WorkInfoDate WorkInfoSource
Description Detailed Description Secure Work Log
WorkInfoSummary WorkInfoNotes WorkInfoLocked
View Access
WorkInfoViewAccess
Chapter 4
Asset Management
97
Table 4-27: Input field values (Continued) DB field on form z2AF Work Log01/ attachmentName z2AF Work Log01/ attachmentData z2AF Work Log01/ attachmentOrigSize z2AF Work Log02/ attachmentName z2AF Work Log02/ attachmentData z2AF Work Log02/ attachmentOrigSize z2AF Work Log03/ attachmentName z2AF Work Log03/ attachmentData z2AF Work Log03/ attachmentOrigSize Displayed on web services WorkInfoAttachment1Name WorkInfoAttachment1Data Notes Optional if creating a work information record. Optional if creating a work information record.
WorkInfoAttachment1OrigSize Optional if creating a work information record. WorkInfoAttachment2Name WorkInfoAttachment2Data Optional if creating a work information record. Optional if creating a work information record.
WorkInfoAttachment2OrigSize Optional if creating a work information record. WorkInfoAttachment3Name WorkInfoAttachment3Data Optional if creating a work information record. Optional if creating a work information record.
WorkInfoAttachment3OrigSize Optional if creating a work information record.
The following lists input values for the child level of the Update_PurchaseLineItem operation and maps to the AST:PurchaseReturn form.
Table 4-28: Input field values DB field on form Instanceid Displayed on web services Instanceid Notes If a new Instance ID is provided, a purchase return will be created and this is the typical usage. If existing Instance ID is provided updates can be made. Purchase line item Instance Id is required. Required field "Replace" and "Return." Required field Required field Required field
Line Item Instance ID Type RMA Number Quantity to Return Reason for Return
LineItem InstanceID Type RMANumber QuantityToReturn ReasonForReturn
98
The following lists output values for the parent level of the Update_PurchaseLineItem operation from the AST:PurchaseLineItemInterface form.
Table 4-29: Output field values DB field on form InstanceId Displayed on web services InstanceID Notes Unique identifier for each updated purchase line item.
The following lists output values for the child level of the Update_PurchaseLineItem operation from the AST:PurchaseRequisitionWorkLog form.
Table 4-30: Output field values DB field on form InstanceId Displayed on web services WorkInfoInstanceID Notes Unique identifier for each updated or added work information record.
The following lists output values for the child level of the Update_PurchaseLineItem operation from the AST:PurchaseReturn form.
Table 4-31: Output field values DB field on form Instanceid Displayed on web services ReturnsInstanceID Notes Unique identifier for each updated or added purchase return.
Chapter 4
Asset Management
99
AST_WorkInfoInterface_Create_WS
This is a simple web service. It contains one operation and supports the creation of a work information record for either a purchase requisition or purchase line item.
Create_WorkInfo
Table 4-32: Input field values DB field on form zID_Action Displayed on web services zID_Action Notes Required field with two keywords supported; "CREATEPR" to create a work information for purchase requisition and "CREATEPLI" to create a work information record for a purchase line item. Required field Provide either the purchase requisition Instance Id or the purchase line item Instance Id. Required for creating a work information record. Supported values are Detailed Clarification, Purchase Requisition Task , General Information, Email System and Paging System. Required for creating a work information record. Required for creating a work information record. Supported values are "Yes" or "No." Required for creating a work information record. Supported values are "Internal" or "Public." Required for creating a work information record. Required for creating a work information record. Required for creating a work information record.
SourceInstanceID
SourceInstanceID
Work Log Type
Work_Log_Type
Description Secure Work Log
Description Secure_Work_Log
View Access
View_Access
Status Work Log Submit Date Submitter
Status Work_Log_Submit_Date Submitter
100
AST_WorkInfoInterface_Create_WS
Table 4-32: Input field values (Continued) DB field on form Assigned To Short Description Assignee Groups Vendor Assignee Groups Requisition ID PRNumber Data Tags Notes Work Log Submitter z2AF Work Log01/ attachmentName z2AF Work Log01/ attachmentData z2AF Work Log01/ attachmentOrigSize z2AF Work Log02/ attachmentName z2AF Work Log02/ attachmentData z2AF Work Log02/ attachmentOrigSize z2AF Work Log03/ attachmentName z2AF Work Log03/ attachmentData z2AF Work Log03/ attachmentOrigSize Number of Attachments Communication Source Work Log Date Displayed on web services Assigned_To Short_Description Assignee_Groups Vendor_Assignee_Groups Requisition_ID PRNumber Data Tags Notes Work_Log_Submitter WorkInfoAttachment1 Name WorkInfoAttachment1 Data WorkInfoAttachment1 OrigSize WorkInfoAttachment2 Name WorkInfoAttachment2 Data WorkInfoAttachment2 OrigSize WorkInfoAttachment3 Name WorkInfoAttachment3 Data WorkInfoAttachment3 OrigSize Number_of_Attachments Communication_Source Work_Log_Date Set using workflow. Set using workflow. Optional for creating a work information record. Optional for creating a work information record. Optional for creating a work information record. Optional for creating a work information record. Optional for creating a work information record. Optional for creating a work information record. Optional for creating a work information record. Optional for creating a work information record. Optional for creating a work information record. Optional for creating a work information record. Optional for creating a work information record. Optional for creating a work information record. Optional for creating a work information record. Recommended for creating a work information record. Recommended for creating a work information record. Notes Optional for creating a work information record. Required for creating a work information record.
Chapter 4 Asset Management
101
The following lists output values for the AST:WorkInfoInterface_Create form.

Table 4-33: Output field values DB field on form InstanceID Displayed on web services InstanceID Notes Unique identifier generated for a work information record.
AST_PurchaseOrder_WS and AST_PurchaseOrder_WS_noDate

This section describes the inputs and outputs for the following web services:

AST_PurchaseOrder_WS AST_PurchaseOrder_WS_noDate
NOTE
With a few noted exceptions, these web services share the same mapping structure. See the Notes column in the following tables for details about the exceptions.
Qualifications
The qualifications across these two web services differ from each other as described in the following table.
Table 4-34: Qualifications Web service AST_PurchaseOrder_WS Qualifications This function has a value of 1 (Yes) for the WebServiceOrder field on the AST:PurchaseOrder form. For the Get_List_Of_New_Pos functions, you must set the OrderConfirmationTypeCode field to null on the AST:PurchaseOrder form. AST_PurchaseOrder_WS_noDate This function has a value of 0 (No) for the WebServiceOrder field on the AST:PurchaseOrder form. For the Get_List_Of_New_Pos functions, you must set the OrderConfirmationTypeCode field to null on the AST:PurchaseOrder form.
102
NOTE
The WebServiceOrder, and OrderConfirmationTypeCode fields appear on the Tracking tab of the AST:PurchaseOrder form.
Update_PO_Confirmation
Use the Update_PO_Confirmation function to update information about a specific purchase order and its set of line items. The following table describes the field values required to use this function.
Table 4-35: Input field values Field DB name on form N/A Supplier Name+ Displayed on web services POID Supplier Notes Qualification to search on Used in AST_ PurchaseOrder_ WS qualification only
PO Number Freight Terms Ship Via Shipping Options currencyValue
PONumber Freight Terms ShipVia ShippingOption ShippingCost.MonetaryAmount Shipping & Handling field on AST: PurchaseOrder ShippingCost.CurrencyCode Shipping & Handling field on AST: PurchaseOrder
currencyCode
Tax Rate OrderConfirmationTypeCode AST:PurchastLineItem
TaxRate OrderConfirmationTypeCode getListValues Line items are a subset of a purchase order. A one-tomany relationship is defined for line items to purchase orders.
instanceId currencyValue currencyCode
ItemID UnitPrice.MonetaryAmount UnitPrice.CurrencyCode
103
Get_Specific_PO
This function returns the values of a specific purchase order and its line items.
Table 4-36: Input field values Displayed on web services PONumber Supplier Notes Qualification on which to search
This table lists the output field values.

Table 4-37: Output field values Displayed on web services POID PONumber POStatus DateOrdered Supplier Buyer NotesToSupplier FreightTerms ShipVia ShippingOption ShippingCost.MonetaryAmount ShippingCost.CurrencyCode TotalPrice.MonetaryAmount TotalPrice.CurrencyCode BillingTo.AddressLine1 BillingTo.AddressCity BillingTo.AddressState BillingTo.AddressPostalCode BillingTo.AddressCountry ShippingTo.AddressLine1 ShippingTo.AddressCity ShippingTo.AddressState ShippingTo.AddressPostalCode ShippingTo.AddressCountry Item ItemID PartNumber ItemDescription Line items on a purchase order. It has a oneto-many relationship with purchase order. Notes
104
Table 4-37: Output field values (Continued) Displayed on web services ItemStatus Quantity ProductUnitOfMeasureCode UnitPrice.MoneteryAmount UnitPrice.CurrencyCode QuoteNumber Taxable Notes
Get_List_Of_New_POs
This function returns the values for a list of purchase orders and its line items.
Table 4-38: Input field values Displayed on web services Supplier

Table 4-39: Output field values Displayed on web services POID PONumber POStatus DateOrdered Supplier Buyer NotesToSupplier FreightTerms ShipVia ShippingOption ShippingCost.MonetaryAmount ShippingCost.CurrencyCode BillingTo.AddressLine1 BillingTo.AddressCity BillingTo.AddressState BillingTo.AddressPostalCode BillingTo.AddressCountry ShippingTo.AddressLine1 ShippingTo.AddressCity Only displayed in the AST_PurchaseOrder_WS web service Notes
105
Table 4-39: Output field values (Continued) Displayed on web services ShippingTo.AddressState ShippingTo.AddressPostalCode ShippingTo.AddressCountry OrderConfirmationTypeCode Item Line item for purchase order. It has a oneto-many relationship with purchase order. Notes
ItemID PartNumber ItemDescription ItemStatus Quantity ProductUnitOfMeasureCode UnitPrice.MoneteryAmount UnitPrice.CurrencyCode QuoteNumber Taxable
AST_PurchaseOrderInterface_WS
The purchase order interface web service lets you modify and query purchase order records through an interface form. The AST_PurchaseOrder_WS and AST_PurchaseOrder_WS_noDateweb services also perform these functions, but interact directly with the AST:PurchaseOrder form.
PO_Modify_Service
This function updates a purchase order by way of the AST:PurchaseOrderInterface form. You cannot update the line items for a purchase.
Table 4-40: Input field values DB field on interface form N/A N/A Requisition ID PO Number Notes to Supplier Status Displayed on web services POID Supplier Requisition_ID PONumber NotesToSupplier Status Notes A qualification to search on Used for qualification
106
Table 4-40: Input field values (Continued) DB field on interface form WebServiceOrder Buyer Date Ordered Payment Terms Tax Rate BillToAddr_City_Name+ BillToAddr_Country BillToAddr_PostalCode+ BillToAddr_State/Prov ShipToAddr_Street ShipToAddr_City_Name+ ShipToAddr_Country ShipToAddr_PostalCode+ ShipToAddr_State/Prov ShipToAddr_Street Buyer Date_Ordered Payment_Terms Tax_Rate BillToAddr_City_Name BillToAddr_Country BillToAddr_PostalCode BillToAddr_State_Prov ShipToAddr_Street ShipToAddr_City_Name ShipToAddr_Country ShipToAddr_PostalCode ShipToAddr_State_Prov ShipToAddr_Street Displayed on web services Notes
PO_Query_Service
The PO_Query_Service function returns a specific purchase order by way of the AST:PurchaseOrderInterface form.
NOTE
A query cannot return line item values for a purchase order.
Table 4-41: Input field values Displayed on web services Order_ID Notes Used as a qualification

Table 4-42: Output field values Displayed on web services Order_ID PO_Number Status Supplier_Name Buyer Notes_to_Supplier Freight_Terms Payment_terms Notes
107
Table 4-42: Output field values (Continued) Displayed on web services ShippingVia ShippingOptions OrderConfirmationTypeCode BillToAddr_City_Name+ BillToAddr_Country BillToAddr_PostalCode+ BillToAddr_State/Prov ShipToAddr_Street ShipToAddr_City_Name+ ShipToAddr_Country ShipToAddr_PostalCode+ ShipToAddr_State/Prov ShipToAddr_Street Notes
PO_GetListofNewPO_Service
The PO_GetListofNewPO_Service function returns a group of purchase orders by way of the AST:PurchaseOrderInterface form.
NOTE
This function cannot return the line item values for a purchase order.
Table 4-43: Input field values Displayed on web services Qualification Notes A valid AR System qualification

Table 4-44: Output field values Displayed on web services Order_ID PO_Number Status Supplier_Name Notes_to_Supplier Buyer Date_Ordered Freight_Terms Payment_Terms OrderConformationTypeCode Notes
108
Table 4-44: Output field values (Continued) Displayed on web services ShipVia Shipping_Options BillToAddr_City_Name BillToAddr_Country BillToAddr_PostalCode BillToAddr_State/Prov ShipToAddr_Street ShipToAddr_City_Name ShipToAddr_Country ShipToAddr_PostalCode ShipToAddr_State/Prov ShipToAddr_Street Notes
109
110
Chapter
Task Management
You use the TMS:TaskInterface form in the Task Management System to:

Query tasks, relationships, and work information. Update tasks and work information
The TMS:TaskInterface form is a self join of the TMS:Task form that provides the filter (server side) functionality available with TMS:Task. It is used extensively to support web services. Web services is just one of the protocols that leverages this interface form. You can use the TMS:TaskInterface form with other protocols (API, other AR System applications, and so on) to perform specific operations. But by itself, the interface form does not support the Relationships and Work Information actions that are available through the web service operations.
Web service function overview

The TMS_TaskInterface (TMS) web service performs task queries and update operations, including creating relationships and work information. The TMS web service facilitates the exchange of data between the BMC Remedy Change Management and BMC Remedy ITSM Configuration Management applications. The TMS_TaskInterface web service is used to let BMC Remedy ITSM Configuration Management query and update tasks. A back-end task web service interface form acts as a web service interface into the task entry. This form handles both returning values for queries from BMC Remedy ITSM Configuration Management and updating data directly to the task entry. It also handles updating data that is related to the task entry, such as work information or associations. The TMS_TaskInterface web service is a complex web service with many operations. It is based on the TaskInterface.xsd XML Schema, which is also provided if advanced users want to extend and modify the out-of-the-box web service. For more information about web services, see the BMC Remedy Action Request System 7.5.00 Integration Guide.
Chapter 5 Task Management
111
The following is a list of the web service functions available for the Task Management module. These functions are described in the sections that follow.
QueryTaskPlusRelationshipsAndWorkInforeturns most detailed
information. Queries tasks, relationships, and work information

QueryTaskOnlyqueries only tasks QueryTaskPlusWorkInfoqueries tasks and work information QueryTaskPlusRelationshipsqueries tasks and CI relationships UpdateTaskOnlyupdates only tasks UpdateTaskAndWorkInfoupdates tasks and work information
In the query operations and in the UpdateTaskOnly operation, the input parameter is the Task ID. For the UpdateTaskAndWorkInfo operation, the main input parameter is the Task ID. Existing work information records can be updated if their Instance ID is provided. Finally, you can use the UpdateTaskAndWorkInfo operation to create new work information entries for existing tasks if the work information Instance ID is omitted. Even though you do this using the same operation that updates a task in general, creating new work information entries for existing tasks is its own specific function.
Query operations
The following query functions are specific to web services.

QueryTaskPlusRelationshipsAndWorkInfo QueryTaskOnly QueryTaskPlusWorkInfo QueryTaskPlusRelationships
To perform a search outside of web services, do it directly from the TMS:TaskInterface form.
Table 5-1: Input values DB field on interface form TaskID Web service field TaskID Notes Supply Task ID as the input parameter
112
Query operations
The following table lists the output values for the TMS:TASKInterface form.
Table 5-2: Output values DB field on interface form TaskID InstanceId Status StatusReasonSelection RootRequestID RootRequestInstanceID RootRequestName TaskType TaskName Summary Notes Priority RootRequestLevel Assignee Company Assignee Organization Assignee Group Assignee Scheduled Start Date Scheduled End Date Actual Start Date Actual End Date EffortTrackingStartTime EffortTrackingEndTime BudgetEstimatedTotalTime ActualEstimatedTotalTime AutoCostCalculationUnitType Activate Time Assign Time EndTime Location Company Region Site Group Site Company Web service field TaskID TaskInstanceID TaskStatus TaskStatusReason Selection RequestID RequestInstanceID RequestName TaskType TaskName TaskSummary TaskNotes Priority RequestLevel AssignedCompany AssignedOrganization AssignedGroup Assignee ScheduledStartDate ScheduledEndDate ActualStartDate ActualEndDate EffortTrackingStartTime EffortTrackingEndTime BudgetEstimatedTotal Time ActualEstimatedTotal Time AutoCostCalculation UnitType ActivateTime AssignTime EndTime LocationCompany Region SiteGroup Site RequesterCompany Notes
113
Table 5-2: Output values (Continued) DB field on interface form First Name Middle Name Last Name Phone Number Organization Department Support Organization Support Group Name Customer Company Customer First Name Customer Middle Name Customer Last Name Customer Phone Number Customer Organization Customer Department Product Cat Tier 1 Product Cat Tier 2 Product Cat Tier 3 Product Name Product Model/Version Manufacturer Operational Cat Tier 1 Operational Cat Tier 2 Operational Cat Tier 3 attachmentName (z2af_Attachment1 field) attachmentData (z2af_Attachment1 field) attachmentOrigSize (z2af_Attachment1 field) attachmentName (z2af_Attachment2 field) attachmentData (z2af_Attachment2 field) Web service field RequesterFirstName RequesterMiddleName RequesterLastName RequesterPhoneNumber RequesterOrganization RequesterDepartment SupportOrganization SupportGroupName CustomerCompany CustomerFirstName CustomerMiddleName CustomerLastName CustomerPhoneNumber CustomerOrganization CustomerDepartment ProductCategorization Tier1 ProductCategorization Tier2 ProductCategorization Tier3 ProductName ProductModelVersion Manufacturer Operational CategorizationTier1 Operational CategorizationTier2 Operational CategorizationTier3 Attachment1Name Attachment1Data Attachment1OrigSize Attachment2Name Attachment2Data Notes
114
Query operations
Table 5-2: Output values (Continued) DB field on interface form attachmentOrigSize (z2af_Attachment2 field) attachmentName (z2af_Attachment3 field) attachmentData (z2af_Attachment3 field) attachmentOrigSize (z2af_Attachment3 field) Character 01 Character 02 Character 03 Character 04 Character 05 Character 06 Integer 01 Integer 02 Integer 03 Real 01 Real 02 Real 03 Decimal 01 Decimal 02 Date 01 DateTime 01 DateTime 02 Time 01 YesNo 01 YesNo 02 On 01 On 02 AutomaticCommandSelection ElectronicField1 ElectronicField2 ElectronicField3 ElectronicText ElectronicDecimal TimeOutValue Unit ExpectedTimeOut Web service field Attachment2OrigSize Attachment3Name Attachment3Data Attachment3OrigSize Character01 Character02 Character03 Character04 Character05 Character06 Integer01 Integer02 Integer03 Real01 Real02 Real03 Decimal01 Decimal02 Date01 DateTime01 DateTime02 Time01 YesNo01 YesNo02 On01 On02 AutomaticCommand ElectronicField1 ElectronicField2 ElectronicField3 ElectronicText ElectronicDecimal TimeOutValue TimeOutUnit ExpectedTimeOut Notes
115
The following table lists the output values from the TMS:Relationships form.
Table 5-3: Output values DB field on interface form Relationships ID InstanceID Status RelatedItemID RelatedItemSource RelatedItemType Description Attribute1 Attribute2 Attribute3 RelationshipType Web service field RelationshipsID RelationshipsInstanceID RelationshipsStatus RelatedItemID RelatedItemSource RelatedItemType Description Attribute1 Attribute2 Attribute3 RelationshipType Notes
The following table lists the output values from the TMS:WorkInfo form. Table 5-4: Output values DB field on interface form InstanceID Status WorkInfoType Communication Source Summary Notes Secure Log attachmentName (z2af_Attachment1 field) attachmentData (z2af_Attachment1 field) attachmentOrigSize (z2af_Attachment1 field) attachmentName (z2af_Attachment2 field) attachmentData (z2af_Attachment2 field) Web service field WorkInfoInstanceID WorkInfoStatus WorkInfoType WorkInfoCommSource WorkInfoSummary WorkInfoNotes WorkInfoSecureLog WorkInfoAttachment1Name Notes
WorkInfoAttachment1Data
WorkInfoAttachment1OrigSize
WorkInfoAttachment2Name
116
Modify operations
Table 5-4: Output values (Continued) DB field on interface form attachmentOrigSize (z2af_Attachment2 field) attachmentName (z2af_Attachment3 field) attachmentData (z2af_Attachment3 field) attachmentOrigSize (z2af_Attachment3 field) Web service field WorkInfoAttachment2OrigSize Notes
WorkInfoAttachment3Name
Modify operations
The following modify functions are specific to web services.

UpdateTaskOnlyUpdates only tasks. UpdateTaskAndWorkInfoUpdates tasks and work information.
To execute a modify function outside of web services, do it directly from the TMS:TaskInterface form. The following table lists input values for the TMS:TaskInterface form.
Table 5-5: Input values DB field on interface form TaskID Web service field TaskID Notes
For the UpdateTaskOnly operation, supply Task ID as the input parameter. For the UpdateTaskAndWorkInfo operation, supply Task ID as the main input parameter.
Summary Notes Priority RootRequestLevel Scheduled Start Date Scheduled End Date Actual Start Date Actual End Date
TaskSummary TaskNotes Priority RequestLevel ScheduledStartDate ScheduledEndDate ActualStartDate ActualEndDate Chapter 5 Task Management 117
Table 5-5: Input values (Continued) DB field on interface form EffortTrackingEndTime BudgetEstimatedTotal Time ActualEstimatedTotal Time AutoCostCalculation UnitType Location Company Region Site Group Site Web service field Notes
EffortTrackingStartTime EffortTrackingStartTime EffortTrackingEndTime BudgetEstimatedTotal Time ActualEstimatedTotal Time AutoCostCalculationUnit Type LocationCompany Region SiteGroup Site
attachmentName Attachment1Name (z2af_Attachment1 field) attachmentData Attachment1Data (z2af_Attachment1 field) attachmentOrigSize Attachment1OrigSize (z2af_Attachment1 field) attachmentName Attachment2Name (z2af_Attachment2 field) attachmentData Attachment2Data (z2af_Attachment2 field) attachmentOrigSize Attachment2OrigSize (z2af_Attachment2 field) attachmentName Attachment3Name (z2af_Attachment3 field) attachmentData Attachment3Data (z2af_Attachment3 field) attachmentOrigSize Attachment3OrigSize (z2af_Attachment3 field) ElectronicField1 ElectronicField2 ElectronicField3 ElectronicText ElectronicDecimal TimeOutValue Unit ExpectedTimeOut ElectronicField1 ElectronicField2 ElectronicField3 ElectronicText ElectronicDecimal TimeOutValue TimeOutUnit ExpectedTimeOut
118
Modify operations
This table lists input values from the TMS:WorkInfo form. Table 5-6: Input values DB field on interface Web service field form InstanceId WorkInfoInstanceId Notes For the UpdateTaskAndWork Info operation:
Existing work information records can be updated if their Instance ID is provided. New work information records can be created if the Work Info Instance ID is omitted.
InstanceID WorkInfoType Summary Secure Log WorkInfoDate Communication Source Notes Secure Log attachmentName (z2af_Attachment1 field) attachmentData (z2af_Attachment1 field) attachmentOrigSize (z2af_Attachment1 field) attachmentName (z2af_Attachment2 field) attachmentData (z2af_Attachment2 field) attachmentOrigSize (z2af_Attachment2 field) attachmentName (z2af_Attachment3 field)
WorkInfoInstanceID WorkInfoType WorkInfoSummary WorkInfoSecureLog WorkInfoDate WorkInfoCommSource WorkInfoNotes WorkInfoSecureLog WorkInfoAttachment1 Name WorkInfoAttachment1Data
WorkInfoAttachment2 Name WorkInfoAttachment2Data
WorkInfoAttachment2 OrigSize WorkInfoAttachment3 Name
119
Table 5-6: Input values (Continued) DB field on interface Web service field form attachmentData (z2af_Attachment3 field) attachmentOrigSize (z2af_Attachment3 field) WorkInfoAttachment3 Data WorkInfoAttachment3 OrigSize Notes
Integrating applications with tasks

You can use two main integration points with tasks:
1 The primary integration point for the Task Management System is using the
TMS:TaskInterface form. Web Services have been established to support queries, updates and limited create operations.
2 Launching outbound communication with tasks is supported using the following
mechanisms:
For more comprehensive solutions, you can leverage Command Automation Interface (CAI) to trigger outbound communication. CAI lets you provide task parameters that integrate with your applications with the following protocols:

Web services URLs AR protocol (used for ITSM applications) Command line Plug-in
You can create new automatic tasks that are self-contained structures. For example, you can create workflow with a task and then fork a process to run a command that interacts with another application or program. Runtime tasks instantiated from automatic task templates are intended to run automatically without human intervention. You can assign a task assignee to monitor them but this is not required. Seven automatic tasks are already created for you to use. If you need a different automatic task, you must define a new automatic command. All automatic commands have specific workflow on the TMS:Task form that trigger the needed function. All the specific automatic task filter workflow exists within an execution order of 300 and 399 (305 is the minimum and 397 is the maximum range for adding filters for new automatic tasks). In addition, outbound automatic tasks can use a web service filter.
120
Integrating applications with tasks
Do not confuse an automatic task with a manual task. You should define all the content you need to create an automatic task on the Automatic tab of the Task Template form. But do not create an automatic task with any details that imply a human should intervene anywhere in the process. Automatic tasks, when activated, attempt to perform whatever work they are defined to do. When automatic tasks run, they have only two possible states:

Completetheir status is Closed with a relevant status reason Waitinguntil they reach the Complete state
You should never define a Launch command with an automatic task. Using the Launch command always implies human intervention. For more information about defining automatic commands, see the Task Management System 7.6 Administrators Guide.
TIP
Which method is betterusing CAI or creating new tasks from scratch? It depends whether you primarily need ease-of-use or flexibility. The CAI option only requires data entries for outbound communication with tasks. With new automatic tasks, you have maximum flexibility but at the cost of some complexity. You still must create your own workflow for them to operate properly.
121
122
*172029* *172029* *172029* *172029*

*172029*

ITSM Integrations

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

ITSM Integrations

Caricato da

Copyright:

Formati disponibili

White Paper

BMC Remedy IT Service Management 7.6.03 Integrations

Contacting BMC Software

United States and Canada

Outside United States and Canada

Restricted rights legend

Support by telephone or email

Before contacting BMC Software

License key and password information

BMC Remedy IT Service Management 7.6.03 Integrations

BMC Remedy Asset Management 7.6.03

BMC Remedy IT Service Management 7.6.03 Integrations

The information contained in this paper includes:

Using web services

BMC Remedy IT Service Management 7.6.03 Integrations

Associating entries with configuration items

Using BMC Remedy APIs

Associating entries with configuration items

AST:CMDB Associations HPD:Associations CHG:Association

BMC Remedy IT Service Management 7.6.03 Integrations

Work information creation

Creating a service request entry

BMC Remedy IT Service Management 7.6.03 Integrations

Web service function mapping

Web service function mapping

BMC Remedy IT Service Management 7.6.03 Integrations

Web service name TMS_TaskInterface

BMC Remedy IT Service Management 7.6.03 Integrations

BMC Remedy IT Service Management 7.6.03 Integrations

BMC Remedy IT Service Management 7.6.03 Integrations

Create or modify an incident. Query an incident or a list of incidents.

HelpDesk_Submit_Servicecreates and submits incident tickets with work

information and CI associations

HelpDesk_Modify_Servicemodifies incident tickets with work information HelpDesk_Query_Service/ HelpDesk_QueryList_Serviceallows

Chapter 1 Incident Management

BMC Remedy IT Service Management 7.6.03 Integrations

Status Impact Urgency Description Reported Source

The following table lists optional input field values.

Assigned Support Organization Assigned Group

Assigned Group Shift Name

BMC Remedy IT Service Management 7.6.03 Integrations

Product Categorization Tier 1 Product_Categorization_ Tier_1

Categorization Tier 2 Categorization Tier 3 Closure Product Category Tier1

Resolution_Category_Tier_2 Resolution_Category_Tier_3 N/A Direct_Contact_First_Name Direct_Contact_Last_Name Chapter 1 Incident Management 17

BMC Remedy IT Service Management 7.6.03 Integrations

z1D_Details z1D_ActivityDate_tab z1D_CommunicationSource Flag_Create_Request

Work_Info_Notes Work_Info_Date Work_Info_Source Create_Request

BMC Remedy IT Service Management 7.6.03 Integrations

HPD_CI_ReconID Middle Initial

The following table lists the fields set through workflow.

Chapter 1 Incident Management

BMC Remedy IT Service Management 7.6.03 Integrations

BMC Remedy IT Service Management 7.6.03 Integrations

Chapter 1 Incident Management

BMC Remedy IT Service Management 7.6.03 Integrations

Table 1-4: Input fields DB field on interface form z1D Action

Status Service_Type Reported_Source Product_ Categorization_Tier_1 Product_ Categorization_Tier_2 Product_ Categorization_Tier_3

BMC Remedy IT Service Management 7.6.03 Integrations

Chapter 1 Incident Management

BMC Remedy IT Service Management 7.6.03 Integrations

HPD_CI HPD_CI_ReconID HPD_CI_FormName z1D_CI_FormName

HPD_CI HPD_CI_ReconID HPD_CI_FormName z1D_CI_FormName

BMC Remedy IT Service Management 7.6.03 Integrations

HelpDesk_Query_Service and HelpDesk_QueryList_Service Functions