Oracle Hospitality Materials Control: Deployment

Oracle Hospitality
Materials Control
Deployment
Oracle_Hospitality_Materials_Control_830_deployment.docx
Materials Control Solution Management
HGBU
July 2015
Document version 1.0
Document version
Version Date Author Changes
1.0 July 2015 Product Management creation
Materials Control Solution Management, HGBU
July 2015
Page 2 of 32
Table of content
Introduction ............................................................................................................................ 4
Deployment............................................................................................................................. 5
Overview............................................................................................................................... 5
Prerequisites ......................................................................................................................... 5
Installation Process ............................................................................................................... 6
Installed Apps:................................................................................................................... 6
Web Apps:....................................................................................................................... 29
July 2015
Page 3 of 32
Introduction
The purpose of this document is to provide instructions for installing/upgrading a existing
Materials Control environment version 8.30. It is assumed that any previous Materials Control
installation being upgraded has all necessary prerequisites of prior versions.
July 2015
Page 4 of 32
Deployment
Overview
The release of Materials Control 8.30 includes the following files:
150330_DGMIMS 8.30.1.1550.zip
150330_MobileSolutionSetup 8.30.1.zip
150330_MobileWeb 8.30.1.1550.zip
150330_MobileWebService 8.30.1.1550.zip
150330_NutrientImport 8.30.1.1550.zip
150330_POSWebService 8.30.1.1550.zip
150522_MCweb 8.30.2.1550.zip
150529_AutomationServiceSetup32bit 8.30.2.1550.zip
150706_MC_Full_8.30.6d.1550.zip
Prerequisites
Materials Control thick client application 8.30 and above require that .NET Framework 4.x is
installed on all client PCs.
Since Materials Control is a 32bit application, an Oracle Client in 32bit version is required to
run the application.
MCweb 8.00 and above require that .NET Framework 4.x is installed on all app servers.
July 2015
Page 5 of 32
Installation Process
Logically, the Materials Control installation/upgrade can be broken into three sections;
Installed Apps, Web Apps and Web Services.
Installed Apps:
This part will include the standalone applications that are installed using a Setup executable.
For this part, we will use the following files…
150706_MC_Full_8.30.6d.1550.zip
Contains an installer to setup/upgrade the Thick Client.
Contains the installer (Setup.exe) that will be run to setup/upgrade Automation
Service.
This chapter will explain in detail …
 How to install an application client for Materials Control Version 8.30.xx
 How to update an existing application client of Materials Control > Version

8.6.6.10.xx to a higher patch level
 How to update an existing application client of Materials Control < Version

8.6.6.10.xx to the current version
 Handling of customized files like e.g. SQL.INI, FMLOGIN.INI, customized QRP

templates, etc.
 How to install AutomationService
The installation routines for Materials Control version 8.6.6.10.xx and higher have been
adjusted. The application is delivered in one single package now. Patches within the actual
version will be delivered in one single update package which can be installed upon the
matching release version.
These packages will be named like shown below:
- 150330_MC_Full_8.30.6d.1550
Explanation of the naming:
- 150330 This is the creation date of the package, here March 30,
July 2015
Page 6 of 32
2015.
- MC_Full This shows the type of the package.
- 8.30.6d.1550 This is the exact version of the package.
o Main Version 8
o Sub Version 30
o Patch level 6d
o Database Version 1550
The installation / update process will be started by executing SETUP.EXE.
July 2015
Page 7 of 32
New Client 8.30 Installation:
This chapter will explain the installation of a new client application version 8.7.20.xx.
How to install the new release?

1. Unzip the installation package, e.g. 120914_MC_Full_8.7.20.36.1421. When
using WINZIP (or similar) select the option "Extract to here"
2. A new folder "120914_MC_Full 8.7.20.36.1421" will be created
3. Run SETUP.EXE to start the installation process.
First select your preferred installation language please:
Click “Next” to continue:
July 2015
Page 8 of 32
Here the installation directory could be adjusted. By default the install shield will offer to install
in:
C:\Program Files (x86)\ Materials Control\
This could be adjusted to the local needs by click on the button “Change”:
Define the required path and click on “OK” to continue:
July 2015
Page 9 of 32
Now SQLBNet connection name must be entered:
This name can be found in the TNSNames.ORA / SQLNet.ORA file of the Oracle client
installation, defined as e.g. SERVICE_NAME / SID.
Enter the RDBMS connection information and click “Next”. The system will now test the
connection.
In case incorrect connection parameters or unavailable database system the install shield will
show a message like below:
Check the connection and the database availablility and repeat the process.
Once the connectivity test was successful please click “Next” to continue.
July 2015
Page 10 of 32
The next screen offers to install the PDF Printer Driver and Crystal Reports Driver. Both are
selected by default and should be installed.
July 2015
Page 11 of 32
Now the required installation parameters are defined and the main process could be started.
Click now “Install” to start the process or “< Back” to return to the previous screens.
The install shield shows the installation progress on screen. It will take some minutes.
After the installation of the main client app, the installer will also install the required (and
selected) Crystal Reports Runtime:
Click “Next”:
July 2015
Page 12 of 32
Click “Next”:
Click “Next” to start the installation process.
July 2015
Page 13 of 32
Click “Finish” to continue.
Once completed the following message shows the successful installation of the Materials
Control Client installation.
Click “Finish” to finalize the process. The install shield will now remove temporary used files
and close the screen.
Depending on certain parameters and conditions it may be required that the PC is restarted.
The system will show the following message if required.
July 2015
Page 14 of 32
Once the 1st client application was installed the usual Database Update and Reorganization
must be executed.
After this install the remaining client applications.
Update Client Installation:
This chapter will explain the update of an existing Materials Control Client to a higher patch
level.
After starting the SETUP.EXE the install shield checks for already installed versions. If found
the following screen is shown:
July 2015
Page 15 of 32
Here the user can select either to install a new application client or to update the existing
application.
Select “Maintain or update the instance of this application selected below” and click on “Next”.
The system will now start the application update process.
The install shield will show the status of the upgrade on screen.
Once the system has finished the process of copying files the following screen is shown:
July 2015
Page 16 of 32
Once the 1st client application was updated the usual Database Update and Reorganization
must be executed.
After this update the remaining client applications.
Update Client < 8.6.6.10 Installation:
This chapter will explain the required steps to update a client installation from older versions,
e.g. 8.6.5.10.xx to the current version.
After starting the SETUP.EXE the install shield checks for already installed versions. If found
the following screen is shown:
Click “Yes” to proceed or “No” to cancel the install shield.
Even if the option is available it is strongly recommended to uninstall the previous version first
and then do a fresh install of the application.
July 2015
Page 17 of 32
Click “Install” to start the process.
The install shield will show the status of the upgrade on screen.
Once the system has finished the process of copying files the following screen is shown:
After this update the remaining client applications.
July 2015
Page 18 of 32
Automation Service
The Automation Service is the replacement for the former Scheduler, executed via DGService
/ WATCH.EXE. This module is consists of two parts:
 Automation Service Console

This module will be delivered as a separate installation package. IT allows to
define the service configuration which will execute the jobs defined in the
application.
 Automation Service Job Configuration

This module is located in the System section as Scheduler.
ATTENTION: Please note that there are two different Installation Packages …
 150529_AutomationServiceSetup32bit 8.30.2.1550
This package must be used in case the connection to Oracle is done via 32-Bit
Oracle client.
 150529_AutomationServiceSetup64bit 8.30.2.1550
This package must be used in case the connection to Oracle is done via 64-Bit
Oracle client.
Automation Service Console:
 Unpack the installation files for the Automation Server to any temporary
location.
 Start SETUP.EXE
 Click button “Next”

July 2015
Page 19 of 32
 Accept or adjust the installation directory and confirm by pressing the button
“Next”.
We strongly suggest not to install on the system drive!
 Click button “Next” to start the installation.
July 2015
Page 20 of 32
 The installation process screen will close automatically once finished.
Configuration Details:
 Start AutomationServiceConsole.EXE
 Confirm with “OK”
 The system will now create a configuration file with default values and open the
Console screen:
July 2015
Page 21 of 32
 Adjust the database connectivity parameters:
o Database Server = Oracle Instance

o Database User = Oracle User
o Database Password = Oracle Password (will be stored encrypted)
(Please see below for support of multiple databases.)
 Application User ID:
This ID should show the internal user ID of the system administrator. Please do
not change this value.
 Profile INI File:
July 2015
Page 22 of 32
Here the used configuration file is shown. This value should not be changed.
 Adjust the directories as required.
o Application Folder:
Installation Folder selected during installation. Please do not change
this value.
o Assemblies Folder:
Installation Folder selected during installation. Please do not change
this value.
o Template Files Folder:

This is the path where the templates (e.g. for B2B Imports) are located.
Usually this is the subfolder \RST (which is already preselected).
o Log File Folder:

Definition of the path to the log file directory.
Make sure that the folder is exists and is configured for read/write
access.
o Temporary Files Folder:

Definition of the path to the directory for temporary files..
Make sure that the folder is exists and is configured for read/write
access.
o Message File
Path to the message file of this installation. Please do not change this
value.
 Allowed Job Types:
July 2015
Page 23 of 32
Per default each type of job can be run on the Automation Service. To disable
certain jobs, please click on the button and mark the job types this
installation of the Automation Service should be able to execute:
 Service Instance
If only one Automation Scheduler installation is in use, please select “None

(Master Instance)” here. However, if there are several Automation Scheduler
installations for one database, each installation should be assigned to a
separate Service Instance, as this will allow you to control which Job to run on
which installation. For this purpose, the Service Instances must be defined on
tab “Service Instance Management” beforehand.
To add or remove Service Instances, please right-click on tab “Service

Instance Management” and select the corresponding entry from the context
menu.
July 2015
Page 24 of 32
 Define the Log Level:
o Log Level:
Please define the log level to define the content of the log file.
Especially at the beginning of the installation it is recommended to set
the level to “HIGH”. This can be changed once the service is running
successfully.
o Polling Interval:
Please enter the interval (in seconds) at which the Automation Service
should start newly created jobs. (For example, if value “60” is entered
here, the Automation Service will determine whether there are new jobs
and, if so, start them every 60 seconds.)
o Max. No. of threads:
The number of Jobs the Automation Scheduler should be capable of

running at the same time.
 Check Notification parameters:
o If this checkbox is ticked, no notifications will be sent to the users.

Definitions for notifications in the setup of the individual jobs will be
ignored.
 Click the button “Save Configuration”
 The Console will now check the connectivity:
July 2015
Page 25 of 32
 Confirm with “OK”
 The Console will now create the configuration file.
 Click OK to close the dialog and finalize this step.
 Close the Automation Console.
 Inside the installation directory of the AutomationService search for the file
“AutomationService.exe.config”
 Open the file with any editor:
o At the end of the section </appSettings> a new key must be added

manually.
<add key="CustomReportsPath" value="{Path to the RPT folder}" />
This could look like this:

<add key="CustomReportsPath"
value="D:\\AutomationService\\Rpt_Eng" />
July 2015
Page 26 of 32
NOTE_ Make sure that the path is defined with \\ instead of \!
You could also copy the report folder to any other location (e.g. inside
the Automation Service installation) and define this path accordingly.
o Save and close the file.
 Re-open the AutomationServiceConsole.exe
 A balloon message will show the current status of the Automation Service:
 In the Console the current status is shown.
 Click “Start”.
o The service will now try to start
July 2015
Page 27 of 32
o If successful the status will be shown as follows:
 At each start of the Console the status of the service is checked and shown:
 In the task manager the service can be found as “MICROS.Automation

Service”
Required Permissions:
Since the Automation Service Console allows to start & stop services, it may require to
be executed with the option “Run this program as an Administrator”.
July 2015
Page 28 of 32
Web Apps:
This part includes deploying web applications and web services on IIS. In this part of the
installation/upgrade, we will deploy new/updated files for MCweb.
The C:\inetpub\wwwroot folder contains the builds for these web apps. For this part of the
upgrade, we will need the following files…
150522_MCweb 8.30.2.1550.zip
Contains the builds that get copied to C:\inetpub\wwwroot\<WebClientDir> and
to C:\inetpub\wwwroot\aspnet_client
150330_MobileWebService 8.30.1.1550.zip
Contains the builds that get copied to
C:\inetpub\wwwroot\<MobileWebServiceDir>
150330_MobileWeb 8.30.1.1550.zip
Contains the build that gets copied to
C:\inetpub\wwwroot\<MobileWebDir>
150330_POSWebService 8.30.1.1550.zip
Contains the build that gets copied to
C:\inetpub\wwwroot\<POSWebServiceDir>
Step by step instructions:
This example shows how to upgrade all IIS based components of Materials Control system
where all components are installed on one single Windows installation. These steps may
differ if using more than one app server, with different components on different servers.
For new installations, please consult the detail installation procedures for the web based
applications.
Upgrade Prep
1) Copy all files from the 8.30 build to a temporary directory on the app server, from
which we will stage the upgrade. For this example, a folder named MCwebSetup
was created on the C: drive and the 8.30 build files were copied to it.
2) Stop the IIS Admin Service and DGService. These can all be stopped from
services.msc.
3) Make backup copies of the C:\inetpub\wwwroot directory
July 2015
Page 29 of 32
Note: The IIS webpages in this example are represented as <WebClientDir>,
<MobileWebDir>, <MobileWebServiceDir> and <POSWebServiceDir>. Replace these with the
names of the IIS directories in your environment.
1) Unzip the following files to a temporary directory.
150522_MCweb 8.30.2.1550.zip will create the following folders when unzipped…

Infragistics Scripts
MCweb.Application
MCweb.Config
150330_MobileWebService 8.30.1.1550.zip will create the following folders when

unzipped…
MobileWebService.Application
MobileWebService.Config
150330_MobileWeb 8.30.1.1550.zip will create the following folders when unzipped…

MobileWeb.Application
MobileWeb.Config
150330_POSWebService 8.30.1.1550.zip will create the following folders when

unzipped…
POSWebService.Application
POSWebService.Config
2) Once you have backup copies of the <WebClientDir>, <MobileWebServiceDir>,

<MobileWebDir> and < POSWebServiceDir >, delete all the contents of these
folders. The folders should be completely empty.
3) Browse to the MCweb.Application directory, select all contents and copy
4) Browse to the C:\inetpub\wwwroot\<WebClientDir> folder, and paste in all files from

the MCweb.Application directory.
5) Browse to the MCweb.Config directory, copy the new web.config and paste it into
the C:\inetpub\wwwroot\<WebClientDir> directory.
6) Open the web.config from the backup of the <WebClientDir> and copy everything
between the <appSettings> and </appSettings> tags. Open the new web.config
from the new <WebClientDir> and paste the appSettings section from the old into
the new, overwriting the defaults from the new web.config. Alternatively, you can
re-enter the application settings in the new web.config manually, but it is easier to
copy them from the backed up file.
July 2015
Page 30 of 32
7) If you store any custom files in the <WebClientDir>, like image files for recipes, you
will want to copy those from the backup and paste them back into the
<WebClientDir> in the appropriate places.
8) Browse to the Infragistics Scripts folder in the new WebClient build and copy the
Infragistics.zip file.
9) Browse to C:\inetpub\wwwroot\aspnet_client and delete the existing Infragistics

folder
10) Paste the new Infragistics.zip file into the aspnet_client folder and extract the
contents. This should create a new folder named Infragistics.
11) Browse to the MobileWebService.Application folder and copy all of the contents.
12) Browse to C:\inetpub\wwwroot\<MobileWebServiceDir> and paste in all the

contents of the MobileWebService.Application folder.
13) Browse to the MobileWebService.Config directory, copy the new web.config and
paste it into the C:\inetpub\wwwroot\< MobileWebService Dir> directory.
14) Open the web.config from the backup of the < MobileWebServiceDir> and copy
everything between the <appSettings> and </appSettings> tags. Open the new
web.config from the new < MobileWebService Dir> and paste the appSettings
section from the old into the new, overwriting the defaults from the new web.config.
Alternatively, you can re-enter the application settings in the new web.config
manually, but it is easier to copy them from the backed up file.
15) Browse to the MobileWeb.Application folder and copy all the contents.
16) Browse to C:\inetpub\wwwroot\< MobileWeb Dir> folder and paste in all the
contents of the MobileWeb.Application folder.
17) Browse to the mymicrosWebService.Config directory, copy the new web.config and
paste it into the C:\inetpub\wwwroot\<WebServiceDir> directory.
18) Open the web.config from the backup of the < MobileWeb Dir> and copy everything
between the <appSettings> and </appSettings> tags. Open the new web.config
from the new < MobileWeb Dir> and paste the appSettings section from the old into
the new, overwriting the defaults from the new web.config. Alternatively, you can
re-enter the application settings in the new web.config manually, but it is easier to
copy them from the backed up file.
19) Browse to PosWebService.Application folder, then select and copy all the contents.
July 2015
Page 31 of 32
20) Browse to C:\inetpub\wwwroot\<PosWebService> folder, and paste in all files from
the PosWebService.Application folder.
21) Browse to PosWebService.Config directory, copy the new web.config and and
paste it to C:\inetpub\wwwroot\<PosWebServiceDir> directory. Open the
web.config file and configure the “value” for each “key” manually between
<appSettings> and </appSettings> tags.
Post Upgrade
Go to command prompt, type IISRESET and hit <ENTER>. Wait for this to complete.
Your MCweb upgrade is now complete! Now is the time to test everything. Load WebClient
and log in. Also check installed web services. Review logs for any new errors, etc.
July 2015
Page 32 of 32

Oracle Hospitality Materials Control: Deployment

Uploaded by

Copyright:

Available Formats

Oracle Hospitality Materials Control: Deployment

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Oracle Hospitality Materials Control: Deployment

Uploaded by

Copyright:

Available Formats

Oracle Hospitality

For this part, we will use the following files…

This chapter will explain in detail …

 How to install an application client for Materials Control Version 8.30.xx

 How to update an existing application client of Materials Control > Version

 How to update an existing application client of Materials Control < Version

 Handling of customized files like e.g. SQL.INI, FMLOGIN.INI, customized QRP

 How to install AutomationService

These packages will be named like shown below:

Explanation of the naming:

The installation / update process will be started by executing SETUP.EXE.

How to install the new release?

First select your preferred installation language please:

Click “Next” to continue:

Define the required path and click on “OK” to continue:

Click “Next” to continue:

Click “Next” to start the installation process.

After this install the remaining client applications.

Update Client Installation:

After this update the remaining client applications.

Update Client < 8.6.6.10 Installation:

Click “Yes” to proceed or “No” to cancel the install shield.

After this update the remaining client applications.

 Automation Service Console

 Automation Service Job Configuration

Automation Service Console:

 Click button “Next”

 Click button “Next” to start the installation.

 Confirm with “OK”

o Database Server = Oracle Instance

(Please see below for support of multiple databases.)

 Application User ID:

 Profile INI File:

 Adjust the directories as required.

o Template Files Folder:

o Log File Folder:

o Temporary Files Folder:

 Allowed Job Types:

If only one Automation Scheduler installation is in use, please select “None

To add or remove Service Instances, please right-click on tab “Service

o Max. No. of threads:

The number of Jobs the Automation Scheduler should be capable of

 Check Notification parameters:

o If this checkbox is ticked, no notifications will be sent to the users.

 Click the button “Save Configuration”

 The Console will now check the connectivity:

 The Console will now create the configuration file.

 Click OK to close the dialog and finalize this step.

 Close the Automation Console.

 Open the file with any editor:

o At the end of the section </appSettings> a new key must be added

<add key="CustomReportsPath" value="{Path to the RPT folder}" />

This could look like this:

o Save and close the file.

 Re-open the AutomationServiceConsole.exe

 In the Console the current status is shown.

o The service will now try to start

 In the task manager the service can be found as “MICROS.Automation

Step by step instructions: