Permalink
Browse files

update livesite from preview (#1718)

* Add Best Practices Section (#1709)

* Edits

* Update trip-resource.markdown

* Update trip-resource.markdown

* Update trip-resource.markdown

* Add Best Practices Section

* Updates from Sarra's review

* Update itinerary.markdown

Added Best Practices, TOC

* Fixed Request product name

* Image for new Testing App Center Partner Apps page

* Fixed Concur Request product name

* Delete IsATestUser.png

* Add files via upload

* Create preproduction-testing

* Added preproduction-testing

* Rename preproduction-testing to preproduction-testing.md

* For preproduction-testing page

* Updated image link.

* Delete IsATestUser.png

* Eliminated extra space

* Update preproduction-testing.md

Updated Test Guide title, added clarifying info about test user accounts.

* Updated Travel Section

Updated titles and rearranged list at request of travel team.

* Update preproduction-testing.md

Updated image reference

* Delete IsATestUser.png

* Add files via upload

* Update itinerary.markdown

Added missing #

* Update itinerary.markdown (#1711)

Fixed headings

* Update api-guides.yml (#1712)

Fixed incorrect link.

* Fixed Tip formatting (#1713)

@howarddierking The numbered list is supposed to be 1-6, but it renumbered when it was pushed. I've tried to fix it, but am not sure if I did. All the various previews I looked at, including Atom show it rendering properly. Can you advise if it doesn't work?

* Update preproduction-testing.md (#1715)

Fixed Jekyll front matter.

* Update itinerary.markdown (#1716)

Updated Jekyll front matter

* Update to Testing guide (#1717)

* Updates based on training feedback

* updated list

* revert
  • Loading branch information...
howarddierking committed Dec 3, 2018
1 parent dd3b9a9 commit 6d75270781dab2ed8db9b5c1009d2cf37ec9816c
@@ -14,6 +14,8 @@
children:
- title: Payment Provider Integration - paying customers' invoices
url: /api-guides/invoice/payment-provider-integration.html
- title: Testing App Center Partner Applications Before Production
url: /api-guides/preproduction-testing.html
- title: Travel
url: ''
children:
@@ -224,16 +224,17 @@
- title: Travel
url: ''
children:
- title: Itinerary Web Service (TMC/Third-Party)
url: /api-reference/travel/itinerary-tmc-thirdparty/
- title: Booking
url: /api-reference/travel/itinerary/booking/booking-resource.html
- title: Itinerary Service
url: /api-reference/travel/itinerary/itinerary.html
- title: Trips
url: /api-reference/travel/itinerary/trip/trip-resource.html
- title: Travel Services
url: /api-reference/travel/travel.html
- title: Itinerary API – Overview & Getting Started
url: /api-reference/travel/itinerary/itinerary.html
- title: Itinerary API Usage
url: /api-reference/travel/itinerary-tmc-thirdparty/
- title: Trip Endpoint
url: /api-reference/travel/itinerary/trip/trip-resource.html
- title: Booking Endpoint
url: /api-reference/travel/itinerary/booking/booking-resource.html
- title: User
url: /api-reference/user/
- title: Deprecated
Binary file not shown.
@@ -0,0 +1,38 @@
---
title: Testing App Center Partner Applications Before Production
layout: reference
---
Many App Center partner applications do not need to be validated in a test environment because they are obtaining data directly from the customer's site and processing it on the partner's side. In other words, the presence of the partner's application has no impact on the normal use of the SAP Concur site as a result of obtaining data. However, some Enterprise Applications send data to the customer's SAP Concur site, which the customer may want to test before deploying.
## Test User Functionality
In most cases, customers can test App Center partner applications using the Test User functionality. This feature is available within their Professional Edition SAP Concur site and is the recommended option.
>**Important**: The Test User functionality only applies to Professional Edition customers. Standard Edition customers need to deploy the app in their production site.
This functionality completely separates the data between test and production, while allowing the customer to be confident their testing is being done within a production infrastructure (that is, the performance of the app is being tested in the normal environment where it will be used). In addition, the Test User functionality uses the same production configuration settings, which avoids issues related to inconsistent settings manually configured in a separate site. The test user data does not impact production analytics or extracts. Your SAP Concur contact can provide you with a copy of the *Shared: Test User Setup Guide*, which explains this feature in detail. If you’ve already used the Test User functionality only a subset of the steps below may be required.
At the customer’s request SAP Concur will configure the following:
* Copy the Expense, Invoice, or Request Policy that is to be used in conjunction with the App Center partner integration. The name of the new Policy must include "Test User" in the Policy name along with any other descriptive terms the customer provides.
* Create a Test User Group and apply it to the Test Policy.
* Add necessary Test User records and assign them to the Test Group. (*client-configured*)
![Expense and Invoice settings showing the Test User text box is checked.](./isatestuser.png)
> **Important**: The checkbox field, "Is a Test User" in the employee profile must be checked for each test profile used in the testing before clicking **Save**. Once selected, that checkbox is permanent and there is no way to change the profile. When a user profile is set up as a test user, that profile will always be in test mode. The converse is also true – a production profile will never have this checkbox checked. This ensures that test and production data is kept separate.
> **Tip**: Include "Test" in the login ID to emphasize the correct use of each profile. For example, Jane.Doe.Test@<company domain>.com.
* Adjust any other configuration within the Test User Policy and the Test User Group that is relevant to the app deployment. For example, Attendee Types can be set up for Test User Group access only.
* If desired, request a test user extract file be created.
* Deploy the App Center partner application, limited to the test users and complete the desired tests. The user profiles marked as "Is a Test User" must be used. (*client or SAP Concur*)
## Pre-Production Alternative
If the partner's application cannot be tested using the Test User functionality and the customer is still in **implementation**, then the customer can deploy the application in their site during implementation, which is a production site in a test state. The test state remains until the site is moved to production. Any configuration related to the app will not need to be redone once the customer moves their site to production. However, the customer will need to reauthenticate.
> **Important**: Testing App Center Partner apps are not able to be tested in Test Entity sites. The test entities are also not in a production environment so the infrastructure is not conducive to a complete test of web traffic (API transactions).
@@ -3,22 +3,31 @@ title: Itinerary Service
layout: reference
---
## Overview
* [Overview](#itinerary-overview)
* [Version](#itinver)
* [Resources](#itinres)
* [Concepts](#itin-concepts)
* [Who Can Use This Web Service?](#itin-use)
* [Configuration](#itin-config)
* [FAQs](#itin-faq)
* [Best Practices](#itin-best-practices)
* [Reference](#reference-topics)
The Itinerary API can be used to programmatically access travel data such as trips and bookings in Concur Travel. Concur Travel uses this data to match and consolidate bookings it receives from disparate sources and put these into consolidated travelers’ itineraries, providing travelers a convenient way to view their trips in a single itinerary view. Travelers can view their itineraries through mobile applications or other services.
## <a name="itinerary-overview"></a>Overview
The Itinerary API can be used to programmatically access travel data such as trips and bookings in Concur Travel. Concur Travel uses this data to match and consolidate bookings it receives from disparate sources and put these into consolidated travelers’ itineraries, providing travelers a convenient way to view their trips in a single itinerary view. Travelers can view their itineraries through mobile applications or other services.
## Version
## <a name="itinver"></a>Version
Version 1.0
## Resources
## <a name="itinres"></a>Resources
[Trip](/api-reference/travel/itinerary/trip/trip-resource.html)
[Booking](/api-reference/travel/itinerary/booking/booking-resource.html)
## Concepts
## <a name="itin-concepts"></a>Concepts
### Itineraries and Trips
@@ -30,19 +39,19 @@ The terms itinerary and trip are synonyms. Trip is the name used for the SAP Con
* A _booking record_ is the container for all segments booked from a source with the same unique identifier (_record locator_ or _confirmation number_). A single booking can have multiple segments.
* A _segment_ includes details about the travel booking.
## Who Can Use this Web Service?
## <a name="itin-use"></a>Who Can Use This Web Service?
TripLink suppliers, travel management companies (TMCs), and SAP Concur partners can use the Itinerary API. The level of access to the data in the Concur Travel system depends on who is accessing it and the SAP Concur products that have been purchased.
### Travel Management Companies (TMCs)
### Travel Management Companies
* Can view and post bookings for any travel type.
* Send new reservations that users create on the supplier's site to SAP Concur.
* Send a notice of trip cancellations to SAP Concur.
* Get a list of current trips for a user from SAP Concur.
* Get the full details of user trips from SAP Concur.
* Can view the full set of fields for their customers' itineraries because TMCs have an existing relationship with their customers.
* Can send proposed itineraries when the Agency Proposal feature of Travel Request is active.
* Can send proposed itineraries when the Agency Proposal feature of Concur Request is active.
* Can cancel bookings on behalf of a user.
### TripLink Travel Suppliers
@@ -77,13 +86,13 @@ TMCs can request or send travel bookings in two ways:
The travel supplier can request or send travel bookings by using an OAuth token for the user the travel booking belongs to, generated with the user's involvement.
## Configuration
## <a name="itin-config"></a>Configuration
* If you are a TMC, third-party developer, or a TripLink supplier who would like to start using this web service, please visit: [http://www.concur.com/en-us/connect-platform/suppliers][3] or contact the SAP Partner Enablement Team.
* SAP Concur products are highly configurable, and not all SAP Concur clients will have access to all features.
* Partner developers must determine which configurations are required for their solution prior to the review process.
## FAQs
## <a name="itin-faq"></a>FAQs
#### When Do I Send Trips Versus Bookings?
@@ -103,11 +112,11 @@ The Itinerary API returns the full booking details to the supplier who will prov
#### How Can We Save Additional Charges for Hotel and Car Segments? What Types of Charges Are Supported?
The Charges element under Car and Hotel segments allow you to save additional charges using Semantics Codes. Refer to the Semantics and Vendor Codes document for more information.
The `Charges` element under Car and Hotel segments allow you to save additional charges using Semantics Codes. Refer to the Semantics and Vendor Codes sections under [Reference](#reference-topics) for more information.
#### What Vendor Codes Can I Use When Sending Hotel and Car Segments?
Refer to the Semantics and Vendor Codes document for the full list.
Refer to the Semantics and Vendor Codes sections for the full list.
#### Can I View a Trip Posted Through the Itinerary API in the SAP Concur UI?
@@ -117,7 +126,7 @@ Yes. The user who owns the trip will see the trip on their home page. If the tri
Trips can be expensed after the trip is over under the following conditions:
* The trip has a Car, Hotel or Ride segment.
* The trip has a Car, Hotel, or Ride segment.
* The trip has an Air segment with a ticket and the ticket has at least one valid ticket coupon, meaning the coupon is in one of the following statuses:
* OPEN
* USED
@@ -128,8 +137,7 @@ Air segments can be expensed as soon as they have a ticket with a valid coupon,
#### Why is My New Booking Not Showing in the UI?
The request returned successfully with HTTP status - 200 OK.
Posted bookings are automatically merged with any existing trip with overlapping dates. Most likely, a trip exists with the same dates and the booking has been added to it.
The request returned successfully with HTTP status - 200 OK. Posted bookings are automatically merged with any existing trip with overlapping dates. Most likely, a trip exists with the same dates and the booking has been added to it.
#### Will Posted Bookings Be Overwritten by Emailed or TripIt Trips?
@@ -143,6 +151,15 @@ Yes.
No.
## <a name="itin-best-practices"></a>Best Practices
* When extracting past data:
* Extract a month of trip summaries to gauge volume. If hundreds are returned, then adjust extraction to weekly.
* Do not extract more than a year of data at any given time regardless of the volume. For longer look backs, extract 6 month segments maximum at a time.
* Do not multi-thread requests to retrieve multiple pages of data. Concurrent requests will impact your application’s performance.
* Itineraries change frequently. Changes do not necessarily indicate that the traveler modified their trip. If your application works with upcoming or in progress trips, be aware that you must evaluate the individual segments to determine whether it is a material change for your application.
* This API will only return itineraries that have been sent to Concur Travel; this includes travel booked within Concur Travel, TripIt, on TripLink supplier sites, and most bookings from your travel agency. Some customers may have multiple booking options which may mean not all employee trips are available via this API. A good rule of thumb: if the traveler sees the itinerary in their “trips” list, then you can retrieve it from this API.
## <a name="reference-topics" id="reference-topics">Reference</a>
The Itinerary Reference documentation includes the following reference information that can be used in conjunction with the Trip Resource API and Booking Resource API documentation. It includes the following reference topics:
@@ -155,9 +172,9 @@ The Itinerary Reference documentation includes the following reference informati
* [Time Zone Formats](#time-zones)
### <a name="itinerary-data-model" id="itinerary-data-model">Itinerary Data Model</a>
[Return to Reference topics](#reference-topics)
The Itinerary data model defines data elements that are returned or sent when getting, creating, updating, or deleting trips and bookings with the /api/travel/trip/v1.1 and /api/travel/booking/v1.1 resources respectively.
Trips include all bookings in an itinerary whereas a booking includes only a specific segment of an itinerary. It includes the following elements:
* [Root Elements](#root-elements)
Oops, something went wrong.

0 comments on commit 6d75270

Please sign in to comment.