To install the Developer server, you must have administrator privileges to the computer on which you are installing it, or at least have necessary permissions to install software.
Before you install the Developer server, you need the following information.
Setup Requirements for the Server: The server setup requires the Windows Process Activation Service and WorldWide Web Publishing services to be running. If they are not running, the setup program attempts to start them; if they cannot be started, the installation will be aborted.
Note: The Developer requires a .NET Trust Level setting of Full to function properly. If the allowOverride setting in the web.config is set to false, it will prevent website owners from setting the trust level to a higher level than that set by the server administrator. The web.config is located in C:\Windows\Microsoft.NET\Framework64\v4.0.30319\Config on 64-bit operating systems or C:\Windows\Microsoft.NET\Framework\v4.0.30319\Config on 32-bit operating systems.
Database Access: Two database systems are currently supported, Oracle Database and Microsoft SQL Server. If you choose to install the database at the same time as you install the application files on the server, you are prompted for two sets of credentials for the database. The first set is for an account that the installer can use to create the database. You must use an existing account for this set of credentials, and the account must have permissions to create databases and logins. The second set of credentials is used for the Web Services access for the Developer to read from and write to the database. This can be a pre-existing login, for which you must supply the correct login name and password, or you can specify a new login name and password. The installer grants this account access to the database and adds it to the appropriate roles.
Oracle Database: If you use an Oracle Database, two schema accounts are created during installation: the schema owner and the application user. The schema owner owns all the objects within the schema (tables, views, procedures, and so on), and the application user has access to all those objects, but has limited privileges. The application user is the account that Developer web services uses to connect to the schema. By default, the application user can be created based on the schema owner credentials by appending "_app" to the user name and using the same password, or you can use completely independent credentials.
Note: In an Oracle Database multitenant environment, you must use a pluggable database instance to create the schema and schema objects, and the schema owner and application user accounts created should not be common users.
Microsoft SQL Database: A Microsoft SQL Server may be configured with Windows only or mixed mode authentication.
Note: You cannot convert content from a Microsoft SQL database to an Oracle Database. In the Developer, you can export the content from the Microsoft SQL database, install the Oracle database, and import the content. Be aware that the following data is lost: user accounts, history, state, and owner values.
Authentication Methods: The Developer can authenticate users in three different security modes.
Microsoft Windows: All login authentication to the Developer is done through Microsoft Windows. The system checks the Microsoft Windows account under which the user has logged in to the local computer.
Standard: All login authentication to the Developer is done through accounts stored in the Developer database.
Header based Single Sign-On: All login authentication to the Developer is done through the Single Sign-On server. The system checks the account under which the user has logged into their SSO provider.
This installation (library loader) does not support installing to an environment already configured for SSO. Therefore, when installing SSO authentication for the first time, the Developer library URL (e.g. <server>/ODSContent) must be taken out of protected resources while the server is being installed. The public web service URL (for example <library URL>/Public) should also be configured as an unprotected resource in SSO before installation, so that the library loader can also use its information. Once installation (library loader) finishes, the Developer virtual directory can be protected by SSO. Make sure to configure the <library URL>/Public URL as unprotected even after installation
The Developer server uses the headers from the Single Sign-On Provider to populate user attributes in author profiles.
Note: You must create an author profile in the Developer for each user. Even with a valid SSO account, a user cannot log into the Developer unless an author account has been created for the user.
To use SSO for authentication, the Developer user name must be mapped to a corresponding Header field in the Single Sign-on Provider Mapping screen during the installation process.The Developer author profile fields, such as first name, last name and e-mail address, can also be mapped to Header-based SSO fields. These profile fields can be mapped in the CustomHeaders.xml file, located in <InstallationLocation>\Repository.WCF. You can edit this file as needed after installation is complete. Values coming from mappings (as defined in the CustomHeaders.xml mapping file) will overwrite values the user entered in the Developer for author profile.
The following mapping values can be used in CustomHeaders.xml:
FIRSTNAME
LASTNAME
MINIT
EMAIL
WORKPHONE
MOBILEPHONE
JOBTITLE
DEPARTMENT
For example, if you want to map SSO/LDAP attribute FIRSTNAME, to the First Name field in the Developer author profile, you would add the following to the CustomHeaders.xml, substituting the appropriate SSO header name for "headerName" and the appropriate Developer author profile attribute for the fieldName.
Note: Changing security authentication methods after installation results in technical issues.
Profile Credentials: During server installation, you are prompted to enter credentials for an administrator account for the Developer Library. If you are installing with the Standard authentication method, you must enter a user name and password and confirm the password. If you are installing with the Microsoft Windows authentication method, you can choose to use the Microsoft Windows account of the person installing the server or enter the information for a different Microsoft Windows login account. If using SSO, enter the SSO username.
Optionally, you can enter profile information (First name, Middle initial, Last name, and E-mail address) for the initial administrator.
Secure Web Site and SSL: If a secure web site is available, the installer defaults to that web site. While you can also install on a non-secure web site, using a secure web site and SSL is the recommended method of deployment for the web services, because SSL encrypts authentication data (username and password, session cookies) so it is not transported in clear text across networks; encrypts sensitive data; authenticates that the web server is being accessed by users who are who they say they are; protects data that should be accessed by certain users, and not accessed by others.
Application Pool Identity: Starting with Windows Server 2008 SP2, a new Windows user identity was created for running application pools. These identities are similar to normal Windows user accounts in that they can be assigned folder permissions and so on, but they are only used by the application pool. On these operating systems, the Developer Server application pool, ODDevAppPool4r2, uses an application pool identity IIS AppPool\ODDevAppPool4r2 as the account under which the application pool runs. If using an SQL Server, there is an option to use a different Windows account for the App Pool Identity.
Before you begin the installation, you should decide whether to use the scripts to create the database manually or use the installer software to create the database automatically. If you choose to install the database using the scripts, refer to the Install the Database Manually section. If you choose to install the database and the server separately, you must install the database first.
You must have administrator privileges to the computer or at least have necessary permissions set to install the software.
Install the Server Using an Oracle Database
To install the server with an Oracle database, launch the Setup.exe file located in the root folder in the software installation files. If a Security Warning appears, click Run. You are then prompted to choose the language for the Installer, and the Install Wizard appears. During installation, you proceed through these screens in the Install Wizard.
License Key: Depending on the product you are installing, this screen may appear. If it does, click Browse to navigate to the location of the license key file (usually license.xml).
Welcome: From this screen, you can access the Installation and Upgrade manuals in PDF format.
Setup Type: From the Configuration list, select Developer Server or Developer Server and Client.
Language Selection: Choose the language for the Developer server and library. This sets the default language for the templates and publishing styles in the library.
Software Requirements: Third-party applications are required for installation. If the applications are not present, this screen appears notifying you which applications are needed. You can choose not to continue and abort the installation. If you choose to continue, the applications are installed. If one of them is the .NET framework, the .NET Installer may prompt you to close the Installer. Ignore this warning and do not shut down the Installer.
Microsoft .NET Framework Update: Choose to install Microsoft .NET Framework 4.5. Note that a reboot might be required. This screen only appears if the .NET Framework 4.5 needs to be installed.
Select Program Folder: This screen appears if you selected Server and Client from the Configuration list on the Setup Type screen. You can indicate the desired program folder or accept the default.
Choose Destination Location: You can accept the default target location, or click Change to specify a different one.
Choose Web Site: The Available websites list contains the list of all web sites available to the user, allowing you to choose the most appropriate one. Preference is given to secure web sites. In the Application (virtual directory) name field, you can enter the name you want to use for the virtual directory, or accept the default. You also select the mode to use to authenticate the users, either Windows, Standard, or Header-based Single Sign-On. Later, when you supply the credentials for the initial Profile, you must choose the same authentication mode.
URL Settings: The URL of the web site is determined by the installer and used to populate the initial Developer library. However, what the installer determines and what the actual URL should be may not be the same, so you can modify it as necessary. All DNS and proxy settings should be considered before changing the value. If no changes are needed, or if you are unsure of the settings, the URL should be left as it is currently set.
Web Site Options: This screen appears if there is no secure web site available or if you did not select a secure web site on the Choose Web Site screen. It allows you to ignore the recommendation and continue with the installation, or create a secure web site manually and retry the installation.
Database System: Choose Oracle Database.
Note: The web server and the database server must be in the same local network.
Oracle ODBC Components: The installer requires a 32-bit ODBC driver to be installed to connect to the Oracle Database. If there is no ODBC driver, the installer installs one. This screen does not appear if an ODBC driver already exists. In the Path field, enter the physical location to which you want to install the Oracle ODBC components.
SQL Script Options: The database scripts can be run manually or through the installer. It is also possible to create a schema outside of the installer using administrative privileges, but let the installer create the schema objects with a previously created schema user that has fewer privileges. If you have already run the scripts to create the database, click the Yes, the scripts have already been run for this version option. If you want the installer to create the database, click the No, the scripts have not been run, let the installer run them option. If there is an existing schema (either an empty schema or if performing an upgrade), you can select the “Create or update an existing schema” option, which only runs a set of scripts within the schema, and does not require administrative privileges.
Note: If a server and Developer library have already been installed, for example in a server farm or load balanced environment, the existing up-to-date database and library should be used.
Oracle Database Login: If the scripts have not been run, enter a valid system account name, password, and host string to connect to the Oracle Database server. The account entered in the User Name field must have DBA role privileges to connect to the Oracle Database; the role is required to create or update the tablespace, schema owner, and schema user created for the application.
If the scripts have already been run to create the database, enter the user name, password and host string that has access to the user schema created to run the application. The account in the User Name field must be the name of the application user associated with the schema you created manually with the scripts. If the scripts have already been run, the Profile Credentials screen appears next.
Note: Host String represents the name you assign for TNS connectivity in the tnsnames.ora file. This typically identifies the machine, port number and SID of the Oracle database. If you need to connect to a remote Oracle database you need to supply the host:port/service_name; for example, "myservername:1521/orcl". In some environments a tnsname.ora might not be present. If you are not sure, it is highly recommended that you supply the host/service_name or host:port/service_name (if remote).
Choose Schema: Specify a tablespace name, user name, and password and confirm the password. The user name is limited to 20 characters. The tablespace name is the name of the tablespace that is created or used during the installation; the user name is the user name that is created or associated with the schema. This user is for the Developer application to read and write information to the database. If you want to specify a different Oracle application user, deselect the Create Application User Based on These Credentials option. The Application User screen appears next.
If the Create Application User Based on These Credentials is selected, the application user created based on the entered credentials is the same Login ID with "_app" appended to the end, and it uses the same password. The Profile Credentials screen appears next.
Application User: Specify a user name and password and confirm the password. This screen only appears if you deselected the Create Application User Based on These Credentials option on the previous screen.
Schema Options: This screen only appears if you indicated that the scripts have already been run, or you chose to create or update objects in an existing schema on the SQL Script Options screen. If the scripts have been run, choose the Use existing schema. Update system documents like styles and templates option. The Profile Credentials screen appears next. If you chose to create or update objects in an existing schema, choose the Create the schema objects in the selected schema option. The Application User screen appears next.
Profile Credentials: If you chose to install the server with standard authentication, enter a user name and password for the default admin user, and confirm the password. If you chose to install with Microsoft Windows authentication, allow the system to use the current Microsoft Windows account or specify another valid Microsoft Windows user account and password. If using SSO, provide the SSO username.
Folder permission: The server or server and client installation needs certain permissions to complete the installation. If the installer detects any missing permission(s) it displays this screen, which lists the name of the folder, the user name, and the permission it needs before the installer can continue.
Click Yes, grant permission to the folders to automatically grant the permissions to the folders. If the permissions cannot be applied, this screen reappears. This option is highly recommended. Click No, ignore permission and attempt to continue installation to ignore the permission check and try to continue the installation. If the permissions are not set properly, the installation will fail. Use this option if you know that the permissions are already applied. Click Retry to recheck the folders without applying any permissions. The permissions must be applied manually.
Ready to Install: The Installation Wizard is ready to install the software. Click Back to review or modify any settings.
Setup Status: This screen appears while the files are being installed, the schema and virtual directory are being created, and IIS is being configured.
InstallShield Wizard Complete: During the installation a file might be in use by the operating system on the computer; this will require a reboot to complete the installation. Also, make sure to run Windows update to get the latest patches from Microsoft.
Install the Server Using a Microsoft SQL Server
To install the server with a Microsoft SQL Server, launch the Setup.exe file located in the root folder in the software installation files. If a Security Warning appears, click Run. You are then prompted to choose the language for the Installer, and the Install Wizard appears. During installation, you proceed through these screens in the Install Wizard.
License Key: Depending on the product you are installing, this screen may appear. If it does, click Browse to navigate to the location of the license key file (usually license.xml).
Welcome: From this screen, you can access the Installation and Upgrade manuals in PDF format.
Setup Type: From the Configuration list, select Server or Server and Client.
Language Selection: Choose the language for the Developer server and library. This sets the default language for the templates and publishing styles in the library.
Software Requirements: Third-party applications are required for installation. If the applications are not present, this screen appears notifying you which applications are needed. You can choose not to continue and abort the installation. If you choose to continue, the applications are installed. If one of them is the .NET framework, the .NET Installer may prompt you to close the Installer. Ignore this warning and do not shut down the Installer.
Microsoft .NET Framework Update: Choose to install Microsoft .NET Framework 4.5. Note that a reboot might be required. This screen only appears if the .NET Framework 4.5 needs to be installed.
Select Program Folder: This screen appears if you selected Server and Client from the Configuration list on the Setup Type screen. You can indicate the desired program folder or accept the default.
Choose Destination Location: You can accept the default target location, or click Change to specify a different one.
Choose Web Site: The Available websites list contains the list of all web sites available to the user, allowing you to choose the most appropriate one. Preference is given to secure web sites. In the Application (virtual directory) name box, you can enter the name you want to use for the virtual directory, or accept the default. You also select the mode to use to authenticate the users, either Windows, Standard, or Header-based Single Sign-On. Later, when you supply the credentials for the initial Profile, you must choose the same authentication mode.
URL Settings: This URL was determined from earlier settings. It allows you to confirm or change the URL for the web site or to change it, if necessary.
Web Site Options: This screen appears if there is no secure web site available or if you did not select a secure web site on the Choose Web Site screen. It allows you to ignore the recommendation and continue with the installation, or create a secure web site manually and retry the installation.
Database System: Choose Microsoft SQL Server.
Note: The web server and the database server must be in the same local network.
SQL Script Options: If you have already run the scripts to create the database, click the Yes, the scripts have already been run for this version option. If you want the installer to create the database, click the No, the scripts have not been run, let the installer run them option.
Note: If a server and Developer library have already been installed, for example in a server farm or load balanced environment, the existing up-to-date database and library should be used.
Microsoft SQL Server Login: From the Database server list, select the desired Microsoft SQL Server. If the scripts have not been run, select Windows Authentication or SQL Server Authentication to connect to the database. If you select Microsoft SQL Server authentication, enter an existing login name and password that has database administrator access to the server.
Choose Database: Accept the default name for the database or enter a custom name. If you have already run the scripts, you must use the name of the database you created.
SQL server authentication recognizes a Windows only or mixed mode server authentication. Under Authentication, select Windows Authentication or SQL Server Authentication. For SQL server authentication, specify an existing database user ID and password and confirm the password, if necessary, or, if you have not run the scripts, you can also specify a new database user ID and password. The installer creates the login, if necessary, grants the login access to the database, and gives it the appropriate permissions. If you ran the scripts to create the database, you must use the login you created.
Application Pool Identity: This screen appears if you selected Windows Authentication and an Application Pool Identity does not exist. You can choose to have the installation create a standard application pool identity and connect the database to the identity, or create a new Windows account or specify an existing Windows account to connect to the SQL database. The Windows account used (either the standard application pool identity, or the Windows user account) will be granted access to the database.
Database Options: This screen appears if you indicated that the scripts had been run to create the database. Choose the Use existing database. Update system documents like styles and templates option. The Profile Credentials screen appears next.
Profile Credentials: If you chose to install the server with standard authentication, enter a user name and password for the default admin user, and confirm the password. If you chose to install with Microsoft Windows authentication, allow the system to use the current Microsoft Windows account or specify another valid Microsoft WindowAdminiss user account and password. If using SSO, provide the SSO username.
Folder permission: The server or server and client installation needs certain permissions to complete the installation. If the installer detects any missing permission(s) it displays this screen, which lists the name of the folder, the user name, and the permission it needs before the installer can continue.
Click Yes, grant permission to the folders to automatically grant the permissions to the folders. If the permissions cannot be applied, this screen reappears. This option is highly recommended. Click No, ignore permission and attempt to continue installation to ignore the permission check and try to continue the installation. If the permissions are not set properly, the installation will fail. Use this option if you know that the permissions are already applied. Click Retry to recheck the folders without applying any permissions. The permissions must be applied manually.
Ready to Install: The Installation Wizard is ready to install the software. Click Back to review or modify any settings.
Setup Status: This screen appears while the files are being installed, the database and virtual directory are being created, and IIS is being configured.
InstallShield Wizard Complete: During the installation a file might be in use by the operating system on the computer; this will require a reboot to complete the installation. Also, make sure to run Windows update to get the latest patches from Microsoft.