central - winshuttle-help.s3.amazonaws.comwinshuttle-help.s3.amazonaws.com/...guide_10.2.pdf ·...
TRANSCRIPT
CENTRAL
Version 10.2
Deployment Guide
Copyright© 2011 Winshuttle, LLC
Legal
The Winshuttle CENTRAL Deployment Guide is for informational purposes only. WINSHUTTLE
MAKES NO WARRANTIES, EXPRESS, IMPLIED OR STATUTORY, AS TO THE INFORMATION IN
THIS DOCUMENT.
The software contains proprietary information of Winshuttle, LLC.; it is provided under a license
agreement containing restrictions on use and disclosure and is also protected by copyright law.
Reverse engineering of the software is prohibited.
Due to continued product development, this information may change without notice. The information
and intellectual property contained herein is confidential between Winshuttle, LLC. and the client and
remains the exclusive property of Winshuttle, LLC. Except as expressly provided in any written license
agreement from Winshuttle, the furnishing of this document does not give you any license to patents,
trademarks, copyrights, or other intellectual property rights covering subject matter contained in this
document.
No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form
or by any means, electronic, mechanical, photocopying, recording or otherwise without the prior written
permission of Winshuttle, LLC.
If you find any problems in the documentation, please report them to us in writing. Winshuttle, LLC.
does not warrant that this document is error-free.
© 2008-2011 Winshuttle, LLC. All rights reserved.
QUERY, TRANSACTION, SERVER, CENTRAL, and Adaptive Query Throttling are trademarks of
Winshuttle, LLC in the United States and/or other countries.
Some portions of the software may include intellectual property owned and licensed by third parties.
Winshuttle, LLC makes no warranties with respect to such third party property, and makes no claim of
ownership thereto.
The names of actual companies and products mentioned herein are trademarks and/or registered
trademarks of their respective owners.
Contact Information
For more information, please contact: 1-800-711-9798, or visit our Web site at www.winshuttle.com
Contents
1. Winshuttle CENTRAL Deployment Guide ..................................................................................... 1
1.1. Audience ........................................................................................................................................... 1
1.2. Introduction ........................................................................................................................................ 1
1.3. Features ............................................................................................................................................ 1
1.4. New features of CENTRAL 10.2 ....................................................................................................... 2
1.5. Preparing for deployment .................................................................................................................. 2
1.6. Licensing ........................................................................................................................................... 3
1.7. Test environment considerations ...................................................................................................... 3
2. System Requirements ..................................................................................................................... 4
2.1. Prerequisites – 32 bit ........................................................................................................................ 4
2.2. Prerequisites – 64 bit ........................................................................................................................ 5
3. CENTRAL Install Options................................................................................................................ 6
3.1. Configuring SharePoint for CENTRAL .............................................................................................. 6
4. Installing CENTRAL ....................................................................................................................... 14
5. Setting Up the CENTRAL Site ...................................................................................................... 20
6. Configuring CENTRAL .................................................................................................................. 26
6.1. Policies ............................................................................................................................................ 27
6.2. Preferences ..................................................................................................................................... 29
6.3. Workflow .......................................................................................................................................... 32
6.4. Configuring CENTRAL for QUERY ................................................................................................. 34
7. LDAP Connection for Active Directory ........................................................................................ 39
8. Upgrading CENTRAL ..................................................................................................................... 40
8.1. Upgrade from CENTRAL version 10.0 to version 10.1 ................................................................... 40
8.2. Upgrading CENTRAL to 10.2 .......................................................................................................... 45
9. Uninstalling CENTRAL .................................................................................................................. 49
9.1. Preparing for uninstall ..................................................................................................................... 49
9.2. Removing CENTRAL ...................................................................................................................... 49
10. Support Information ...................................................................................................................... 55
Winshuttle CENTRAL - Deployment Guide
1
1. Winshuttle CENTRAL Deployment Guide
The descriptions in this guide assume the reader has intermediate to advanced administrative skills and
is familiar with the terminology in Microsoft® SharePoint
® Server 2007, SharePoint
® Server 2010,
Microsoft SQL Server ®
2005, and Windows Server® 2003.
1.1. Audience
This guide is intended for system administrators and architects who need to understand the deployment
steps required for Winshuttle CENTRAL 10.2. In addition, the benchmark examples and analyses should
help users to understand the impact of CENTRAL on system and application performance.
NOTE: Unless otherwise specified, throughout this document Winshuttle CENTRALTM
or Winshuttle CENTRAL
Administration are referred to as the CENTRAL or CENTRAL Administration. In some instances the
document refers to a separate product called Microsoft® SharePoint Central Administration.
1.2. Introduction
Winshuttle CENTRAL provides centralized visibility and governance for enterprise deployments of
Winshuttle solutions. This not only enables companies to share files and best practices across the
organization, but also addresses the organization's requirements for specific controls and audit trails to
meet SOX and corporate governance policies. CENTRAL delivers the controls, security, and traceability
that enable enterprises to deploy Winshuttle’s data solutions, such as TRANSACTION, QUERY, and
RUNNER, across the organization. CENTRAL provides this functionality using the Microsoft SharePoint
framework, providing native integration to Microsoft technologies including Microsoft Active Directory, and
Microsoft Excel.
NOTE: Because of the integrated systems involved in CENTRAL deployment, Winshuttle suggests testing in a
development or sandbox environment prior to production deployment.
1.3. Features
Winshuttle CENTRAL is a unified management interface within SharePoint for TRANSACTION, RUNNER
and QUERY files. Below are key benefits of Winshuttle CENTRAL:
Centralized administration of Winshuttle users and licenses
File sharing and collaboration
Activity dashboard and centralized reporting
Version control and workflow management
Native Microsoft Office and SharePoint integration
With Winshuttle SERVER, you are enabled to "Auto post" with reviewer/creator credentials or
with system account login.
Use Winshuttle SERVER to post immediately or at specific time in future.
Winshuttle CENTRAL - Deployment Guide
2
Allows IT ease of control for Winshuttle user access to the SAP environment
Full traceability and ROI analysis through comprehensive logging of records uploaded and total
time saved by the user
1.4. New features of CENTRAL 10.2
CENTRAL 10.2 version has several enhancements. The following new features have been introduced in
this version:
You can select a custom master page to apply corporate branding specific to your company.
System administrators can use server policies to restrict QUERY access to the SAP tables.
In server policies, the search for SAP tables supports wild card notation as a search term. For
example, a search for KO* returns all the terms starting with KO.
NOTE: For more information on the following new features, see the Winshuttle CENTRAL Online
Help.
CENTRAL 10.2 provides enhanced backup and restore capabilities to schedule regular backups,
restore backups on new servers and migrate specific CENTRAL content from one environment to
another.
CENTRAL 10.2 is now available in the following languages: German (DE), French (FR), Spanish
(ES) and Dutch (NL).
NOTE: CENTRAL installation occurs in English. You can change the language settings while running
the program.
You can customize workflow email notifications.
Enhanced management of licenses enables you to view licenses by activation and delete specific
activations.
1.5. Preparing for deployment
Winshuttle CENTRAL installation is non-disruptive to SQL and the SharePoint content database
instances. You should ensure that no connection to your target Site Collections is active during the
installation. An IIS reset occurs during deployment.
Below are key considerations for the Winshuttle CENTRAL deployment:
Winshuttle CENTRAL installs into the GAC. For SharePoint 2010 Winshuttle CENTRAL
installs custom layouts in the following location:
%systemroot%\Program Files\Common Files\Microsoft Shared\web server
extensions\14\TEMPLATE\LAYOUTS\Winshuttle.Winshuttle CENTRAL
Winshuttle loads Content Types in the Site Content Type Gallery as Sealed. You cannot
change sealed content types through the Windows SharePoint Services user interface, and
you must be a site collection administrator to unseal the content type using the object model.
Winshuttle CENTRAL - Deployment Guide
3
CENTRAL installs a custom SQL database named eShuttleDB. The minimum role
memberships for eShuttleDB are ‘db_owner’ and ‘public’ using the BUILTIN\Users user
login. All CENTRAL configuration and transactional data is stored in eShuttleDB, in addition
to licensing information.
All CENTRAL features are scoped at the site level.
All CENTRAL database connection strings are done on the farm level.
CENTRAL workflows are designed in Microsoft Visual Studio®.
No MIME creation takes place on IIS.
1.6. Licensing
A Winshuttle CENTRAL activation code is needed to use the CENTRAL portal site. Although not required
to install other programs, CENTRAL is useful in combination with other Winshuttle programs. Thus,
proper licensing is highly recommended. Contact your Winshuttle sales representative for details.
1.7. Test environment considerations
Although a it is not required to test CENTRAL in a non-production environment before you deploy, we
highly recommend this. Your production needs may depend on number of users, number of groups, farm
size and so on. Consider these parameters to deploy a similar development environment for testing
CENTRAL.
Winshuttle CENTRAL - Deployment Guide
4
2. System Requirements
2.1. Prerequisites – 32 bit
The list below outlines the minimum requirements for a SharePoint environment. Please follow best
practices recommended by Microsoft for deploying SharePoint.
Component Requirement
Processor Intel® Pentium Dual Core (Quad Core is recommended )
Operating System Microsoft® Windows Server 2003 R2 Standard Edition Service
Pack 1 (32-bit)
Hard Disk 3 MB minimum of hard disk space required for the Central
database
5 MB of additional hard disk space for log file growth*
* An appropriate amount of log space should be allotted to
accommodate your environment.
Memory RAM:
Minimum – 2 GB RAM
Maximum: Operating System maximum
Winshuttle CENTRAL is a single site within SharePoint. It
requires same amount of memory as any Internet browser.
Database SQL Server 2005
SQL Express
Other Software Microsoft® .NET Framework 3.5 SP1
IIS 6.0, Web Service Extensions must have ASP.NET v2.0.50727
allowed.
WSS 3.0 SP1 or MOSS 2007
Table 2.1: 32 bit system requirements
Winshuttle CENTRAL - Deployment Guide
5
2.2. Prerequisites – 64 bit
Component Requirement
Processor Intel® Pentium Dual Core ( Quad Core is recommended )
Operating System Microsoft® Windows Server 2008 R2 Standard Edition (64 bit)
Hard Disk 3 MB minimum of hard disk space required for the CENTRAL
database
5 MB of additional hard disk space for log file growth*
* An appropriate amount of log space should be allotted to
accommodate your environment.
Memory RAM:
Minimum – 8 GB RAM
Maximum: Operating System maximum
Winshuttle CENTRAL is a single site within SharePoint. It
requires same amount of memory as any Internet browser.
Database SQL Server 2005 – 64 bit
SQL Server 2008 – 64 bit
SQL Express – 64 bit
Other Software Microsoft .NET Framework 3.5 SP1
IIS 7.5
SharePoint 2010 Foundation
SharePoint 2010 Enterprise
Table 2.2: 64 bit system requirements
Winshuttle CENTRAL - Deployment Guide
6
3. CENTRAL Install Options
To install Winshuttle CENTRAL, you can select Microsoft SharePoint site definitions or activate features
of an existing SharePoint site.
3.1. Configuring SharePoint for CENTRAL
Before you start the install, consider the following recommendations:
1. Review and understand the associated full system restore (disaster recovery) procedure for your
SharePoint environment, including any separate SQL servers.
2. You should be able to log on to the SharePoint server as a local Administrator or as a member of
the Administrators group.
3. Close all applications and disable any programs that run automatically, including anti-virus, screen
savers and operating system utilities.
4. Some programs may be running as service in the background. Stop and disable such services
before you begin. You can re-enable them after the installation.
5. Ensure there are no active connections to the target site you plan to deploy to.
NOTE: TrendMicro Antivirus: CENTRAL is blocked when security settings in TrendMicro Antivirus are set to
Medium or High. To ensure that CENTRAL is not blocked, set the security setting to Low.
3.1.1. Creating a web-application
If you have a Web-Application set up already, go directly to Section 3.1.2. of this document.
1. Click Start. Go to Control Panel and select Administrative Tools.
2. Click SharePoint Central Administration. Login as Administrator, refer to Figure 3.1.
Winshuttle CENTRAL - Deployment Guide
7
Figure 3.1: Administrator login
3. On the top left corner of the page, click Application Management.
4. Click Create or Extend Web Application.
Figure 3.2: Application Management screen
5. Click Create a New Web Application.
Winshuttle CENTRAL - Deployment Guide
8
Figure 3.3: Create or Extend Web Application
6. Enter a designated port for the Web App to communicate with.
Winshuttle CENTRAL - Deployment Guide
9
Figure 3.4: Designate Port
7. Enter the credentials of the user you want to use as the service account. Choose Restart IIS
Automatically, or manually, as required.
8. Click OK at the bottom of the page.
9. The web application is created. This could take a few minutes.
Winshuttle CENTRAL - Deployment Guide
10
Figure 3.5: Operation in Progress screen
The web application is ready for use.
Figure 3.6: Application Created
Winshuttle CENTRAL - Deployment Guide
11
3.1.2. Creating Site Collection
1. If you have just created a web app, the link appears after the Web App has been created
successfully.
Or
2. If you already have a web app, at the top left corner of the SharePoint Central Administration
page, click Application Management, and then click Create Site Collection.
Figure 3.7: Create Site Collection link
3. At the top, choose the web app on which you want to create a site collection. Enter the Site Title,
and Site Description.
Figure 3.8: Site Title and Description
4. Choose the Template for Site Collection.
Winshuttle CENTRAL - Deployment Guide
12
5. Click the Winshuttle tab, and then choose Winshuttle CENTRAL Team Site.
6. Enter the Primary or Secondary Site Collection Administrator. Click OK at the bottom of the
page.
Figure 3.9: Site Collection Administrator
7. Wait while the site collection is being created.
Figure 3.10: Operation in Progress
8. The site collection is ready for use.
Winshuttle CENTRAL - Deployment Guide
13
Figure 3.11: Site Collection Created Successfully
Winshuttle CENTRAL - Deployment Guide
14
4. Installing CENTRAL
1. Double-click Setup.exe.
2. The Winshuttle CENTRAL Solution wizard appears.
Figure 4.1: Winshuttle CENTRAL setup wizard
3. The prerequisites for CENTRAL installation are checked. If all the pre-requisites are satisfied, the
Next button is enabled.
Figure 4.2: System Check
Winshuttle CENTRAL - Deployment Guide
15
4. On the End-user License Agreement page, if you accept the terms of the license agreement,
click I accept the terms in the License Agreement.
NOTE: Sometimes Windows SharePoint Services Administration may not start. Start the service via
Administrative Tools on the hosting server.
Figure 4.3: End User License Agreement
5. On the Winshuttle CENTRAL Site definition page, choose one of the following the installation
types:
Site Definition - While creating the SharePoint Site, administrator can see the Winshuttle tab in
Site Templates list. By selecting the template, the SharePoint Administrator or the Site Collection
Administrator can create the CENTRAL Site.
Non Site Definition - After installation, the administrator needs to create the Team site. This
feature will convert the existing team site to CENTRAL Site. No Custom Site template will be
installed.
Winshuttle CENTRAL - Deployment Guide
16
Figure 4.4: CENTRAL Site definition
6. The Site Collection Deployment Targets screen appears. Choose the web-applications of the
SharePoint on which you want to install CENTRAL.
Figure 4.5: Site Collection Deployment Targets
7. After the installation is complete, click Next.
Winshuttle CENTRAL - Deployment Guide
17
Figure 4.6: Install progress
8. After the CENTRAL solution is installed, you must install Winshuttle.eshuttle.database. The
installation of the database starts automatically.
NOTE: If the database installer does not start, go to the root of the CENTRAL setup folder, and open the folder
eShuttleDBSetup, and click Setup.exe to start the setup manually.
9. Click Next.
Figure 4.7: eShuttle.Database installation
10. Choose the database server to install the database.
Winshuttle CENTRAL - Deployment Guide
18
11. Click Browse to view all the available servers. Enter a database name, and the authentication
type. Click Next.
Figure 4.8: Database parameters
12. Click Install to start the installation.
Figure 4.9: Ready to install the program
13. Wait while the database is installed.
Winshuttle CENTRAL - Deployment Guide
19
Figure 4.10: Database install progress
14. Click Finish, to complete the installation.
Figure 4.11: Installation complete
Winshuttle CENTRAL - Deployment Guide
20
5. Setting Up the CENTRAL Site
Activate the Winshuttle CENTRAL feature
1. Open the Home page of your target Site Collection site.
2. Click Site Actions > Site Settings > Site collection features
3. In the list of Features check if the Winshuttle CENTRAL is active. If it is not active, activate the
WINSHUTTLE CENTRAL feature.
Create CENTRAL Site
1. From the Home site, click Site Actions>Create>Sites and Workspaces.
2. Create the CENTRAL site with the appropriate settings using the WINSHUTTLE CENTRAL Team
Site template.
Figure 5.1: Team Site template
3. Verify the CENTRAL site looks like the Figure 5.2.
Winshuttle CENTRAL - Deployment Guide
21
Figure 5.2: CENTRAL Administration
4. Group Assignment (formerly known as Role Assignment). Each user must be assigned access in
the SharePoint People and Groups before being assigned a license in Winshuttle CENTRAL.
NOTE: Users can be added from domains, but not from groups because the individual user names cannot be
resolved. Only one level of groups is supported, as Winshuttle CENTRAL does not support a domain
group within a domain group or a domain group within a computer management group. However,
Winshuttle CENTRAL can recognize a domain or computer management group that has been added to a
SharePoint group.
5. Click People and Groups
6. Observe the “CENTRAL”- centric groups (e.g. CENTRAL License Administrators)
7. Choose the appropriate group > Click New, and then click Add Users.
8. In the Users/Groups box, type a domain name or user name. Click Check Names to verify, or
click Address Book to locate a name.
9. Verify the Give Permission pull-down menu reflects the appropriate permissions for the
respective group
10. To send a welcome e-mail message to users, select Send welcome e-mail to new users.
11. In the Subject, type a subject for the e-mail message.
12. In the Personal Message box, type a message. Click OK. Your screen should like this:
Winshuttle CENTRAL - Deployment Guide
22
Figure 5.3: People and Groups
Manage Master Pages
You can configure master pages for the CENTRAL site according to your organization’s branding
guidelines.
1. Click WINSHUTTLE CENTRAL Administration.
Figure 5.4: Manage CENTRAL master pages
2. Under Site, click Manage master pages.
3. On the server, go to the following location: /_catalogs/masterpage/WinshuttleDefault.master
4. You can modify the HTML page WinshuttleDefault.master to add your company logo and edit
html components.
End User Name
Winshuttle CENTRAL - Deployment Guide
23
5. After you modify and save the HTML file, reset the IIS.
The updated master page appears in the list.
6. Select the master page and click Apply to this site.
Activate Licenses
Next, you need to activate your Winshuttle CENTRAL site with a license key. These next steps assume
you have assigned a user to the CENTRAL License Administrator group.
1. Click WINSHUTTLE CENTRAL Administration, at the bottom left corner of the page.
Figure 5.5: CENTRAL Administration link
2. Under Site Administration, click Activate Licenses.
3. In the Activation Code box, add the activation code.
4. In the User Information box, type the e-mail address of the license administrator for your
company.
5. Click Download License File and save it. (It is best to save it to a network share or a backup
target).
6. Browse to the license activation file that you were sent. This is an .xml file.
7. Add a description of the activation. Click Activate License.
8. Now that the site license has been activated you must assign the Site roles. Without these roles,
the site administrator cannot assign or use the Winshuttle CENTRAL site.
Winshuttle CENTRAL - Deployment Guide
24
9. The two administrators have the following responsibilities:
CENTRAL site administrator: determines Winshuttle product usage policies.
CENTRAL license administrator: assigns licenses for Winshuttle products.
Managing licenses
With Winshuttle CENTRAL, you can manage all licenses for all Winshuttle products that are used in your
company. Use CENTRAL to keep track of licenses as users leave or change departments, and as you
add licenses.
For each Winshuttle product license, whether QUERY, TRANSACTION, or RUNNER, one CENTRAL
license is assigned.
For example, with 100 CENTRAL licenses, there could be 5 users for QUERY users and 5 users for
TRANSACTION, and 10 users of RUNNER. In such situation, 20 CENTRAL licenses are used and 80
remain unassigned.
Note: If a single user has a TRANSACTION and QUERY license, only one CENTRAL license is assigned.
Assigning product licenses
1. Under Site Administration, click Manage Licenses.
2. Under Activated Licenses, find the product you want to assign users for, and then click Assign
Users.
3. The Select user for products assignment will now show the license you named earlier.
4. In the Select Users box, type a domain name or user name. Click Check Names to verify, or
click Address Book to locate a name.
5. Under Select activation, select the product that you want to assign the user to.
6. Click Assign.
7. Click Save.
Reclaiming product licenses
Because CENTRAL dynamically manages all product licenses, you can reclaim, remove, or add licenses
as needed.
1. From the Winshuttle CENTRAL Administration page, click Manage Licenses.
2. Click By Products.
Winshuttle CENTRAL - Deployment Guide
25
3. Under Activated Licenses, click Assign Users for the product you want to reclaim a license for.
4. Under Assigned Users, clear the check box for the user you are reclaiming the license.
5. Click Save. The user is removed from the list of Assigned Users.
Viewing license and product assignment
From the CENTRAL Administration page you can view the licenses in two ways – By Products or By
Activations.
By activations
1. Click CENTRAL Administration.
2. Under Site Administration, click Manage Licenses.
3. On the View menu, click By Products, and then click By Activations.
The type of license available for each product is displayed and includes the following information:
Activation Date for all licenses
Expiry Date for a particular license
Total Number of Licenses available for that product
Available Number of Licenses are the number of licenses that have not been assigned
License Type indicates whether the license is Enterprise or Regular
Evaluation indicates whether the license is an evaluation copy or a paid copy
By products
1. Click CENTRAL Administration.
2. Under Site Administration, click Manage Licenses.
3. On the View menu, click By Activations, and then click By Products.
The following information is displayed for each product:
Total Number of Licenses lists the total number of licenses available for a product.
Available Number of Licenses indicates the number of licenses that have not been
assigned to a user.
Winshuttle CENTRAL - Deployment Guide
26
6. Configuring CENTRAL
Once the licenses are activated for the users you need to configure various settings to allow access to the
desktop clients. Some of these settings include:
SAP Application Servers
Policies
System Usage Level Settings
Reporting Features
SAP Credentials and Servers
In order to effectively control the various SAP servers in the enterprise landscape you must configure the
SAP Application Servers in CENTRAL. In addition, each desktop user with access to SAP can submit
their respective SAP credentials into CENTRAL.
Add your SAP Application Servers
The Application Server facilitates communication of desktop client and SAP server via CENTRAL. There
are two classes of server types: production and non-production. Production servers are servers that run
approved files; non-production servers are the development servers, where files reside that have not yet
been approved or used to test development scripts on. SAP Credentials are encrypted in the
eSHUTTLEDB and are only used if the job scheduler or autopost is enabled. Winshuttle Server is a
requirement for the job scheduler and autopost functions.
To add an application server to the CENTRAL site
1. Click CENTRAL Administration and then under TRANSACTION or QUERY administration, click
Application Servers.
2. Click Add, and then Add Server.
3. Enter the SAP system ID, the Client, Server type, and whether the server is production or non-
production. Enter a Description of the server.
4. Check the Auto Logon Details box
5. Enter the Application Server Host (either FQDN or IP)
6. Enter the System Number
7. Lastly, click Save
Repeat as necessary for each class of server
Winshuttle CENTRAL - Deployment Guide
27
6.1. Policies
Policies provide the CENTRAL administrator access control over the desktop clients. By entering in
specific SAP Application Servers and Policies the administrator can set the “who, what and when” access
points. Winshuttle CENTRAL provides seven sample policies.
Sample Policies
Policy Name Description
Production Production Servers Only
Non Production Non Production Servers Only
No Weekday Master Data
Changes
Policy to disallow master data changes on
Weekdays
No Month end Financial
Postings
Policy to disallow month end financial postings for F*
transactions for the first five days of any month
Limit Maximum Updates Limit the maximum no of records that can be created
or updated to maximum of 100 entries
Disallow use of Winshuttle for
SPRO
Disallow the use of Winshuttle for SPRO
Allow use of Winshuttle only for
Journal Entry
Allow users to only use Winshuttle for FB50
Table 6.1:Sample policies
To create a server policy
1. Click CENTRAL Administration, and then under TRANSACTION Administration, click Policies.
2. Under Policies, click the Add arrow, and then click TRANSACTION Policy or QUERY Policy.
3. Specify details of the server policy:
Enter a policy name that reflects the intent of the policy.
Winshuttle CENTRAL - Deployment Guide
28
Enter a description of the policy.
Specify the SAP server type (Production or Non-Production).
Specify when the server will be accessed by this policy, whether daily, weekly, or monthly.
Specify access to SAP Tables that can be allowed or disallowed for the users.
Set the hours for when the server should be operable.
Specify number of transactions or queries allowed for each run.
Specify the transactions or queries that are allowed or disallowed for a given server.
To assign users to a policy
1. In the Add new users or groups box, type a name.
2. Click Check Names to verify, or click Address Book to locate a name.
3. When you have located the name, click Add. The name appears in the Existing Users and
groups box.
To remove a user from a policy
Under Policies, click the policy name. In the Existing users and groups box, select a name, and
then click Remove.
Winshuttle CENTRAL - Deployment Guide
29
6.2. Preferences
The CENTRAL Administrator can use Preferences to control various aspects of the desktop client and
interaction with the CENTRAL site. Groups and Policies maintain security and data integrity by limiting the
types of transactions or queries that can be used.
This section illustrates the workflow and processes behind each operation. In addition, this section covers
specifying the review and run preferences and the approval process.
With Winshuttle CENTRAL, administrators can control the workflow process through which data is posted
to production SAP servers. Requiring a review process increases the chances that the correct data is
used.
The following items can be configured according to the needs an organization:
Review Process Description
No Data File Review Process No review required for data that has been entered in
TRANSACTION program
Review and Post - One Step In this process the reviewer is the final runner of the
file.
One person enters the data. The reviewer reviews and
then posts the data, and thereby becomes the person
of record for entering the data
Review and Post Separately – Two
Step
In this process the submitter of the data file is the final
runner of the file. The reviewer reviews the data and
then returns the data to the runner who posts the data
Table 6.2: Review processes
Winshuttle CENTRAL - Deployment Guide
30
Site Preferences Process Name Description
Allow Self Approval Allow self- approval for the script developer
TRANSACTION script approval TRANSACTION script Approval workflow
required
Save to CENTRAL Allow Save to CENTRAL for No Data Review
Process
Allow Run On Errors Allow Run on Errors
Run Reason Required Run Reason Required for each SAP data
posting
Enable Item Level Permissions Enables Item Level Permissions for data files in
the document library
Allow Desktop Scheduling Allows the end user to run or schedule
approved scripts to SAP
Table 6.3: Site preferences
Winshuttle CENTRAL - Deployment Guide
31
Move to Run Process Name Description
Validation Failed Moves failed validation data files to the Run
Complete document library
Error(s) returned from SAP while
posting
Moves SAP error data files to the Run Complete
document library
Error Occurred Moves general error data files to the Run Complete
document library
Job Cancelled Moves cancelled jobs to the Run Complete
document library
Winshuttle SERVER Error Moves Winshuttle SERVER error data files to the
Run Complete document library. Requires
Winshuttle SERVER
Table 6.4: Process errors
Winshuttle CENTRAL - Deployment Guide
32
6.3. Workflow
Workflow is a feature process within SharePoint environments. A workflow is a natural way to organize
and run a set of work units, or activities, to form an executable file representation of a work process. This
process can control almost any aspect of an item in Windows SharePoint Services, including the life cycle
of that item. The workflow is flexible enough to model both the system functions and human actions
necessary for the workflow to complete.
TRANSACTION workflow considerations
Using the SharePoint workflow feature, Winshuttle CENTRAL provides an ‘out of the box’ script for data
review process. The review increases the chances that the correct data is downloaded and uploaded on
the target SAP server.
You can only record to a non-production application server.
Script files (.TXR) must be approved before running on a Production Application Server.
Data review is not necessary but highly recommended.
Managing client-controllable features
You can allow users to specify following settings through client-controllable features:
Back up SAP Data: Automatically creates a backup copy of the current SAP data fields by opening
another Excel worksheet before TRANSACTION runs the script file. This setting is useful when you want
the ability to roll back data.
Run Not Posted: Select this check box to ensure that the data file for the run has not been used
previously. To verify the data file, TRANSACTION checks the script file for log information.
(TRANSACTION stores all of the messages returned by SAP in your data file). If log information is
present in the SHUTTLE file, the run stops.
Enable Production Server Warning on Run: If enabled, Winshuttle CENTRAL generates a warning
every time you log on to a production server.
To specify which options users can set
1. Click WINSHUTTLE CENTRAL Administration.
2. Under TRANSACTION Administration, click Manage Client Features.
3. For each feature, select Controlled by Client or Controlled by Server.
4. For each selection, set the value to True or False. Click Update.
Limiting approval capability
A site member can circumvent file access restrictions to view restricted files and approve tasks that are
assigned to other users. The tasks can be opened from any file library by clicking Actions, and then
clicking Open with Access on the Tasks page toolbar. Restricted files can be viewed by clicking Actions,
and then clicking Open with Windows Explorer in the Data Files library.
Winshuttle CENTRAL - Deployment Guide
33
NOTE: We recommend that you remove the Actions buttons from CENTRAL.
To remove the Actions button from the toolbar
1. Click Site Actions, and then click Edit Page.
2. Click Edit, and then click Modify Shared Web Part.
3. Under Toolbar Type, click No Toolbar to apply changes.
4. The toolbar disappears from the current document library. Repeat the process for all the
document libraries.
Winshuttle CENTRAL - Deployment Guide
34
6.4. Configuring CENTRAL for QUERY
In general, most configuration steps used for TRANSACTION are applicable to QUERY. Below are the
principal steps needed to interact with QUERY.
Creating policies
To create a server policy:
1. Click WINSHUTTLE CENTRAL Administration, and then under QUERY Administration, click Policies.
2. Under Policies, click the Add arrow, and then click QUERY Policy.
3. Specify details of the server policy:
Enter a policy name that reflects the intent of the policy.
Enter a description of the policy.
Specify the SAP server type, whether Production or Non-Production.
Specify when the server will be accessed by this policy, whether daily, weekly, or monthly.
Specify the maximum records that can be extracted for a run.
In the Allow Tables box, specify which tables users are allowed to access. In the Disallow Tables box, specify which tables users may not access. You can use a wildcard "*" to specify all tables, or use the wildcard with a table name to specify all tables of a given type.
Set the hours for when the server should be operable.
4. Specify the system usage level, whether low, medium, or high, to be permitted on that server at that a given time.
To assign a user to a policy
1. In the Add new users or groups box, type a name.
2. Click Check Names to verify, or click Address Book to locate a name.
3. When you have located the name, click Add. The name appears in the Existing Users and groups box.
To remove a user from a policy
Under Policies, click the policy name. In the Existing users and groups box, select a name, and then click Remove.
SAP Table Access for QUERY
As part of production server policies for QUERY, you can restrict user access to specified SAP tables to
prevent system overload and ensure table security. You can explicitly allow the use of specified tables,
and disallow the use of other tables.
To specify fields and tables, you can use a wildcard *. A wildcard "*" specifies all tables, and a wildcard with a table name specifies all tables of a given type.
Winshuttle CENTRAL - Deployment Guide
35
In Figure 6.1, the maximum records to be extracted have been limited to 10 and the allowed SAP tables
includes a wildcard character * and the SAP table MATNR.
Figure 6.1: Configure Server Policy
System usage levels
System usage levels describe the level of system resources that a query might consume during a query
execution. For example, at the end of the month, you might want most queries to have a low impact on
the system. Usage levels can be set for low, medium, or high. An administrator can define extraction
settings for each system usage level according to the following characteristics:
Length of allowed timeout
A limit on the maximum number of result rows
A limit on the number of records that can be downloaded
NOTE: It is possible to have an approved query that you cannot run because its system usage level does not
match the policy on the server where it is supposed to run.
To specify the details for each usage level
1. Click WINSHUTTLE CENTRAL Administration.
2. Under query Administration, click System Usage Level Settings.
3. Specify the limits of each setting. Click Update.
Winshuttle CENTRAL - Deployment Guide
36
Assigning roles and proficiency levels
One method of controlling the data creation process is to assign roles to users.
CENTRAL Group roles for QUERY
Groups have predetermined capabilities associated with them and how they interact with CENTRAL.
These capabilities focus on creating, reviewing, and running a query file, and administering a data
dictionary.
WINSHUTTLE CENTRAL provides four groups:
Query Developer: A developer can create and submit a query file. Developers can also define Data
Dictionaries. Each developer is assigned a developer proficiency level.
Query Runner: A runner can use approved queries to download data from SAP.
Query Reviewer: A reviewer reviews and approves query files before they can be run.
Data Dictionary Administrator: A developer can edit and upload a dictionary, and can search the SAP
data dictionary and add tables from it.
Developer Proficiency Levels
When you assign a developer role, you must set the proficiency level for that developer. Proficiency levels
include the following:
Basic
Standard
Advanced
To assign proficiency levels to roles
1. Under QUERY Administration click Developer Proficiency Level Settings.
2. From the Proficiency Level box select a level: Basic, Standard, or Advanced.
3. Click Update. The new setting is saved.
Each proficiency level has additional settings:
Enable creation of joins in query builder
Enable joins for transparent, cluster, view, and pool tables
Maximum number of tables a user can add to the query builder
Winshuttle CENTRAL - Deployment Guide
37
Specifying run, review, and data dictionary preferences
Data Dictionary Administrators
With Winshuttle CENTRAL you can allow each user to maintain his or her own data dictionary, or you can
provide one data dictionary for all users that only a data dictionary administrator can add tables to. By
default, each user has a local data dictionary. The centralized data dictionary must be specifically
enabled. With a central dictionary, users can assign favorites from the existing tables, but these local
favorites are not written to the server.
A data dictionary administrator can create or edit a dictionary and upload it to the CENTRAL site. An
administrator can edit a local copy or download the latest copy from the server. Administrators can search
for and add tables within both the Winshuttle data dictionary and the SAP data dictionary.
To apply a centralized data dictionary, you must have the data dictionary administrator role. The data
dictionary administrator is assigned on the Roles page. You must already have a developer role before
you are assigned the data dictionary administrator role.
Data Dictionary Users
Data dictionary users who are not administrators can only search the available Winshuttle dictionary.
When a new version of the data dictionary is available, it is automatically downloaded from the server
when the user opens querySHUTTLE.
To specify that everyone should use the centralized data dictionary
1. Click WINSHUTTLE CENTRAL Administration. Under query Administration, click Preferences.
2. Select Centralized Data Dictionary. Click Save to apply your selection.
Self-Approval
You can allow a file creator to approve his or her own files.
To specify self-approval
Click Self-Approval. Click Save to apply your selection.
Query File Approval
You can specify whether query files require approval or not. If this setting is not selected, when a file is
submitted, it immediately becomes a production file and no review is required.
To specify query file approval
Click Query file approval. Click Save to apply your selection.
Winshuttle CENTRAL - Deployment Guide
38
Enabling Adaptive QUERY Throttling
Using a patent-pending algorithm, QUERY adaptively throttles the execution of the query on the SAP
server, based on the current load on the SAP server. The available server resources are calculated from
the total number of open dialog processes. When over 50 percent of the dialog processes on the SAP
system are available, the query is executed at full speed. When the available server load starts falling
below 50 percent, the execution of the query is dynamically slowed.
Adaptive throttling addresses the performance concern when querying on a live transactional system. A
large query execution can take substantial computing resources that might compete against regular SAP
transactions. This process will adversely affect the performance of these transactions. Query addresses
this issue by allocating only available compute resources to execute queries in the live SAP system.
When the throttling algorithm is applied, query execution slows as the system load increases; however,
without the algorithm, the query executes in constant time and competes for resources with other
transactions on the system.
NOTE: Users apply query throttling by selecting a check box in the Advanced Options window of QUERY.
However, an administrator must first enable throttling in CENTRAL.
To enable adaptive query throttling
Select Enable adaptive query throttling. Click Save to apply your selection.
Winshuttle CENTRAL - Deployment Guide
39
7. LDAP Connection for Active Directory
To enable SharePoint to access Windows domain accounts, you must assign a valid account for logon
into the defined LDAP server.
To create an LDAP connection
1. Click CENTRAL Administration. Under Site Administration, click Manage LDAP Connection.
2. Click Allow domain groups.
NOTE: This setting must be selected and saved to make this LDAP connection.
Add the following information to create the LDAP connection in CENTRAL:
LDAP Server. Add the name of the LDAP server.
User name. Add the user name for the LDAP logon account.
Password. Add the password for the LDAP logon account.
Domain name. Add the name of the domain where the account exists.
Target. Add the name of the target organizational unit, as needed.
3. Click Test Connection. Click Save.
Figure 7.1: LDAP settings
Winshuttle CENTRAL - Deployment Guide
40
8. Upgrading CENTRAL
A CENTRAL upgrade can be carried out in two steps:
Upgrade CENTRAL version 10.0 to 10.1
Upgrade CENTRAL version 10.1 to 10.2
The upgrade to version 10.2 applies to the following versions:
Minimum CENTRAL 10.0
8.1. Upgrade from CENTRAL version 10.0 to version 10.1
1. From the CENTRAL Administration site, ensure that the current version is 10.0 (Figure 8.1).
2. On the SharePoint server, run CENTRAL setup.exe.
3. When prompted, click Next on the CENTRAL Setup Wizard.
Figure 8.1: Version Verification
4. Ensure the System Check page displays Green check marks next to each step, and then click
Next.
Winshuttle CENTRAL - Deployment Guide
41
Figure 8.2: Click Next
5. Ensure that Upgrade is selected. Click Next.
Figure 8.3: Select Upgrade option
6. The installer displays progress.
Winshuttle CENTRAL - Deployment Guide
42
Figure 8.4: Upgrade progress
7. When the upgrade completes, click Next.
Figure 8.5: Click Next
8. The screen confirms that upgrade was successful. Click Close.
Winshuttle CENTRAL - Deployment Guide
43
Figure 8.6: Upgrade Successfully Completed
9. On the CENTRAL site, click CENTRAL Administration, and then click Upgrade V10.0 to V10.1.
Figure 8.7: Upgrade CENTRAL Site
10. Screen displays information being processed.
Winshuttle CENTRAL - Deployment Guide
44
Figure 8.8: Upgrade process
11. After the upgrade has completed click the CENTRAL Administration link. Version should now
appear as 10.1.
Winshuttle CENTRAL - Deployment Guide
45
8.2. Upgrading CENTRAL to 10.2
The following upgrade to version 10.2 applies to the CENTRAL version 10.1.
1. On the SharePoint server, run CENTRAL setup.exe.
2. When prompted, click Next on the CENTRAL Setup Wizard.
3. Ensure that the System Check page displays Green check mark next to each step, and then click
Next.
Figure 8.9: Click Next
4. Ensure that Upgrade is selected. Click Next.
Winshuttle CENTRAL - Deployment Guide
46
Figure 8.10: Select Upgrade option
5. The installer displays a warning message that all the existing workflows will be terminated during
the upgrade process.
Figure 8.11: Warning
6. Screen will display installation progress, refer Figure 8.13.
Figure 8.12: Installation progress
7. When the upgrade completes, click Next.
Winshuttle CENTRAL - Deployment Guide
47
Figure 8.13: Upgrade completed successfully
8. The screen confirms that upgrade was successful. Click Close.
9. On the CENTRAL site, click CENTRAL Administration and verify the CENTRAL version.
Figure 8.14: CENTRAL Site
10. From the CENTRAL Administration site, ensure that the current version is 10.1 and the available
option is to upgrade to CENTRAL Site Version 10.2, refer Figure 8.15.
Winshuttle CENTRAL - Deployment Guide
48
Figure 8.15: Version Verification
Winshuttle CENTRAL - Deployment Guide
49
9. Uninstalling CENTRAL
The following are the steps to uninstall the CENTRAL database and CENTRAL sites:
9.1. Preparing for uninstall
To uninstall the software:
1. Identify the computers you want to uninstall from and the components you want to uninstall from
each computer.
2. Ensure that no active connections to the SharePoint Site Collection exist where the instance of
CENTRAL resides.
For Winshuttle Components
1. Log on to the client as local Administrator or as a member of the Administrators group.
2. Verify and ensure that you have a current backup of your computer, system, and SharePoint
databases.
For SharePoint Components
1. Because this process affects the CENTRAL SharePoint components, it is important that no users
be logged into the affected CENTRAL sites.
2. Remove the CENTRALdb in the SQL instance of the SharePoint server
9.2. Removing CENTRAL
1. Double-click the CENTRAL Setup.exe file to start the removal process.
2. When prompted at the Winshuttle CENTRAL Solution screen, click Next the.
Winshuttle CENTRAL - Deployment Guide
50
Figure 9.1: Click Next
3. Allow the CENTRAL Solution System Check to complete the system checkpoints.
Figure 9.2: System Check
4. Click Remove and wait for the process to complete.
Winshuttle CENTRAL - Deployment Guide
51
Figure 9.3: Select Remove
5. Wait while CENTRAL Solution is removed. Click Next when you are prompted.
Figure 9.4: Uninstall progress
6. Click Close on the Uninstall summary screen.
Winshuttle CENTRAL - Deployment Guide
52
Figure 9.5: Uninstall Successfully Completed
7. Now you must uninstall the Winshuttle.CENTRAL.Database from the Add or Remove Programs.
Figure 9.6: Add or Remove Programs list
Winshuttle CENTRAL - Deployment Guide
53
Figure 9.7: Add or Remove Programs confirmation
8. Next, manually remove the CENTRALDB from the SQL Server Management Studio. Highlight the
database, right-click and choose Delete.
Figure 9.8: SQL Server Management Studio
9. Click OK on the Delete Object screen.
Winshuttle CENTRAL - Deployment Guide
54
Figure 9.9: Delete Object screen
The uninstall process is now complete.
Winshuttle CENTRAL - Deployment Guide
55
10. Support Information
We hope that this guide has given you an understanding of the options and recommended practices for
CENTRAL in an Office SharePoint Server deployment. For more information about backing up and
restoring Office SharePoint Server, go to
Plan for backup and recovery (Office SharePoint Server)
(http://go.microsoft.com/fwlink/?LinkId=102799)
Administering backup and recovery for Office SharePoint Server 2007
(http://go.microsoft.com/fwlink/?LinkID=102627)
You may also visit our site at www.winshuttle.com